@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
|
@@ -23,7 +23,7 @@ class Serviceability {
|
|
|
23
23
|
*
|
|
24
24
|
* @name bulkServiceability
|
|
25
25
|
* @summary: Bulk update serviceability of localities
|
|
26
|
-
* @description: Bulk operations involve either new serviceability settings or updating existing ones in large quantities. - Check out [method documentation](https://
|
|
26
|
+
* @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/).
|
|
27
27
|
*/
|
|
28
28
|
async bulkServiceability(
|
|
29
29
|
{ extensionId, schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -111,7 +111,7 @@ class Serviceability {
|
|
|
111
111
|
* @name bulkTat
|
|
112
112
|
* @summary: Locality TAT import or export
|
|
113
113
|
* @description: Updates locality wise TAT(Turn Around Time) for particular courier scheme using CSV file.
|
|
114
|
-
* Export locality wise CSV files. - Check out [method documentation](https://
|
|
114
|
+
* Export locality wise CSV files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/bulkTat/).
|
|
115
115
|
*/
|
|
116
116
|
async bulkTat(
|
|
117
117
|
{ extensionId, schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -198,7 +198,7 @@ class Serviceability {
|
|
|
198
198
|
*
|
|
199
199
|
* @name createCourierPartnerAccount
|
|
200
200
|
* @summary: Create courier account
|
|
201
|
-
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://
|
|
201
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
202
202
|
*/
|
|
203
203
|
async createCourierPartnerAccount(
|
|
204
204
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -283,7 +283,7 @@ class Serviceability {
|
|
|
283
283
|
*
|
|
284
284
|
* @name createCourierPartnerScheme
|
|
285
285
|
* @summary: Create Scheme for courier partner extension
|
|
286
|
-
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://
|
|
286
|
+
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerScheme/).
|
|
287
287
|
*/
|
|
288
288
|
async createCourierPartnerScheme(
|
|
289
289
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -367,7 +367,7 @@ class Serviceability {
|
|
|
367
367
|
* Success response
|
|
368
368
|
* @name createPackageMaterial
|
|
369
369
|
* @summary: Create packaging material
|
|
370
|
-
* @description: Creates a packaging material - Check out [method documentation](https://
|
|
370
|
+
* @description: Creates a packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterial/).
|
|
371
371
|
*/
|
|
372
372
|
async createPackageMaterial(
|
|
373
373
|
{ body, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -454,7 +454,7 @@ class Serviceability {
|
|
|
454
454
|
* Success response
|
|
455
455
|
* @name createPackageMaterialRule
|
|
456
456
|
* @summary: Create packaging rule
|
|
457
|
-
* @description: Creates a packaging rule - Check out [method documentation](https://
|
|
457
|
+
* @description: Creates a packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createPackageMaterialRule/).
|
|
458
458
|
*/
|
|
459
459
|
async createPackageMaterialRule(
|
|
460
460
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -537,7 +537,7 @@ class Serviceability {
|
|
|
537
537
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
538
538
|
* @name getBulkServiceability
|
|
539
539
|
* @summary: Bulk update history
|
|
540
|
-
* @description: Retrieves the history of changes made to serviceability settings for a scheme. - Check out [method documentation](https://
|
|
540
|
+
* @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/).
|
|
541
541
|
*/
|
|
542
542
|
async getBulkServiceability(
|
|
543
543
|
{
|
|
@@ -660,7 +660,7 @@ class Serviceability {
|
|
|
660
660
|
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionResult>} - Success response
|
|
661
661
|
* @name getBulkTat
|
|
662
662
|
* @summary: Locality TAT change history
|
|
663
|
-
* @description: Retrieves the history of changes made to TAT(Turn Around Time) for scheme. - Check out [method documentation](https://
|
|
663
|
+
* @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/).
|
|
664
664
|
*/
|
|
665
665
|
async getBulkTat(
|
|
666
666
|
{
|
|
@@ -783,7 +783,7 @@ class Serviceability {
|
|
|
783
783
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
784
784
|
* @name getCompanyConfiguration
|
|
785
785
|
* @summary: Get delivery configuration
|
|
786
|
-
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://
|
|
786
|
+
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
787
787
|
*/
|
|
788
788
|
async getCompanyConfiguration(
|
|
789
789
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -860,7 +860,7 @@ class Serviceability {
|
|
|
860
860
|
* @returns {Promise<ServiceabilityPlatformModel.GetCountries>} - Success response
|
|
861
861
|
* @name getCountries
|
|
862
862
|
* @summary: Get all countries and associated data
|
|
863
|
-
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://
|
|
863
|
+
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCountries/).
|
|
864
864
|
*/
|
|
865
865
|
async getCountries(
|
|
866
866
|
{ onboard, pageNo, pageSize, q, hierarchy, requestHeaders } = {
|
|
@@ -957,7 +957,7 @@ class Serviceability {
|
|
|
957
957
|
* Success response
|
|
958
958
|
* @name getCourierPartnerAccount
|
|
959
959
|
* @summary: Get courier account
|
|
960
|
-
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://
|
|
960
|
+
* @description: Retrieves a single courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccount/).
|
|
961
961
|
*/
|
|
962
962
|
async getCourierPartnerAccount(
|
|
963
963
|
{ accountId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1042,7 +1042,7 @@ class Serviceability {
|
|
|
1042
1042
|
*
|
|
1043
1043
|
* @name getCourierPartnerAccounts
|
|
1044
1044
|
* @summary: List courier accounts
|
|
1045
|
-
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://
|
|
1045
|
+
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
1046
1046
|
*/
|
|
1047
1047
|
async getCourierPartnerAccounts(
|
|
1048
1048
|
{
|
|
@@ -1163,7 +1163,7 @@ class Serviceability {
|
|
|
1163
1163
|
*
|
|
1164
1164
|
* @name getCourierPartnerScheme
|
|
1165
1165
|
* @summary: Get Scheme for courier partner extension by Id
|
|
1166
|
-
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://
|
|
1166
|
+
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerScheme/).
|
|
1167
1167
|
*/
|
|
1168
1168
|
async getCourierPartnerScheme(
|
|
1169
1169
|
{ schemeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1244,7 +1244,7 @@ class Serviceability {
|
|
|
1244
1244
|
*
|
|
1245
1245
|
* @name getCourierPartnerSchemes
|
|
1246
1246
|
* @summary: Get created Schemes for courier partner
|
|
1247
|
-
* @description: Get created Schemes for courier partner - Check out [method documentation](https://
|
|
1247
|
+
* @description: Get created Schemes for courier partner - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerSchemes/).
|
|
1248
1248
|
*/
|
|
1249
1249
|
async getCourierPartnerSchemes(
|
|
1250
1250
|
{ schemeType, paymentMode, capabilities, schemeIds, requestHeaders } = {
|
|
@@ -1341,7 +1341,7 @@ class Serviceability {
|
|
|
1341
1341
|
*
|
|
1342
1342
|
* @name getInstalledCourierPartnerExtensions
|
|
1343
1343
|
* @summary: Fetching of Package Material Rules from database.
|
|
1344
|
-
* @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://
|
|
1344
|
+
* @description: This API returns response of Package Materials Rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getInstalledCourierPartnerExtensions/).
|
|
1345
1345
|
*/
|
|
1346
1346
|
async getInstalledCourierPartnerExtensions(
|
|
1347
1347
|
{ pageNo, pageSize, isInstalled, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1430,7 +1430,7 @@ class Serviceability {
|
|
|
1430
1430
|
* Success response
|
|
1431
1431
|
* @name getOptimalLocations
|
|
1432
1432
|
* @summary: Get selling locations
|
|
1433
|
-
* @description: Retrieves a list selling locations which are best suited to fullfil an order for a customer. - Check out [method documentation](https://
|
|
1433
|
+
* @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/).
|
|
1434
1434
|
*/
|
|
1435
1435
|
async getOptimalLocations(
|
|
1436
1436
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1514,7 +1514,7 @@ class Serviceability {
|
|
|
1514
1514
|
* Success response
|
|
1515
1515
|
* @name getPackageMaterialList
|
|
1516
1516
|
* @summary: Get packaging materials
|
|
1517
|
-
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://
|
|
1517
|
+
* @description: Retrieves a list of packaging materials - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialList/).
|
|
1518
1518
|
*/
|
|
1519
1519
|
async getPackageMaterialList(
|
|
1520
1520
|
{ pageNo, pageSize, q, size, packageType, requestHeaders } = {
|
|
@@ -1613,7 +1613,7 @@ class Serviceability {
|
|
|
1613
1613
|
* Success response
|
|
1614
1614
|
* @name getPackageMaterialRule
|
|
1615
1615
|
* @summary: Get packaging material rule
|
|
1616
|
-
* @description: Retrieve packaging rule details. - Check out [method documentation](https://
|
|
1616
|
+
* @description: Retrieve packaging rule details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterialRule/).
|
|
1617
1617
|
*/
|
|
1618
1618
|
async getPackageMaterialRule(
|
|
1619
1619
|
{ ruleId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1694,7 +1694,7 @@ class Serviceability {
|
|
|
1694
1694
|
* @returns {Promise<ServiceabilityPlatformModel.PackageItem>} - Success response
|
|
1695
1695
|
* @name getPackageMaterials
|
|
1696
1696
|
* @summary: Get packaging material
|
|
1697
|
-
* @description: Retrieve a single packaging material - Check out [method documentation](https://
|
|
1697
|
+
* @description: Retrieve a single packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getPackageMaterials/).
|
|
1698
1698
|
*/
|
|
1699
1699
|
async getPackageMaterials(
|
|
1700
1700
|
{ packageMaterialId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1779,7 +1779,7 @@ class Serviceability {
|
|
|
1779
1779
|
*
|
|
1780
1780
|
* @name getSampleFileServiceabilityStatus
|
|
1781
1781
|
* @summary: Get Serviceability TAT sample files generator status
|
|
1782
|
-
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://
|
|
1782
|
+
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getSampleFileServiceabilityStatus/).
|
|
1783
1783
|
*/
|
|
1784
1784
|
async getSampleFileServiceabilityStatus(
|
|
1785
1785
|
{ pageNo, pageSize, batchId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1867,7 +1867,7 @@ class Serviceability {
|
|
|
1867
1867
|
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
1868
1868
|
* @name getSelfShipDetails
|
|
1869
1869
|
* @summary: Get self-ship details
|
|
1870
|
-
* @description: Get the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://
|
|
1870
|
+
* @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/).
|
|
1871
1871
|
*/
|
|
1872
1872
|
async getSelfShipDetails(
|
|
1873
1873
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1948,7 +1948,7 @@ class Serviceability {
|
|
|
1948
1948
|
*
|
|
1949
1949
|
* @name sampleFileServiceability
|
|
1950
1950
|
* @summary: Sample File Download
|
|
1951
|
-
* @description: Sample File Download - Check out [method documentation](https://
|
|
1951
|
+
* @description: Sample File Download - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/sampleFileServiceability/).
|
|
1952
1952
|
*/
|
|
1953
1953
|
async sampleFileServiceability(
|
|
1954
1954
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2031,7 +2031,7 @@ class Serviceability {
|
|
|
2031
2031
|
* @returns {Promise<ServiceabilityPlatformModel.CompanyConfig>} - Success response
|
|
2032
2032
|
* @name updateCompanyConfiguration
|
|
2033
2033
|
* @summary: Update delivery configuration
|
|
2034
|
-
* @description: Updates an existing delivery setup for a company, including the ability to adjust self-shipping preferences. - Check out [method documentation](https://
|
|
2034
|
+
* @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/).
|
|
2035
2035
|
*/
|
|
2036
2036
|
async updateCompanyConfiguration(
|
|
2037
2037
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2116,7 +2116,7 @@ class Serviceability {
|
|
|
2116
2116
|
*
|
|
2117
2117
|
* @name updateCourierPartnerAccount
|
|
2118
2118
|
* @summary: Update courier account
|
|
2119
|
-
* @description: Updates an existing courier partner account. - Check out [method documentation](https://
|
|
2119
|
+
* @description: Updates an existing courier partner account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
2120
2120
|
*/
|
|
2121
2121
|
async updateCourierPartnerAccount(
|
|
2122
2122
|
{ accountId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2203,7 +2203,7 @@ class Serviceability {
|
|
|
2203
2203
|
*
|
|
2204
2204
|
* @name updateCourierPartnerScheme
|
|
2205
2205
|
* @summary: Update Scheme for courier partner extension
|
|
2206
|
-
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://
|
|
2206
|
+
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerScheme/).
|
|
2207
2207
|
*/
|
|
2208
2208
|
async updateCourierPartnerScheme(
|
|
2209
2209
|
{ schemeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2291,7 +2291,7 @@ class Serviceability {
|
|
|
2291
2291
|
* Success response
|
|
2292
2292
|
* @name updatePackageMaterialRule
|
|
2293
2293
|
* @summary: Update packaging rule
|
|
2294
|
-
* @description: Update an existing packaging rule - Check out [method documentation](https://
|
|
2294
|
+
* @description: Update an existing packaging rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterialRule/).
|
|
2295
2295
|
*/
|
|
2296
2296
|
async updatePackageMaterialRule(
|
|
2297
2297
|
{ ruleId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2377,7 +2377,7 @@ class Serviceability {
|
|
|
2377
2377
|
* Success response
|
|
2378
2378
|
* @name updatePackageMaterials
|
|
2379
2379
|
* @summary: Update packaging material
|
|
2380
|
-
* @description: Update an existing packaging material - Check out [method documentation](https://
|
|
2380
|
+
* @description: Update an existing packaging material - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePackageMaterials/).
|
|
2381
2381
|
*/
|
|
2382
2382
|
async updatePackageMaterials(
|
|
2383
2383
|
{ packageMaterialId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2462,7 +2462,7 @@ class Serviceability {
|
|
|
2462
2462
|
* @returns {Promise<ServiceabilityPlatformModel.SelfshipSchema>} - Success response
|
|
2463
2463
|
* @name updateSelfShipDetails
|
|
2464
2464
|
* @summary: Update self-ship details
|
|
2465
|
-
* @description: Updates the self-ship details such as TAT, activation status, and unit for a specified company. - Check out [method documentation](https://
|
|
2465
|
+
* @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/).
|
|
2466
2466
|
*/
|
|
2467
2467
|
async updateSelfShipDetails(
|
|
2468
2468
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -776,6 +776,11 @@ export = ServiceabilityPlatformModel;
|
|
|
776
776
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
777
777
|
* fetch or modify scheme details.
|
|
778
778
|
* @property {string} name - Name of the scheme.
|
|
779
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
780
|
+
* forward pickup (nullable).
|
|
781
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
782
|
+
* reverse pickup (nullable).
|
|
783
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
779
784
|
* @property {ArithmeticOperations} weight
|
|
780
785
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
781
786
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -1136,7 +1141,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1136
1141
|
*/
|
|
1137
1142
|
/**
|
|
1138
1143
|
* @typedef Page
|
|
1139
|
-
* @property {number} [item_total] - The total number of items
|
|
1144
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
1140
1145
|
* @property {string} [next_id] - The identifier for the next page.
|
|
1141
1146
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1142
1147
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -1281,6 +1286,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1281
1286
|
* @property {ArithmeticOperations} [shipment_weight]
|
|
1282
1287
|
* @property {ArithmeticOperations} [shipment_cost]
|
|
1283
1288
|
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
1289
|
+
* @property {StringComparisonOperations} [store_customer_location]
|
|
1284
1290
|
*/
|
|
1285
1291
|
/**
|
|
1286
1292
|
* @typedef LocationRule
|
|
@@ -1332,6 +1338,18 @@ export = ServiceabilityPlatformModel;
|
|
|
1332
1338
|
* @property {string} [stage] - Represents the current stage of the courier
|
|
1333
1339
|
* partner account (e.g., active, inactive, etc.).
|
|
1334
1340
|
*/
|
|
1341
|
+
/**
|
|
1342
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
1343
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
1344
|
+
* time (tat) to be used for the given scheme or not.
|
|
1345
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
1346
|
+
*/
|
|
1347
|
+
/**
|
|
1348
|
+
* @typedef CourierPartnerSchemeTat
|
|
1349
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
1350
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
1351
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
1352
|
+
*/
|
|
1335
1353
|
/**
|
|
1336
1354
|
* @typedef CourierPartnerSchemeFeatures
|
|
1337
1355
|
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
@@ -2018,7 +2036,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2018
2036
|
declare class ServiceabilityPlatformModel {
|
|
2019
2037
|
}
|
|
2020
2038
|
declare namespace ServiceabilityPlatformModel {
|
|
2021
|
-
export { SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, Page, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
|
|
2039
|
+
export { SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, Page, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
|
|
2022
2040
|
}
|
|
2023
2041
|
/** @returns {SelfshipSchema} */
|
|
2024
2042
|
declare function SelfshipSchema(): SelfshipSchema;
|
|
@@ -3992,6 +4010,17 @@ type CourierPartnerSchemeDetailsModel = {
|
|
|
3992
4010
|
* - Name of the scheme.
|
|
3993
4011
|
*/
|
|
3994
4012
|
name: string;
|
|
4013
|
+
/**
|
|
4014
|
+
* - Default cutoff time for
|
|
4015
|
+
* forward pickup (nullable).
|
|
4016
|
+
*/
|
|
4017
|
+
default_forward_pickup_cutoff?: string;
|
|
4018
|
+
/**
|
|
4019
|
+
* - Default cutoff time for
|
|
4020
|
+
* reverse pickup (nullable).
|
|
4021
|
+
*/
|
|
4022
|
+
default_reverse_pickup_cutoff?: string;
|
|
4023
|
+
default_tat?: CourierPartnerSchemeDefaultTat;
|
|
3995
4024
|
weight: ArithmeticOperations;
|
|
3996
4025
|
volumetric_weight?: ArithmeticOperations;
|
|
3997
4026
|
/**
|
|
@@ -4822,7 +4851,7 @@ type RegionSchema = {
|
|
|
4822
4851
|
declare function Page(): Page;
|
|
4823
4852
|
type Page = {
|
|
4824
4853
|
/**
|
|
4825
|
-
* - The total number of items
|
|
4854
|
+
* - The total number of all items across all pages.
|
|
4826
4855
|
*/
|
|
4827
4856
|
item_total?: number;
|
|
4828
4857
|
/**
|
|
@@ -5195,6 +5224,7 @@ type CourierPartnerRuleConditions = {
|
|
|
5195
5224
|
shipment_weight?: ArithmeticOperations;
|
|
5196
5225
|
shipment_cost?: ArithmeticOperations;
|
|
5197
5226
|
shipment_volumetric_weight?: ArithmeticOperations;
|
|
5227
|
+
store_customer_location?: StringComparisonOperations;
|
|
5198
5228
|
};
|
|
5199
5229
|
/** @returns {LocationRule} */
|
|
5200
5230
|
declare function LocationRule(): LocationRule;
|
|
@@ -5309,6 +5339,32 @@ type CourierPartnerRuleCPListResult = {
|
|
|
5309
5339
|
*/
|
|
5310
5340
|
stage?: string;
|
|
5311
5341
|
};
|
|
5342
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
5343
|
+
declare function CourierPartnerSchemeDefaultTat(): CourierPartnerSchemeDefaultTat;
|
|
5344
|
+
type CourierPartnerSchemeDefaultTat = {
|
|
5345
|
+
/**
|
|
5346
|
+
* - Indicates whether the default turn around
|
|
5347
|
+
* time (tat) to be used for the given scheme or not.
|
|
5348
|
+
*/
|
|
5349
|
+
enabled?: boolean;
|
|
5350
|
+
tat?: CourierPartnerSchemeTat;
|
|
5351
|
+
};
|
|
5352
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
5353
|
+
declare function CourierPartnerSchemeTat(): CourierPartnerSchemeTat;
|
|
5354
|
+
type CourierPartnerSchemeTat = {
|
|
5355
|
+
/**
|
|
5356
|
+
* - Minimum turn around time (tat) value for a scheme.
|
|
5357
|
+
*/
|
|
5358
|
+
min?: number;
|
|
5359
|
+
/**
|
|
5360
|
+
* - Maximum turn around time (tat) value for a scheme.
|
|
5361
|
+
*/
|
|
5362
|
+
max?: number;
|
|
5363
|
+
/**
|
|
5364
|
+
* - Unit for the turn around time (tat) values for a scheme.
|
|
5365
|
+
*/
|
|
5366
|
+
unit?: string;
|
|
5367
|
+
};
|
|
5312
5368
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
5313
5369
|
declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
|
|
5314
5370
|
type CourierPartnerSchemeFeatures = {
|
|
@@ -852,6 +852,11 @@ const Joi = require("joi");
|
|
|
852
852
|
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
853
853
|
* fetch or modify scheme details.
|
|
854
854
|
* @property {string} name - Name of the scheme.
|
|
855
|
+
* @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
|
|
856
|
+
* forward pickup (nullable).
|
|
857
|
+
* @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
|
|
858
|
+
* reverse pickup (nullable).
|
|
859
|
+
* @property {CourierPartnerSchemeDefaultTat} [default_tat]
|
|
855
860
|
* @property {ArithmeticOperations} weight
|
|
856
861
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
857
862
|
* @property {string} transport_type - Mode of transport associated with the
|
|
@@ -1246,7 +1251,7 @@ const Joi = require("joi");
|
|
|
1246
1251
|
|
|
1247
1252
|
/**
|
|
1248
1253
|
* @typedef Page
|
|
1249
|
-
* @property {number} [item_total] - The total number of items
|
|
1254
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
1250
1255
|
* @property {string} [next_id] - The identifier for the next page.
|
|
1251
1256
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1252
1257
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -1407,6 +1412,7 @@ const Joi = require("joi");
|
|
|
1407
1412
|
* @property {ArithmeticOperations} [shipment_weight]
|
|
1408
1413
|
* @property {ArithmeticOperations} [shipment_cost]
|
|
1409
1414
|
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
1415
|
+
* @property {StringComparisonOperations} [store_customer_location]
|
|
1410
1416
|
*/
|
|
1411
1417
|
|
|
1412
1418
|
/**
|
|
@@ -1465,6 +1471,20 @@ const Joi = require("joi");
|
|
|
1465
1471
|
* partner account (e.g., active, inactive, etc.).
|
|
1466
1472
|
*/
|
|
1467
1473
|
|
|
1474
|
+
/**
|
|
1475
|
+
* @typedef CourierPartnerSchemeDefaultTat
|
|
1476
|
+
* @property {boolean} [enabled] - Indicates whether the default turn around
|
|
1477
|
+
* time (tat) to be used for the given scheme or not.
|
|
1478
|
+
* @property {CourierPartnerSchemeTat} [tat]
|
|
1479
|
+
*/
|
|
1480
|
+
|
|
1481
|
+
/**
|
|
1482
|
+
* @typedef CourierPartnerSchemeTat
|
|
1483
|
+
* @property {number} [min] - Minimum turn around time (tat) value for a scheme.
|
|
1484
|
+
* @property {number} [max] - Maximum turn around time (tat) value for a scheme.
|
|
1485
|
+
* @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
|
|
1486
|
+
*/
|
|
1487
|
+
|
|
1468
1488
|
/**
|
|
1469
1489
|
* @typedef CourierPartnerSchemeFeatures
|
|
1470
1490
|
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
@@ -3162,6 +3182,9 @@ class ServiceabilityPlatformModel {
|
|
|
3162
3182
|
extension_id: Joi.string().allow("").required(),
|
|
3163
3183
|
scheme_id: Joi.string().allow(""),
|
|
3164
3184
|
name: Joi.string().allow("").required(),
|
|
3185
|
+
default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
3186
|
+
default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
|
|
3187
|
+
default_tat: ServiceabilityPlatformModel.CourierPartnerSchemeDefaultTat(),
|
|
3165
3188
|
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
3166
3189
|
volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3167
3190
|
transport_type: Joi.string().allow("").required(),
|
|
@@ -3748,6 +3771,7 @@ class ServiceabilityPlatformModel {
|
|
|
3748
3771
|
shipment_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3749
3772
|
shipment_cost: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3750
3773
|
shipment_volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3774
|
+
store_customer_location: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
3751
3775
|
});
|
|
3752
3776
|
}
|
|
3753
3777
|
|
|
@@ -3809,6 +3833,23 @@ class ServiceabilityPlatformModel {
|
|
|
3809
3833
|
});
|
|
3810
3834
|
}
|
|
3811
3835
|
|
|
3836
|
+
/** @returns {CourierPartnerSchemeDefaultTat} */
|
|
3837
|
+
static CourierPartnerSchemeDefaultTat() {
|
|
3838
|
+
return Joi.object({
|
|
3839
|
+
enabled: Joi.boolean(),
|
|
3840
|
+
tat: ServiceabilityPlatformModel.CourierPartnerSchemeTat(),
|
|
3841
|
+
});
|
|
3842
|
+
}
|
|
3843
|
+
|
|
3844
|
+
/** @returns {CourierPartnerSchemeTat} */
|
|
3845
|
+
static CourierPartnerSchemeTat() {
|
|
3846
|
+
return Joi.object({
|
|
3847
|
+
min: Joi.number(),
|
|
3848
|
+
max: Joi.number(),
|
|
3849
|
+
unit: Joi.string().allow(""),
|
|
3850
|
+
});
|
|
3851
|
+
}
|
|
3852
|
+
|
|
3812
3853
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
3813
3854
|
static CourierPartnerSchemeFeatures() {
|
|
3814
3855
|
return Joi.object({
|
|
@@ -10,7 +10,7 @@ declare class Share {
|
|
|
10
10
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
11
11
|
* @name createShortLink
|
|
12
12
|
* @summary: Create short link
|
|
13
|
-
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://
|
|
13
|
+
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/createShortLink/).
|
|
14
14
|
*/
|
|
15
15
|
createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
16
16
|
/**
|
|
@@ -20,7 +20,7 @@ declare class Share {
|
|
|
20
20
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
21
21
|
* @name getShortLinkByHash
|
|
22
22
|
* @summary: Get short link by hash
|
|
23
|
-
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://
|
|
23
|
+
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkByHash/).
|
|
24
24
|
*/
|
|
25
25
|
getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
26
26
|
/**
|
|
@@ -32,7 +32,7 @@ declare class Share {
|
|
|
32
32
|
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
33
33
|
* @name getShortLinkClickStats
|
|
34
34
|
* @summary: Get short link click statistics
|
|
35
|
-
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://
|
|
35
|
+
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkClickStats/).
|
|
36
36
|
*/
|
|
37
37
|
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResult>;
|
|
38
38
|
/**
|
|
@@ -42,7 +42,7 @@ declare class Share {
|
|
|
42
42
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
43
43
|
* @name getShortLinks
|
|
44
44
|
* @summary: Get short links
|
|
45
|
-
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://
|
|
45
|
+
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinks/).
|
|
46
46
|
*/
|
|
47
47
|
getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
|
|
48
48
|
/**
|
|
@@ -54,7 +54,7 @@ declare class Share {
|
|
|
54
54
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
55
55
|
* @name updateShortLinkById
|
|
56
56
|
* @summary: Update short link
|
|
57
|
-
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://
|
|
57
|
+
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/updateShortLinkById/).
|
|
58
58
|
*/
|
|
59
59
|
updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
60
60
|
}
|
|
@@ -22,7 +22,7 @@ class Share {
|
|
|
22
22
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
23
23
|
* @name createShortLink
|
|
24
24
|
* @summary: Create short link
|
|
25
|
-
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://
|
|
25
|
+
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/createShortLink/).
|
|
26
26
|
*/
|
|
27
27
|
async createShortLink(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -101,7 +101,7 @@ class Share {
|
|
|
101
101
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
102
102
|
* @name getShortLinkByHash
|
|
103
103
|
* @summary: Get short link by hash
|
|
104
|
-
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://
|
|
104
|
+
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkByHash/).
|
|
105
105
|
*/
|
|
106
106
|
async getShortLinkByHash(
|
|
107
107
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
@@ -182,7 +182,7 @@ class Share {
|
|
|
182
182
|
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
183
183
|
* @name getShortLinkClickStats
|
|
184
184
|
* @summary: Get short link click statistics
|
|
185
|
-
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://
|
|
185
|
+
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinkClickStats/).
|
|
186
186
|
*/
|
|
187
187
|
async getShortLinkClickStats(
|
|
188
188
|
{ surlId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -258,7 +258,7 @@ class Share {
|
|
|
258
258
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
259
259
|
* @name getShortLinks
|
|
260
260
|
* @summary: Get short links
|
|
261
|
-
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://
|
|
261
|
+
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/getShortLinks/).
|
|
262
262
|
*/
|
|
263
263
|
async getShortLinks(
|
|
264
264
|
{
|
|
@@ -367,7 +367,7 @@ class Share {
|
|
|
367
367
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
368
368
|
* @name updateShortLinkById
|
|
369
369
|
* @summary: Update short link
|
|
370
|
-
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://
|
|
370
|
+
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/share/updateShortLinkById/).
|
|
371
371
|
*/
|
|
372
372
|
async updateShortLinkById(
|
|
373
373
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -99,7 +99,7 @@ export = SharePlatformModel;
|
|
|
99
99
|
*/
|
|
100
100
|
/**
|
|
101
101
|
* @typedef Page
|
|
102
|
-
* @property {number} [item_total] - The total number of items
|
|
102
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
103
103
|
* @property {string} [next_id] - The identifier for the next page.
|
|
104
104
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
105
105
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
@@ -263,7 +263,7 @@ type ShortLinkRes = {
|
|
|
263
263
|
declare function Page(): Page;
|
|
264
264
|
type Page = {
|
|
265
265
|
/**
|
|
266
|
-
* - The total number of items
|
|
266
|
+
* - The total number of all items across all pages.
|
|
267
267
|
*/
|
|
268
268
|
item_total?: number;
|
|
269
269
|
/**
|
|
@@ -112,7 +112,7 @@ const Joi = require("joi");
|
|
|
112
112
|
|
|
113
113
|
/**
|
|
114
114
|
* @typedef Page
|
|
115
|
-
* @property {number} [item_total] - The total number of items
|
|
115
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
116
116
|
* @property {string} [next_id] - The identifier for the next page.
|
|
117
117
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
118
118
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|