@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
|
@@ -24,7 +24,7 @@ class Serviceability {
|
|
|
24
24
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneBulkExport>} - Success response
|
|
25
25
|
* @name createBulkExport
|
|
26
26
|
* @summary: Create Bulk Export of Zones
|
|
27
|
-
* @description: Export zones defined at the application level. - Check out [method documentation](https://
|
|
27
|
+
* @description: Export zones defined at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createBulkExport/).
|
|
28
28
|
*/
|
|
29
29
|
async createBulkExport(
|
|
30
30
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -106,7 +106,7 @@ class Serviceability {
|
|
|
106
106
|
* Success response
|
|
107
107
|
* @name createBulkGeoArea
|
|
108
108
|
* @summary: Bulk Creation of GeoArea Regions
|
|
109
|
-
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions in bulk. - Check out [method documentation](https://
|
|
109
|
+
* @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/).
|
|
110
110
|
*/
|
|
111
111
|
async createBulkGeoArea(
|
|
112
112
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -189,7 +189,7 @@ class Serviceability {
|
|
|
189
189
|
*
|
|
190
190
|
* @name createCourierPartnerRule
|
|
191
191
|
* @summary: Create courier rule
|
|
192
|
-
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://
|
|
192
|
+
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
193
193
|
*/
|
|
194
194
|
async createCourierPartnerRule(
|
|
195
195
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -271,7 +271,7 @@ class Serviceability {
|
|
|
271
271
|
* Success response
|
|
272
272
|
* @name createGeoArea
|
|
273
273
|
* @summary: Creation of GeoArea
|
|
274
|
-
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://
|
|
274
|
+
* @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/).
|
|
275
275
|
*/
|
|
276
276
|
async createGeoArea(
|
|
277
277
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -354,7 +354,7 @@ class Serviceability {
|
|
|
354
354
|
*
|
|
355
355
|
* @name createGeoAreaExportJob
|
|
356
356
|
* @summary: Create job for exporting Geoarea regions
|
|
357
|
-
* @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://
|
|
357
|
+
* @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/).
|
|
358
358
|
*/
|
|
359
359
|
async createGeoAreaExportJob(
|
|
360
360
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -436,7 +436,7 @@ class Serviceability {
|
|
|
436
436
|
* Success response
|
|
437
437
|
* @name createStoreRules
|
|
438
438
|
* @summary: Create store rule
|
|
439
|
-
* @description: Create a rule within the order routing rules - Check out [method documentation](https://
|
|
439
|
+
* @description: Create a rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createStoreRules/).
|
|
440
440
|
*/
|
|
441
441
|
async createStoreRules(
|
|
442
442
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -517,7 +517,7 @@ class Serviceability {
|
|
|
517
517
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneSchema>} - Success response
|
|
518
518
|
* @name createZone
|
|
519
519
|
* @summary: Create zone
|
|
520
|
-
* @description: Creates a delivery zone. - Check out [method documentation](https://
|
|
520
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZone/).
|
|
521
521
|
*/
|
|
522
522
|
async createZone(
|
|
523
523
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -600,7 +600,7 @@ class Serviceability {
|
|
|
600
600
|
*
|
|
601
601
|
* @name deleteZone
|
|
602
602
|
* @summary: Delete a Specific Zone
|
|
603
|
-
* @description: Delete a Zone under that application. - Check out [method documentation](https://
|
|
603
|
+
* @description: Delete a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteZone/).
|
|
604
604
|
*/
|
|
605
605
|
async deleteZone(
|
|
606
606
|
{ zoneId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -681,7 +681,7 @@ class Serviceability {
|
|
|
681
681
|
* @returns {Promise<string>} - Success response
|
|
682
682
|
* @name downloadGeoareaSampleFile
|
|
683
683
|
* @summary: Download geoarea sample file
|
|
684
|
-
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://
|
|
684
|
+
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadGeoareaSampleFile/).
|
|
685
685
|
*/
|
|
686
686
|
async downloadGeoareaSampleFile(
|
|
687
687
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -756,7 +756,7 @@ class Serviceability {
|
|
|
756
756
|
* Success response
|
|
757
757
|
* @name getApplicationConfig
|
|
758
758
|
* @summary: Get store rule configuration
|
|
759
|
-
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://
|
|
759
|
+
* @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/).
|
|
760
760
|
*/
|
|
761
761
|
async getApplicationConfig(
|
|
762
762
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -835,7 +835,7 @@ class Serviceability {
|
|
|
835
835
|
*
|
|
836
836
|
* @name getApplicationConfiguration
|
|
837
837
|
* @summary: Get delivery configuration
|
|
838
|
-
* @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://
|
|
838
|
+
* @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/).
|
|
839
839
|
*/
|
|
840
840
|
async getApplicationConfiguration(
|
|
841
841
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -913,7 +913,7 @@ class Serviceability {
|
|
|
913
913
|
* Success response
|
|
914
914
|
* @name getBulkExport
|
|
915
915
|
* @summary: Get Bulk Export of Zones
|
|
916
|
-
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://
|
|
916
|
+
* @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/).
|
|
917
917
|
*/
|
|
918
918
|
async getBulkExport(
|
|
919
919
|
{ batchId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -995,7 +995,7 @@ class Serviceability {
|
|
|
995
995
|
* Success response
|
|
996
996
|
* @name getBulkGeoArea
|
|
997
997
|
* @summary: Get status of GeoAreas created in bulk
|
|
998
|
-
* @description: Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk. - Check out [method documentation](https://
|
|
998
|
+
* @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/).
|
|
999
999
|
*/
|
|
1000
1000
|
async getBulkGeoArea(
|
|
1001
1001
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1078,7 +1078,7 @@ class Serviceability {
|
|
|
1078
1078
|
*
|
|
1079
1079
|
* @name getCourierPartnerRule
|
|
1080
1080
|
* @summary: Get courier rule
|
|
1081
|
-
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://
|
|
1081
|
+
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
1082
1082
|
*/
|
|
1083
1083
|
async getCourierPartnerRule(
|
|
1084
1084
|
{ ruleUid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1161,7 +1161,7 @@ class Serviceability {
|
|
|
1161
1161
|
*
|
|
1162
1162
|
* @name getCourierPartnerRules
|
|
1163
1163
|
* @summary: Get courier rules
|
|
1164
|
-
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://
|
|
1164
|
+
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRules/).
|
|
1165
1165
|
*/
|
|
1166
1166
|
async getCourierPartnerRules(
|
|
1167
1167
|
{ pageNo, pageSize, status, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1251,7 +1251,7 @@ class Serviceability {
|
|
|
1251
1251
|
*
|
|
1252
1252
|
* @name getCourierPartners
|
|
1253
1253
|
* @summary: Serviceable Courier Partners
|
|
1254
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://
|
|
1254
|
+
* @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/).
|
|
1255
1255
|
*/
|
|
1256
1256
|
async getCourierPartners(
|
|
1257
1257
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1332,7 +1332,7 @@ class Serviceability {
|
|
|
1332
1332
|
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaDetails>} - Success response
|
|
1333
1333
|
* @name getGeoArea
|
|
1334
1334
|
* @summary: Get details of the specific geoarea
|
|
1335
|
-
* @description: This API Returns the data of the specific GeoArea which exists on the platform. - Check out [method documentation](https://
|
|
1335
|
+
* @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/).
|
|
1336
1336
|
*/
|
|
1337
1337
|
async getGeoArea(
|
|
1338
1338
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1415,7 +1415,7 @@ class Serviceability {
|
|
|
1415
1415
|
*
|
|
1416
1416
|
* @name getGeoAreaExportJobStatus
|
|
1417
1417
|
* @summary: Get status of Geoarea export job
|
|
1418
|
-
* @description: Get the status and details of the Geoarea bulk export process. - Check out [method documentation](https://
|
|
1418
|
+
* @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/).
|
|
1419
1419
|
*/
|
|
1420
1420
|
async getGeoAreaExportJobStatus(
|
|
1421
1421
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1497,7 +1497,7 @@ class Serviceability {
|
|
|
1497
1497
|
* Success response
|
|
1498
1498
|
* @name getGeoAreas
|
|
1499
1499
|
* @summary: Get all geoareas in the current application
|
|
1500
|
-
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://
|
|
1500
|
+
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreas/).
|
|
1501
1501
|
*/
|
|
1502
1502
|
async getGeoAreas(
|
|
1503
1503
|
{
|
|
@@ -1619,7 +1619,7 @@ class Serviceability {
|
|
|
1619
1619
|
* Success response
|
|
1620
1620
|
* @name getStoreRule
|
|
1621
1621
|
* @summary: Get store rule
|
|
1622
|
-
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://
|
|
1622
|
+
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getStoreRule/).
|
|
1623
1623
|
*/
|
|
1624
1624
|
async getStoreRule(
|
|
1625
1625
|
{ ruleUid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1701,7 +1701,7 @@ class Serviceability {
|
|
|
1701
1701
|
* Success response
|
|
1702
1702
|
* @name getStoreRules
|
|
1703
1703
|
* @summary: Get store rules
|
|
1704
|
-
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://
|
|
1704
|
+
* @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/).
|
|
1705
1705
|
*/
|
|
1706
1706
|
async getStoreRules(
|
|
1707
1707
|
{ pageNo, pageSize, status, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1788,7 +1788,7 @@ class Serviceability {
|
|
|
1788
1788
|
* Success response
|
|
1789
1789
|
* @name getZone
|
|
1790
1790
|
* @summary: Get zone details
|
|
1791
|
-
* @description: Retrieves a single delivery zone - Check out [method documentation](https://
|
|
1791
|
+
* @description: Retrieves a single delivery zone - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZone/).
|
|
1792
1792
|
*/
|
|
1793
1793
|
async getZone(
|
|
1794
1794
|
{ zoneId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1867,7 +1867,7 @@ class Serviceability {
|
|
|
1867
1867
|
* @returns {Promise<ServiceabilityPlatformModel.ListViewSchema>} - Success response
|
|
1868
1868
|
* @name getZones
|
|
1869
1869
|
* @summary: Get zones
|
|
1870
|
-
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://
|
|
1870
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZones/).
|
|
1871
1871
|
*/
|
|
1872
1872
|
async getZones(
|
|
1873
1873
|
{
|
|
@@ -1989,7 +1989,7 @@ class Serviceability {
|
|
|
1989
1989
|
* Success response
|
|
1990
1990
|
* @name insertApplicationConfig
|
|
1991
1991
|
* @summary: Create store rule configuration
|
|
1992
|
-
* @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://
|
|
1992
|
+
* @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/).
|
|
1993
1993
|
*/
|
|
1994
1994
|
async insertApplicationConfig(
|
|
1995
1995
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2072,7 +2072,7 @@ class Serviceability {
|
|
|
2072
2072
|
*
|
|
2073
2073
|
* @name patchApplicationConfiguration
|
|
2074
2074
|
* @summary: To patch any config which can be applied to application
|
|
2075
|
-
* @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://
|
|
2075
|
+
* @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/).
|
|
2076
2076
|
*/
|
|
2077
2077
|
async patchApplicationConfiguration(
|
|
2078
2078
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2154,7 +2154,7 @@ class Serviceability {
|
|
|
2154
2154
|
* Success response
|
|
2155
2155
|
* @name updateApplicationConfiguration
|
|
2156
2156
|
* @summary: Apply configuration to an application
|
|
2157
|
-
* @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://
|
|
2157
|
+
* @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/).
|
|
2158
2158
|
*/
|
|
2159
2159
|
async updateApplicationConfiguration(
|
|
2160
2160
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2236,7 +2236,7 @@ class Serviceability {
|
|
|
2236
2236
|
* Success response
|
|
2237
2237
|
* @name updateBulkGeoArea
|
|
2238
2238
|
* @summary: Update geoareas and their associated regions in bulk
|
|
2239
|
-
* @description: Update geoarea details and their associated regions through a CSV file in bulk. - Check out [method documentation](https://
|
|
2239
|
+
* @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/).
|
|
2240
2240
|
*/
|
|
2241
2241
|
async updateBulkGeoArea(
|
|
2242
2242
|
{ geoareaId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2320,7 +2320,7 @@ class Serviceability {
|
|
|
2320
2320
|
* Success response
|
|
2321
2321
|
* @name updateCourierPartnerRulePriority
|
|
2322
2322
|
* @summary: Update courier partner rule priority
|
|
2323
|
-
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://
|
|
2323
|
+
* @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/).
|
|
2324
2324
|
*/
|
|
2325
2325
|
async updateCourierPartnerRulePriority(
|
|
2326
2326
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2403,7 +2403,7 @@ class Serviceability {
|
|
|
2403
2403
|
*
|
|
2404
2404
|
* @name updateCourierRule
|
|
2405
2405
|
* @summary: Update courier rule
|
|
2406
|
-
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://
|
|
2406
|
+
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierRule/).
|
|
2407
2407
|
*/
|
|
2408
2408
|
async updateCourierRule(
|
|
2409
2409
|
{ ruleUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2487,7 +2487,7 @@ class Serviceability {
|
|
|
2487
2487
|
* Success response
|
|
2488
2488
|
* @name updateGeoArea
|
|
2489
2489
|
* @summary: Update the details of existing GeoArea
|
|
2490
|
-
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://
|
|
2490
|
+
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateGeoArea/).
|
|
2491
2491
|
*/
|
|
2492
2492
|
async updateGeoArea(
|
|
2493
2493
|
{ geoareaId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2574,7 +2574,7 @@ class Serviceability {
|
|
|
2574
2574
|
*
|
|
2575
2575
|
* @name updatePincodeAuditHistory
|
|
2576
2576
|
* @summary: Get audit trail
|
|
2577
|
-
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://
|
|
2577
|
+
* @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/).
|
|
2578
2578
|
*/
|
|
2579
2579
|
async updatePincodeAuditHistory(
|
|
2580
2580
|
{ body, pageNumber, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2662,7 +2662,7 @@ class Serviceability {
|
|
|
2662
2662
|
* Success response
|
|
2663
2663
|
* @name updatePincodeBulkView
|
|
2664
2664
|
* @summary: Bulk update pincode COD support
|
|
2665
|
-
* @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://
|
|
2665
|
+
* @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/).
|
|
2666
2666
|
*/
|
|
2667
2667
|
async updatePincodeBulkView(
|
|
2668
2668
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2745,7 +2745,7 @@ class Serviceability {
|
|
|
2745
2745
|
*
|
|
2746
2746
|
* @name updatePincodeCoDListing
|
|
2747
2747
|
* @summary: Get COD enabled pincodes
|
|
2748
|
-
* @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://
|
|
2748
|
+
* @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/).
|
|
2749
2749
|
*/
|
|
2750
2750
|
async updatePincodeCoDListing(
|
|
2751
2751
|
{ body, pageNumber, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2832,7 +2832,7 @@ class Serviceability {
|
|
|
2832
2832
|
* @returns {Promise<ServiceabilityPlatformModel.PincodeMOPResult>} - Success response
|
|
2833
2833
|
* @name updatePincodeMopView
|
|
2834
2834
|
* @summary: Update pincode COD support
|
|
2835
|
-
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://
|
|
2835
|
+
* @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/).
|
|
2836
2836
|
*/
|
|
2837
2837
|
async updatePincodeMopView(
|
|
2838
2838
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2914,7 +2914,7 @@ class Serviceability {
|
|
|
2914
2914
|
* Success response
|
|
2915
2915
|
* @name updateStoreRulePriority
|
|
2916
2916
|
* @summary: Update Store Rule priority
|
|
2917
|
-
* @description: Update Store Rule priority - Check out [method documentation](https://
|
|
2917
|
+
* @description: Update Store Rule priority - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulePriority/).
|
|
2918
2918
|
*/
|
|
2919
2919
|
async updateStoreRulePriority(
|
|
2920
2920
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2997,7 +2997,7 @@ class Serviceability {
|
|
|
2997
2997
|
*
|
|
2998
2998
|
* @name updateStoreRules
|
|
2999
2999
|
* @summary: Update store rule
|
|
3000
|
-
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://
|
|
3000
|
+
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRules/).
|
|
3001
3001
|
*/
|
|
3002
3002
|
async updateStoreRules(
|
|
3003
3003
|
{ ruleUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3081,7 +3081,7 @@ class Serviceability {
|
|
|
3081
3081
|
* Success response
|
|
3082
3082
|
* @name updateStoreRulesConfig
|
|
3083
3083
|
* @summary: Update store rules configuration
|
|
3084
|
-
* @description: Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://
|
|
3084
|
+
* @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/).
|
|
3085
3085
|
*/
|
|
3086
3086
|
async updateStoreRulesConfig(
|
|
3087
3087
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3164,7 +3164,7 @@ class Serviceability {
|
|
|
3164
3164
|
*
|
|
3165
3165
|
* @name updateZone
|
|
3166
3166
|
* @summary: Update details of a Zone to enable or disable
|
|
3167
|
-
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://
|
|
3167
|
+
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateZone/).
|
|
3168
3168
|
*/
|
|
3169
3169
|
async updateZone(
|
|
3170
3170
|
{ zoneId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -11,7 +11,7 @@ declare class Serviceability {
|
|
|
11
11
|
*
|
|
12
12
|
* @name bulkServiceability
|
|
13
13
|
* @summary: Bulk update serviceability of localities
|
|
14
|
-
* @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://
|
|
14
|
+
* @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/bulkServiceability/).
|
|
15
15
|
*/
|
|
16
16
|
bulkServiceability({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResultItemData>;
|
|
17
17
|
/**
|
|
@@ -24,7 +24,7 @@ declare class Serviceability {
|
|
|
24
24
|
* @name bulkTat
|
|
25
25
|
* @summary: Locality TAT import or export
|
|
26
26
|
* @description: Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
|
|
27
|
-
* Export locality wise CSV files. - Check out [method documentation](https://
|
|
27
|
+
* Export locality wise CSV files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/bulkTat/).
|
|
28
28
|
*/
|
|
29
29
|
bulkTat({ extensionId, schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.BulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResultItemData>;
|
|
30
30
|
/**
|
|
@@ -38,7 +38,7 @@ declare class Serviceability {
|
|
|
38
38
|
*
|
|
39
39
|
* @name createCourierPartnerAccount
|
|
40
40
|
* @summary: Create courier account
|
|
41
|
-
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://
|
|
41
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
42
42
|
*/
|
|
43
43
|
createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountDetailsBody>;
|
|
44
44
|
/**
|
|
@@ -52,7 +52,7 @@ declare class Serviceability {
|
|
|
52
52
|
*
|
|
53
53
|
* @name createCourierPartnerScheme
|
|
54
54
|
* @summary: Create Scheme for courier partner extension
|
|
55
|
-
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://
|
|
55
|
+
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerScheme/).
|
|
56
56
|
*/
|
|
57
57
|
createCourierPartnerScheme({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>;
|
|
58
58
|
/**
|
|
@@ -65,7 +65,7 @@ declare class Serviceability {
|
|
|
65
65
|
* Success response
|
|
66
66
|
* @name createPackageMaterial
|
|
67
67
|
* @summary: Create packaging material
|
|
68
|
-
* @description: Creates a packaging material - Check out [method documentation](https://
|
|
68
|
+
* @description: Creates a packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterial/).
|
|
69
69
|
*/
|
|
70
70
|
createPackageMaterial({ body, pageNo, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResult>;
|
|
71
71
|
/**
|
|
@@ -78,7 +78,7 @@ declare class Serviceability {
|
|
|
78
78
|
* Success response
|
|
79
79
|
* @name createPackageMaterialRule
|
|
80
80
|
* @summary: Create packaging rule
|
|
81
|
-
* @description: Creates a packaging rule - Check out [method documentation](https://
|
|
81
|
+
* @description: Creates a packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
82
82
|
*/
|
|
83
83
|
createPackageMaterialRule({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResult>;
|
|
84
84
|
/**
|
|
@@ -90,7 +90,7 @@ declare class Serviceability {
|
|
|
90
90
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
91
91
|
* @name getBulkServiceability
|
|
92
92
|
* @summary: Bulk update history
|
|
93
|
-
* @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://
|
|
93
|
+
* @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkServiceability/).
|
|
94
94
|
*/
|
|
95
95
|
getBulkServiceability({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResult>;
|
|
96
96
|
/**
|
|
@@ -100,7 +100,7 @@ declare class Serviceability {
|
|
|
100
100
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
101
101
|
* @name getBulkTat
|
|
102
102
|
* @summary: Locality TAT change history
|
|
103
|
-
* @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://
|
|
103
|
+
* @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkTat/).
|
|
104
104
|
*/
|
|
105
105
|
getBulkTat({ extensionId, schemeId, pageNo, pageSize, batchId, action, status, country, region, startDate, endDate, requestHeaders, }?: ServiceabilityPlatformValidator.GetBulkTatParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionResult>;
|
|
106
106
|
/**
|
|
@@ -112,7 +112,7 @@ declare class Serviceability {
|
|
|
112
112
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
113
113
|
* @name getCompanyConfiguration
|
|
114
114
|
* @summary: Get delivery configuration
|
|
115
|
-
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://
|
|
115
|
+
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
116
116
|
*/
|
|
117
117
|
getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
118
118
|
/**
|
|
@@ -122,7 +122,7 @@ declare class Serviceability {
|
|
|
122
122
|
* @returns {Promise<ServiceabilityPlatformModel.GetCountries>} - Success response
|
|
123
123
|
* @name getCountries
|
|
124
124
|
* @summary: Get all countries and associated data
|
|
125
|
-
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://
|
|
125
|
+
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCountries/).
|
|
126
126
|
*/
|
|
127
127
|
getCountries({ onboard, pageNo, pageSize, q, hierarchy, requestHeaders }?: ServiceabilityPlatformValidator.GetCountriesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetCountries>;
|
|
128
128
|
/**
|
|
@@ -135,7 +135,7 @@ declare class Serviceability {
|
|
|
135
135
|
* Success response
|
|
136
136
|
* @name getCourierPartnerAccount
|
|
137
137
|
* @summary: Get courier account
|
|
138
|
-
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://
|
|
138
|
+
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
139
139
|
*/
|
|
140
140
|
getCourierPartnerAccount({ accountId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResult>;
|
|
141
141
|
/**
|
|
@@ -149,7 +149,7 @@ declare class Serviceability {
|
|
|
149
149
|
*
|
|
150
150
|
* @name getCourierPartnerAccounts
|
|
151
151
|
* @summary: List courier accounts
|
|
152
|
-
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://
|
|
152
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
153
153
|
*/
|
|
154
154
|
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, accountIds, selfShip, ownAccount, q, requestHeaders, }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResult>;
|
|
155
155
|
/**
|
|
@@ -163,7 +163,7 @@ declare class Serviceability {
|
|
|
163
163
|
*
|
|
164
164
|
* @name getCourierPartnerScheme
|
|
165
165
|
* @summary: Get Scheme for courier partner extension by Id
|
|
166
|
-
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://
|
|
166
|
+
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerScheme/).
|
|
167
167
|
*/
|
|
168
168
|
getCourierPartnerScheme({ schemeId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>;
|
|
169
169
|
/**
|
|
@@ -177,7 +177,7 @@ declare class Serviceability {
|
|
|
177
177
|
*
|
|
178
178
|
* @name getCourierPartnerSchemes
|
|
179
179
|
* @summary: Get created Schemes for courier partner
|
|
180
|
-
* @description: Get created Schemes for courier partner - Check out [method documentation](https://
|
|
180
|
+
* @description: Get created Schemes for courier partner - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerSchemes/).
|
|
181
181
|
*/
|
|
182
182
|
getCourierPartnerSchemes({ schemeType, paymentMode, capabilities, schemeIds, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeList>;
|
|
183
183
|
/**
|
|
@@ -191,7 +191,7 @@ declare class Serviceability {
|
|
|
191
191
|
*
|
|
192
192
|
* @name getInstalledCourierPartnerExtensions
|
|
193
193
|
* @summary: Fetching of Package Material Rules from database.
|
|
194
|
-
* @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://
|
|
194
|
+
* @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
|
|
195
195
|
*/
|
|
196
196
|
getInstalledCourierPartnerExtensions({ pageNo, pageSize, isInstalled, requestHeaders }?: ServiceabilityPlatformValidator.GetInstalledCourierPartnerExtensionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.InstallCourierPartnerResponseSchema>;
|
|
197
197
|
/**
|
|
@@ -202,7 +202,7 @@ declare class Serviceability {
|
|
|
202
202
|
* Success response
|
|
203
203
|
* @name getOptimalLocations
|
|
204
204
|
* @summary: Get selling locations
|
|
205
|
-
* @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://
|
|
205
|
+
* @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getOptimalLocations/).
|
|
206
206
|
*/
|
|
207
207
|
getOptimalLocations({ body, requestHeaders }?: ServiceabilityPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OptimalLocationsResult>;
|
|
208
208
|
/**
|
|
@@ -215,7 +215,7 @@ declare class Serviceability {
|
|
|
215
215
|
* Success response
|
|
216
216
|
* @name getPackageMaterialList
|
|
217
217
|
* @summary: Get packaging materials
|
|
218
|
-
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://
|
|
218
|
+
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialList/).
|
|
219
219
|
*/
|
|
220
220
|
getPackageMaterialList({ pageNo, pageSize, q, size, packageType, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackagesListResult>;
|
|
221
221
|
/**
|
|
@@ -228,7 +228,7 @@ declare class Serviceability {
|
|
|
228
228
|
* Success response
|
|
229
229
|
* @name getPackageMaterialRule
|
|
230
230
|
* @summary: Get packaging material rule
|
|
231
|
-
* @description: Retrieve packaging rule details. - Check out [method documentation](https://
|
|
231
|
+
* @description: Retrieve packaging rule details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
232
232
|
*/
|
|
233
233
|
getPackageMaterialRule({ ruleId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResult>;
|
|
234
234
|
/**
|
|
@@ -238,7 +238,7 @@ declare class Serviceability {
|
|
|
238
238
|
* @returns {Promise<ServiceabilityPlatformModel.PackageItem>} - Success response
|
|
239
239
|
* @name getPackageMaterials
|
|
240
240
|
* @summary: Get packaging material
|
|
241
|
-
* @description: Retrieve a single packaging material - Check out [method documentation](https://
|
|
241
|
+
* @description: Retrieve a single packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterials/).
|
|
242
242
|
*/
|
|
243
243
|
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageItem>;
|
|
244
244
|
/**
|
|
@@ -252,7 +252,7 @@ declare class Serviceability {
|
|
|
252
252
|
*
|
|
253
253
|
* @name getSampleFileServiceabilityStatus
|
|
254
254
|
* @summary: Get Serviceability TAT sample files generator status
|
|
255
|
-
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://
|
|
255
|
+
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getSampleFileServiceabilityStatus/).
|
|
256
256
|
*/
|
|
257
257
|
getSampleFileServiceabilityStatus({ pageNo, pageSize, batchId, requestHeaders }?: ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResult>;
|
|
258
258
|
/**
|
|
@@ -262,7 +262,7 @@ declare class Serviceability {
|
|
|
262
262
|
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
263
263
|
* @name getSelfShipDetails
|
|
264
264
|
* @summary: Get self-ship details
|
|
265
|
-
* @description: Get the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://
|
|
265
|
+
* @description: Get the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getSelfShipDetails/).
|
|
266
266
|
*/
|
|
267
267
|
getSelfShipDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.SelfshipSchema>;
|
|
268
268
|
/**
|
|
@@ -276,7 +276,7 @@ declare class Serviceability {
|
|
|
276
276
|
*
|
|
277
277
|
* @name sampleFileServiceability
|
|
278
278
|
* @summary: Sample File Download
|
|
279
|
-
* @description: Sample File Download - Check out [method documentation](https://
|
|
279
|
+
* @description: Sample File Download - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/sampleFileServiceability/).
|
|
280
280
|
*/
|
|
281
281
|
sampleFileServiceability({ body, requestHeaders }?: ServiceabilityPlatformValidator.SampleFileServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResultItemData>;
|
|
282
282
|
/**
|
|
@@ -288,7 +288,7 @@ declare class Serviceability {
|
|
|
288
288
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
289
289
|
* @name updateCompanyConfiguration
|
|
290
290
|
* @summary: Update delivery configuration
|
|
291
|
-
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://
|
|
291
|
+
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCompanyConfiguration/).
|
|
292
292
|
*/
|
|
293
293
|
updateCompanyConfiguration({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
294
294
|
/**
|
|
@@ -302,7 +302,7 @@ declare class Serviceability {
|
|
|
302
302
|
*
|
|
303
303
|
* @name updateCourierPartnerAccount
|
|
304
304
|
* @summary: Update courier account
|
|
305
|
-
* @description: Updates an existing courier partner account. - Check out [method documentation](https://
|
|
305
|
+
* @description: Updates an existing courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
306
306
|
*/
|
|
307
307
|
updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountDetailsBody>;
|
|
308
308
|
/**
|
|
@@ -316,7 +316,7 @@ declare class Serviceability {
|
|
|
316
316
|
*
|
|
317
317
|
* @name updateCourierPartnerScheme
|
|
318
318
|
* @summary: Update Scheme for courier partner extension
|
|
319
|
-
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://
|
|
319
|
+
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerScheme/).
|
|
320
320
|
*/
|
|
321
321
|
updateCourierPartnerScheme({ schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerSchemeModelSchema>;
|
|
322
322
|
/**
|
|
@@ -329,7 +329,7 @@ declare class Serviceability {
|
|
|
329
329
|
* Success response
|
|
330
330
|
* @name updatePackageMaterialRule
|
|
331
331
|
* @summary: Update packaging rule
|
|
332
|
-
* @description: Update an existing packaging rule - Check out [method documentation](https://
|
|
332
|
+
* @description: Update an existing packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterialRule/).
|
|
333
333
|
*/
|
|
334
334
|
updatePackageMaterialRule({ ruleId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageRuleResult>;
|
|
335
335
|
/**
|
|
@@ -342,7 +342,7 @@ declare class Serviceability {
|
|
|
342
342
|
* Success response
|
|
343
343
|
* @name updatePackageMaterials
|
|
344
344
|
* @summary: Update packaging material
|
|
345
|
-
* @description: Update an existing packaging material - Check out [method documentation](https://
|
|
345
|
+
* @description: Update an existing packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterials/).
|
|
346
346
|
*/
|
|
347
347
|
updatePackageMaterials({ packageMaterialId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdatePackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResult>;
|
|
348
348
|
/**
|
|
@@ -354,7 +354,7 @@ declare class Serviceability {
|
|
|
354
354
|
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
355
355
|
* @name updateSelfShipDetails
|
|
356
356
|
* @summary: Update self-ship details
|
|
357
|
-
* @description: Updates the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://
|
|
357
|
+
* @description: Updates the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateSelfShipDetails/).
|
|
358
358
|
*/
|
|
359
359
|
updateSelfShipDetails({ body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateSelfShipDetailsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.SelfshipSchema>;
|
|
360
360
|
}
|