@gofynd/fdk-client-javascript 1.1.6 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -3
- package/index.js +0 -3
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +12 -3
- package/sdk/application/ApplicationClient.d.ts +36 -6
- package/sdk/application/ApplicationClient.js +30 -43
- package/sdk/application/ApplicationConfig.d.ts +92 -12
- package/sdk/application/ApplicationConfig.js +48 -14
- package/sdk/application/Cart/CartApplicationClient.d.ts +200 -357
- package/sdk/application/Cart/CartApplicationClient.js +711 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +274 -422
- package/sdk/application/Catalog/CatalogApplicationClient.js +865 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2320 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1566 -172
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +16 -21
- package/sdk/application/Common/CommonApplicationClient.js +52 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +368 -19
- package/sdk/application/Common/CommonApplicationModel.js +192 -40
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +31 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +86 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +157 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +104 -23
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +149 -118
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +457 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2235 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1113 -193
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +149 -139
- package/sdk/application/Content/ContentApplicationClient.js +489 -278
- package/sdk/application/Content/ContentApplicationModel.d.ts +1010 -105
- package/sdk/application/Content/ContentApplicationModel.js +737 -396
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +23 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +148 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +100 -87
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +57 -53
- package/sdk/application/Lead/LeadApplicationClient.js +188 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +686 -54
- package/sdk/application/Lead/LeadApplicationModel.js +330 -244
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +40 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +131 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +93 -133
- package/sdk/application/Order/OrderApplicationClient.js +329 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +400 -366
- package/sdk/application/Payment/PaymentApplicationClient.js +1176 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +205 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +720 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +58 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +187 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +52 -50
- package/sdk/application/Share/ShareApplicationClient.js +185 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +198 -15
- package/sdk/application/Share/ShareApplicationModel.js +131 -31
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +30 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +102 -56
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +1291 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +895 -134
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +260 -305
- package/sdk/application/User/UserApplicationClient.js +910 -522
- package/sdk/application/User/UserApplicationModel.d.ts +992 -101
- package/sdk/application/User/UserApplicationModel.js +699 -248
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +7 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +16 -1
- package/sdk/partner/PartnerAPIClient.js +12 -2
- package/sdk/partner/PartnerClient.d.ts +22 -3
- package/sdk/partner/PartnerClient.js +20 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +30 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +104 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +190 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +132 -15
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +52 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +30 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +133 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +561 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1071 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +762 -151
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +175 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +118 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +454 -635
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1646 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3839 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2423 -217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +528 -638
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1600 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +652 -826
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1979 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6869 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -351
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1361 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +624 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +16 -21
- package/sdk/platform/Common/CommonPlatformClient.js +50 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +423 -19
- package/sdk/platform/Common/CommonPlatformModel.js +214 -40
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +37 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +20 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +731 -303
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3095 -785
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +699 -41
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +463 -27
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +19 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +59 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1708 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1360 -235
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +127 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +435 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +882 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +666 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +184 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +105 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +327 -240
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +922 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +297 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +191 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +184 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +555 -311
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4337 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2178 -248
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +605 -578
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1996 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1472 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1085 -204
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +85 -82
- package/sdk/platform/Discount/DiscountPlatformClient.js +333 -175
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +281 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +189 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +109 -52
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +570 -105
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +141 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +118 -7
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +43 -63
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +153 -135
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +426 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +379 -40
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +106 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +60 -8
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +260 -129
- package/sdk/platform/Finance/FinancePlatformClient.js +1182 -194
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1267 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +1252 -38
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +233 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +229 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +111 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +330 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +100 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +372 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +89 -104
- package/sdk/platform/Lead/LeadPlatformClient.js +305 -180
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1045 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +504 -142
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +92 -15
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +20 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +58 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +437 -556
- package/sdk/platform/Order/OrderPlatformClient.js +1500 -760
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5225 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3473 -260
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +859 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +435 -23
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +16 -42
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +37 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +19 -17
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +78 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +43 -369
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +418 -288
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +1509 -505
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +438 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +312 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +83 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +259 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3200 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1334 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +31 -12581
- package/sdk/platform/PlatformClient.js +30 -15089
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +96 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +344 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +360 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +238 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +159 -92
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +473 -208
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +138 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +100 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +166 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +518 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1408 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1034 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +41 -66
- package/sdk/platform/Share/SharePlatformApplicationClient.js +149 -116
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +167 -19
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +229 -193
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +976 -352
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +345 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +206 -14
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1527 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +1099 -118
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +138 -152
- package/sdk/platform/User/UserPlatformApplicationClient.js +470 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +242 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +129 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +653 -101
- package/sdk/platform/User/UserPlatformModel.js +467 -424
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +153 -49
- package/sdk/platform/Webhook/WebhookPlatformClient.js +896 -88
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +632 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +502 -54
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +170 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +157 -7
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +16 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +48 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +370 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +191 -40
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +54 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +161 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +21 -3
- package/sdk/public/PublicClient.js +20 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +16 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +52 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +33 -113
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -3
- package/sdk/application/ApplicationModels.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -145
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -799
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -14
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -87
|
@@ -3,585 +3,466 @@ declare class Order {
|
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
|
-
* @param {
|
|
7
|
-
* @param {
|
|
8
|
-
* @
|
|
6
|
+
* @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
|
|
7
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
+
* @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
|
|
10
|
+
* @name attachOrderUser
|
|
9
11
|
* @summary:
|
|
10
|
-
* @description:
|
|
12
|
+
* @description: Attach Order User - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
|
|
11
13
|
*/
|
|
12
|
-
attachOrderUser({ body }?: {
|
|
13
|
-
body: AttachOrderUser;
|
|
14
|
-
}): Promise<AttachOrderUserResponse>;
|
|
14
|
+
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponse>;
|
|
15
15
|
/**
|
|
16
|
-
* @param {
|
|
17
|
-
* @param {
|
|
18
|
-
* @
|
|
16
|
+
* @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
|
|
17
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
+
* @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
|
|
20
|
+
* @name checkOrderStatus
|
|
19
21
|
* @summary:
|
|
20
|
-
* @description:
|
|
22
|
+
* @description: Check order status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
|
|
21
23
|
*/
|
|
22
|
-
checkOrderStatus({ body }?: {
|
|
23
|
-
body: OrderStatus;
|
|
24
|
-
}): Promise<OrderStatusResult>;
|
|
24
|
+
checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
25
25
|
/**
|
|
26
|
-
* @param {
|
|
27
|
-
* @param {
|
|
28
|
-
* @param {
|
|
29
|
-
* @
|
|
30
|
-
* @
|
|
31
|
-
* @param {string} [arg.method] - Provider Method to Call
|
|
32
|
-
* @returns {Promise<Click2CallResponse>} - Success response
|
|
26
|
+
* @param {OrderPlatformValidator.Click2CallParam} arg - Arg object
|
|
27
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
+
* @returns {Promise<OrderPlatformModel.Click2CallResponse>} - Success response
|
|
30
|
+
* @name click2Call
|
|
33
31
|
* @summary:
|
|
34
|
-
* @description:
|
|
32
|
+
* @description: Click to Call - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/click2Call/).
|
|
35
33
|
*/
|
|
36
|
-
click2Call({ caller, receiver, bagId, callerId, method, }?: {
|
|
37
|
-
caller: string;
|
|
38
|
-
receiver: string;
|
|
39
|
-
bagId: string;
|
|
40
|
-
callerId?: string;
|
|
41
|
-
method?: string;
|
|
42
|
-
}): Promise<Click2CallResponse>;
|
|
34
|
+
click2Call({ caller, receiver, bagId, callerId, method, requestHeaders }?: OrderPlatformValidator.Click2CallParam, { responseHeaders }?: object): Promise<OrderPlatformModel.Click2CallResponse>;
|
|
43
35
|
/**
|
|
44
|
-
* @param {
|
|
45
|
-
* @param {
|
|
46
|
-
* @
|
|
36
|
+
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
37
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponse>} -
|
|
40
|
+
* Success response
|
|
41
|
+
* @name createChannelConfig
|
|
47
42
|
* @summary:
|
|
48
|
-
* @description: createChannelConfig
|
|
43
|
+
* @description: createChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
49
44
|
*/
|
|
50
|
-
createChannelConfig({ body }?: {
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
* @param {
|
|
55
|
-
* @
|
|
56
|
-
* @
|
|
45
|
+
createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponse>;
|
|
46
|
+
/**
|
|
47
|
+
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
48
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
49
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
50
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
|
|
51
|
+
* @name createOrder
|
|
52
|
+
* @summary:
|
|
53
|
+
* @description: Create Order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
54
|
+
*/
|
|
55
|
+
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
56
|
+
/**
|
|
57
|
+
* @param {OrderPlatformValidator.DispatchManifestParam} arg - Arg object
|
|
58
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
61
|
+
* @name dispatchManifest
|
|
62
|
+
* @summary:
|
|
63
|
+
* @description: Dispatch Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifest/).
|
|
64
|
+
*/
|
|
65
|
+
dispatchManifest({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
66
|
+
/**
|
|
67
|
+
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
68
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
71
|
+
* @name downloadBulkActionTemplate
|
|
72
|
+
* @summary:
|
|
73
|
+
* @description: Download bulk actions seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
|
|
74
|
+
*/
|
|
75
|
+
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
|
|
78
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
+
* @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponse>} -
|
|
81
|
+
* Success response
|
|
82
|
+
* @name downloadLanesReport
|
|
83
|
+
* @summary:
|
|
84
|
+
* @description: downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
|
|
85
|
+
*/
|
|
86
|
+
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
|
|
89
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
|
+
* @returns {Promise<OrderPlatformModel.EInvoiceRetryResponse>} - Success response
|
|
92
|
+
* @name eInvoiceRetry
|
|
93
|
+
* @summary:
|
|
94
|
+
* @description: Retry e-invoice after failure - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
95
|
+
*/
|
|
96
|
+
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponse>;
|
|
97
|
+
/**
|
|
98
|
+
* @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
|
|
99
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
100
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
|
+
* @returns {Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>}
|
|
102
|
+
* - Success response
|
|
103
|
+
*
|
|
104
|
+
* @name fetchCreditBalanceDetail
|
|
105
|
+
* @summary:
|
|
106
|
+
* @description: Fetch Credit Balance Detail - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
|
|
107
|
+
*/
|
|
108
|
+
fetchCreditBalanceDetail({ body, requestHeaders }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
|
|
109
|
+
/**
|
|
110
|
+
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
111
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
112
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
113
|
+
* @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
|
|
114
|
+
* Success response
|
|
115
|
+
* @name fetchRefundModeConfig
|
|
116
|
+
* @summary:
|
|
117
|
+
* @description: Fetch Refund Mode Config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
|
|
118
|
+
*/
|
|
119
|
+
fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
|
|
120
|
+
/**
|
|
121
|
+
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
122
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
|
|
125
|
+
* Success response
|
|
126
|
+
* @name generatePOSReceiptByOrderId
|
|
127
|
+
* @summary:
|
|
128
|
+
* @description: Generate POS recipt by order id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
|
|
129
|
+
*/
|
|
130
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
|
|
131
|
+
/**
|
|
132
|
+
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
133
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
134
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
135
|
+
* @returns {Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>} -
|
|
136
|
+
* Success response
|
|
137
|
+
* @name getAllowedStateTransition
|
|
138
|
+
* @summary: To fetch next state transitions.
|
|
139
|
+
* @description: This endpoint will fetch next possible states based on logged in user
|
|
140
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
|
|
141
|
+
*/
|
|
142
|
+
getAllowedStateTransition({ orderingChannel, status, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
|
|
143
|
+
/**
|
|
144
|
+
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
145
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
146
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
147
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
|
|
148
|
+
* @name getAnnouncements
|
|
149
|
+
* @summary:
|
|
150
|
+
* @description: Get Announcements - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
|
|
151
|
+
*/
|
|
152
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
|
|
153
|
+
/**
|
|
154
|
+
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
155
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
156
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
157
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
|
|
158
|
+
* Success response
|
|
159
|
+
* @name getBagById
|
|
160
|
+
* @summary:
|
|
161
|
+
* @description: Get Order Bag Details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
162
|
+
*/
|
|
163
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
|
|
164
|
+
/**
|
|
165
|
+
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
166
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
167
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
168
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
|
|
169
|
+
* @name getBags
|
|
170
|
+
* @summary:
|
|
171
|
+
* @description: Get Bags for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
|
|
172
|
+
*/
|
|
173
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
|
|
174
|
+
/**
|
|
175
|
+
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
176
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
177
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
178
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
|
|
179
|
+
* Success response
|
|
180
|
+
* @name getBulkActionTemplate
|
|
181
|
+
* @summary:
|
|
182
|
+
* @description: Get Bulk Action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
|
|
183
|
+
*/
|
|
184
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
|
|
185
|
+
/**
|
|
186
|
+
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
187
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
188
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
189
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
190
|
+
* @name getBulkShipmentExcelFile
|
|
57
191
|
* @summary:
|
|
58
|
-
* @description:
|
|
192
|
+
* @description: Generate Bulk Shipment Excel Report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
59
193
|
*/
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
* @param {
|
|
65
|
-
* @
|
|
66
|
-
* @
|
|
67
|
-
* @summary:
|
|
68
|
-
* @description:
|
|
69
|
-
*/
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
* @param {
|
|
75
|
-
* @
|
|
76
|
-
* @
|
|
77
|
-
* @summary:
|
|
78
|
-
* @description:
|
|
79
|
-
*/
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
* @param {
|
|
85
|
-
* @
|
|
86
|
-
* @
|
|
87
|
-
* @summary:
|
|
88
|
-
* @description:
|
|
89
|
-
*/
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
* @param {
|
|
95
|
-
* @
|
|
96
|
-
* @
|
|
97
|
-
* @summary:
|
|
98
|
-
* @description:
|
|
99
|
-
*/
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* @param {
|
|
105
|
-
* @
|
|
106
|
-
* @
|
|
107
|
-
* @
|
|
108
|
-
* @
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
* @
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
* @
|
|
123
|
-
* @
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
* @param {
|
|
133
|
-
* @
|
|
134
|
-
* @
|
|
135
|
-
* @
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
bagId?: string;
|
|
139
|
-
channelBagId?: string;
|
|
140
|
-
channelId?: string;
|
|
141
|
-
}): Promise<BagDetailsPlatformResponse>;
|
|
142
|
-
/**
|
|
143
|
-
* @param {Object} arg - Arg object.
|
|
144
|
-
* @param {string} [arg.bagIds] - Comma separated values of bag ids
|
|
145
|
-
* @param {string} [arg.shipmentIds] - Comma separated values of shipment ids
|
|
146
|
-
* @param {string} [arg.orderIds] - Comma separated values of order ids
|
|
147
|
-
* @param {string} [arg.channelBagIds] - Comma separated values of app bag ids
|
|
148
|
-
* @param {string} [arg.channelShipmentIds] - Comma separated values of app
|
|
149
|
-
* shipment ids
|
|
150
|
-
* @param {string} [arg.channelOrderIds] - Comma separated values of app order ids
|
|
151
|
-
* @param {string} [arg.channelId] - Comma separated values of app ids
|
|
152
|
-
* @param {number} [arg.pageNo] - Page number for paginated data
|
|
153
|
-
* @param {number} [arg.pageSize] - Page size of data received per page
|
|
154
|
-
* @returns {Promise<GetBagsPlatformResponse>} - Success response
|
|
155
|
-
* @summary:
|
|
156
|
-
* @description:
|
|
157
|
-
*/
|
|
158
|
-
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, }?: {
|
|
159
|
-
bagIds?: string;
|
|
160
|
-
shipmentIds?: string;
|
|
161
|
-
orderIds?: string;
|
|
162
|
-
channelBagIds?: string;
|
|
163
|
-
channelShipmentIds?: string;
|
|
164
|
-
channelOrderIds?: string;
|
|
165
|
-
channelId?: string;
|
|
166
|
-
pageNo?: number;
|
|
167
|
-
pageSize?: number;
|
|
168
|
-
}): Promise<GetBagsPlatformResponse>;
|
|
169
|
-
/**
|
|
170
|
-
* @param {Object} arg - Arg object.
|
|
171
|
-
* @returns {Promise<BulkActionTemplateResponse>} - Success response
|
|
172
|
-
* @summary:
|
|
173
|
-
* @description:
|
|
174
|
-
*/
|
|
175
|
-
getBulkActionTemplate({}?: any): Promise<BulkActionTemplateResponse>;
|
|
176
|
-
/**
|
|
177
|
-
* @param {Object} arg - Arg object.
|
|
178
|
-
* @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
|
|
179
|
-
* @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
|
|
180
|
-
* @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
|
|
181
|
-
* @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
|
|
182
|
-
* @param {string} [arg.stores] - Comma separated values of store ids
|
|
183
|
-
* @param {string} [arg.tags] - Comma separated values of tags
|
|
184
|
-
* @param {string} [arg.bagStatus] - Comma separated values of bag statuses
|
|
185
|
-
* @param {string} [arg.paymentMethods] - Comma separated values of payment methods
|
|
186
|
-
* @param {string} [arg.fileType] - File type to be downloaded
|
|
187
|
-
* @param {number} [arg.timeToDispatch] - Sla breached or not breached
|
|
188
|
-
* @param {number} [arg.pageNo] -
|
|
189
|
-
* @param {number} [arg.pageSize] -
|
|
190
|
-
* @returns {Promise<FileResponse>} - Success response
|
|
191
|
-
* @summary:
|
|
192
|
-
* @description:
|
|
193
|
-
*/
|
|
194
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds, fromDate, toDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, }?: {
|
|
195
|
-
salesChannels?: string;
|
|
196
|
-
dpIds?: string;
|
|
197
|
-
fromDate?: string;
|
|
198
|
-
toDate?: string;
|
|
199
|
-
stores?: string;
|
|
200
|
-
tags?: string;
|
|
201
|
-
bagStatus?: string;
|
|
202
|
-
paymentMethods?: string;
|
|
203
|
-
fileType?: string;
|
|
204
|
-
timeToDispatch?: number;
|
|
205
|
-
pageNo?: number;
|
|
206
|
-
pageSize?: number;
|
|
207
|
-
}): Promise<FileResponse>;
|
|
208
|
-
/**
|
|
209
|
-
* @param {Object} arg - Arg object.
|
|
210
|
-
* @returns {Promise<CreateChannelConfigData>} - Success response
|
|
211
|
-
* @summary:
|
|
212
|
-
* @description: getChannelConfig
|
|
213
|
-
*/
|
|
214
|
-
getChannelConfig({}?: any): Promise<CreateChannelConfigData>;
|
|
215
|
-
/**
|
|
216
|
-
* @param {Object} arg - Arg object.
|
|
217
|
-
* @param {string} [arg.superLane] - Name of lane for which data is to be fetched
|
|
218
|
-
* @param {string} [arg.groupEntity] - Name of group entity
|
|
219
|
-
* @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
|
|
220
|
-
* @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
|
|
221
|
-
* @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
|
|
222
|
-
* @param {string} [arg.stores] - Comma separated values of store ids
|
|
223
|
-
* @param {string} [arg.salesChannels] -
|
|
224
|
-
* @param {string} [arg.paymentMode] - Comma separated values of payment modes
|
|
225
|
-
* @param {string} [arg.bagStatus] - Comma separated values of bag statuses
|
|
226
|
-
* @param {string} [arg.searchType] -
|
|
227
|
-
* @param {string} [arg.searchValue] -
|
|
228
|
-
* @param {string} [arg.tags] -
|
|
229
|
-
* @param {string} [arg.timeToDispatch] -
|
|
230
|
-
* @param {string} [arg.paymentMethods] -
|
|
231
|
-
* @param {boolean} [arg.myOrders] -
|
|
232
|
-
* @returns {Promise<LaneConfigResponse>} - Success response
|
|
233
|
-
* @summary:
|
|
234
|
-
* @description:
|
|
235
|
-
*/
|
|
236
|
-
getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, }?: {
|
|
237
|
-
superLane?: string;
|
|
238
|
-
groupEntity?: string;
|
|
239
|
-
fromDate?: string;
|
|
240
|
-
toDate?: string;
|
|
241
|
-
dpIds?: string;
|
|
242
|
-
stores?: string;
|
|
243
|
-
salesChannels?: string;
|
|
244
|
-
paymentMode?: string;
|
|
245
|
-
bagStatus?: string;
|
|
246
|
-
searchType?: string;
|
|
247
|
-
searchValue?: string;
|
|
248
|
-
tags?: string;
|
|
249
|
-
timeToDispatch?: string;
|
|
250
|
-
paymentMethods?: string;
|
|
251
|
-
myOrders?: boolean;
|
|
252
|
-
}): Promise<LaneConfigResponse>;
|
|
253
|
-
/**
|
|
254
|
-
* @param {Object} arg - Arg object.
|
|
255
|
-
* @param {string} arg.orderId -
|
|
256
|
-
* @returns {Promise<OrderDetailsResponse>} - Success response
|
|
257
|
-
* @summary:
|
|
258
|
-
* @description:
|
|
259
|
-
*/
|
|
260
|
-
getOrderById({ orderId }?: {
|
|
261
|
-
orderId: string;
|
|
262
|
-
}): Promise<OrderDetailsResponse>;
|
|
263
|
-
/**
|
|
264
|
-
* @param {Object} arg - Arg object.
|
|
265
|
-
* @param {string} [arg.lane] - Lane refers to a section where orders are
|
|
266
|
-
* assigned, indicating its grouping
|
|
267
|
-
* @param {string} [arg.searchType] - Search_type refers to the field that
|
|
268
|
-
* will be used as the target for the search operation
|
|
269
|
-
* @param {string} [arg.bagStatus] - Bag_status refers to status of the
|
|
270
|
-
* entity. Filters orders based on the status.
|
|
271
|
-
* @param {string} [arg.timeToDispatch] - Time_to_dispatch refers to
|
|
272
|
-
* estimated SLA time.
|
|
273
|
-
* @param {string} [arg.paymentMethods] -
|
|
274
|
-
* @param {string} [arg.tags] - Tags refers to additional descriptive labels
|
|
275
|
-
* associated with the order
|
|
276
|
-
* @param {string} [arg.searchValue] - Search_value is matched against the
|
|
277
|
-
* field specified by the search_type
|
|
278
|
-
* @param {string} [arg.fromDate] -
|
|
279
|
-
* @param {string} [arg.toDate] -
|
|
280
|
-
* @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
281
|
-
* @param {string} [arg.stores] -
|
|
282
|
-
* @param {string} [arg.salesChannels] -
|
|
283
|
-
* @param {number} [arg.pageNo] -
|
|
284
|
-
* @param {number} [arg.pageSize] -
|
|
285
|
-
* @param {boolean} [arg.isPrioritySort] -
|
|
286
|
-
* @param {string} [arg.customMeta] -
|
|
287
|
-
* @param {boolean} [arg.myOrders] -
|
|
288
|
-
* @returns {Promise<OrderListingResponse>} - Success response
|
|
289
|
-
* @summary:
|
|
290
|
-
* @description:
|
|
291
|
-
*/
|
|
292
|
-
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, }?: {
|
|
293
|
-
lane?: string;
|
|
294
|
-
searchType?: string;
|
|
295
|
-
bagStatus?: string;
|
|
296
|
-
timeToDispatch?: string;
|
|
297
|
-
paymentMethods?: string;
|
|
298
|
-
tags?: string;
|
|
299
|
-
searchValue?: string;
|
|
300
|
-
fromDate?: string;
|
|
301
|
-
toDate?: string;
|
|
302
|
-
dpIds?: string;
|
|
303
|
-
stores?: string;
|
|
304
|
-
salesChannels?: string;
|
|
305
|
-
pageNo?: number;
|
|
306
|
-
pageSize?: number;
|
|
307
|
-
isPrioritySort?: boolean;
|
|
308
|
-
customMeta?: string;
|
|
309
|
-
myOrders?: boolean;
|
|
310
|
-
}): Promise<OrderListingResponse>;
|
|
311
|
-
/**
|
|
312
|
-
* @param {Object} arg - Arg object.
|
|
313
|
-
* @returns {Promise<GetActionsResponse>} - Success response
|
|
314
|
-
* @summary:
|
|
315
|
-
* @description:
|
|
316
|
-
*/
|
|
317
|
-
getRoleBasedActions({}?: any): Promise<GetActionsResponse>;
|
|
318
|
-
/**
|
|
319
|
-
* @param {Object} arg - Arg object.
|
|
320
|
-
* @param {string} [arg.channelShipmentId] - App Shipment Id
|
|
321
|
-
* @param {string} [arg.shipmentId] - Shipment Id
|
|
322
|
-
* @returns {Promise<ShipmentInfoResponse>} - Success response
|
|
323
|
-
* @summary:
|
|
324
|
-
* @description:
|
|
325
|
-
*/
|
|
326
|
-
getShipmentById({ channelShipmentId, shipmentId }?: {
|
|
327
|
-
channelShipmentId?: string;
|
|
328
|
-
shipmentId?: string;
|
|
329
|
-
}): Promise<ShipmentInfoResponse>;
|
|
330
|
-
/**
|
|
331
|
-
* @param {Object} arg - Arg object.
|
|
332
|
-
* @param {string} [arg.shipmentId] - Shipment Id
|
|
333
|
-
* @param {number} [arg.bagId] - Bag/Product Id
|
|
334
|
-
* @returns {Promise<ShipmentHistoryResponse>} - Success response
|
|
335
|
-
* @summary:
|
|
336
|
-
* @description:
|
|
337
|
-
*/
|
|
338
|
-
getShipmentHistory({ shipmentId, bagId }?: {
|
|
339
|
-
shipmentId?: string;
|
|
340
|
-
bagId?: number;
|
|
341
|
-
}): Promise<ShipmentHistoryResponse>;
|
|
342
|
-
/**
|
|
343
|
-
* @param {Object} arg - Arg object.
|
|
344
|
-
* @param {string} arg.shipmentId - ID of the shipment. An order may contain
|
|
345
|
-
* multiple items and may get divided into one or more shipment, each
|
|
346
|
-
* having its own ID.
|
|
347
|
-
* @param {string} arg.bagId - ID of the bag. An order may contain multiple
|
|
348
|
-
* items and may get divided into one or more shipment, each having its own ID.
|
|
349
|
-
* @param {string} arg.state - State for which reasons are required.
|
|
350
|
-
* @returns {Promise<PlatformShipmentReasonsResponse>} - Success response
|
|
194
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, fromDate, toDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
195
|
+
/**
|
|
196
|
+
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
197
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
198
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
199
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
200
|
+
* @name getChannelConfig
|
|
201
|
+
* @summary:
|
|
202
|
+
* @description: getChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
203
|
+
*/
|
|
204
|
+
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
205
|
+
/**
|
|
206
|
+
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
207
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
208
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
209
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
|
|
210
|
+
* @name getLaneConfig
|
|
211
|
+
* @summary:
|
|
212
|
+
* @description: Get lane config for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
213
|
+
*/
|
|
214
|
+
getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponse>;
|
|
215
|
+
/**
|
|
216
|
+
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
217
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
218
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
219
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
|
|
220
|
+
* @name getOrderById
|
|
221
|
+
* @summary:
|
|
222
|
+
* @description: Get Order Details by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
223
|
+
*/
|
|
224
|
+
getOrderById({ orderId, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
225
|
+
/**
|
|
226
|
+
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
227
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
228
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
229
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
|
|
230
|
+
* @name getOrders
|
|
231
|
+
* @summary:
|
|
232
|
+
* @description: Get Orders Listing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
233
|
+
*/
|
|
234
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
|
|
235
|
+
/**
|
|
236
|
+
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
237
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
238
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
239
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
|
|
240
|
+
* @name getRoleBasedActions
|
|
241
|
+
* @summary:
|
|
242
|
+
* @description: Get Role Based Actions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
|
|
243
|
+
*/
|
|
244
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
|
|
245
|
+
/**
|
|
246
|
+
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
247
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
248
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
249
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
|
|
250
|
+
* @name getShipmentById
|
|
251
|
+
* @summary:
|
|
252
|
+
* @description: Get shipment details for the given shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
253
|
+
*/
|
|
254
|
+
getShipmentById({ channelShipmentId, shipmentId, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
|
|
255
|
+
/**
|
|
256
|
+
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
257
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
258
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
260
|
+
* @name getShipmentHistory
|
|
261
|
+
* @summary:
|
|
262
|
+
* @description: Get Shipment History - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
263
|
+
*/
|
|
264
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
265
|
+
/**
|
|
266
|
+
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
267
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
268
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
269
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
|
|
270
|
+
* Success response
|
|
271
|
+
* @name getShipmentReasons
|
|
351
272
|
* @summary: Get reasons behind full or partial cancellation of a shipment
|
|
352
|
-
* @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
|
|
353
|
-
*/
|
|
354
|
-
getShipmentReasons({ shipmentId, bagId, state }?: {
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
* @
|
|
363
|
-
* @
|
|
364
|
-
*
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
* @param {string} [arg.searchValue] - Search type value
|
|
368
|
-
* @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
|
|
369
|
-
* @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
|
|
370
|
-
* @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
|
|
371
|
-
* @param {string} [arg.stores] - Comma separated values of store ids
|
|
372
|
-
* @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
|
|
373
|
-
* @param {number} [arg.pageNo] - Page number for paginated data
|
|
374
|
-
* @param {number} [arg.pageSize] - Page size of data received per page
|
|
375
|
-
* @param {boolean} [arg.fetchActiveShipment] - Flag to fetch active shipments
|
|
376
|
-
* @param {boolean} [arg.excludeLockedShipments] - Flag to fetch locked shipments
|
|
377
|
-
* @param {string} [arg.paymentMethods] - Comma separated values of payment methods
|
|
378
|
-
* @param {string} [arg.channelShipmentId] - App Shipment Id
|
|
379
|
-
* @param {string} [arg.channelOrderId] - App Order Id
|
|
380
|
-
* @param {string} [arg.customMeta] -
|
|
381
|
-
* @param {string} [arg.orderingChannel] -
|
|
382
|
-
* @param {string} [arg.companyAffiliateTag] -
|
|
383
|
-
* @param {boolean} [arg.myOrders] -
|
|
384
|
-
* @param {string} [arg.platformUserId] -
|
|
385
|
-
* @param {string} [arg.tags] - Comma separated values of tags
|
|
386
|
-
* @returns {Promise<ShipmentInternalPlatformViewResponse>} - Success response
|
|
387
|
-
* @summary:
|
|
388
|
-
* @description:
|
|
389
|
-
*/
|
|
390
|
-
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, tags, }?: {
|
|
391
|
-
lane?: string;
|
|
392
|
-
bagStatus?: string;
|
|
393
|
-
statusOverrideLane?: boolean;
|
|
394
|
-
timeToDispatch?: string;
|
|
395
|
-
searchType?: string;
|
|
396
|
-
searchValue?: string;
|
|
397
|
-
fromDate?: string;
|
|
398
|
-
toDate?: string;
|
|
399
|
-
dpIds?: string;
|
|
400
|
-
stores?: string;
|
|
401
|
-
salesChannels?: string;
|
|
402
|
-
pageNo?: number;
|
|
403
|
-
pageSize?: number;
|
|
404
|
-
fetchActiveShipment?: boolean;
|
|
405
|
-
excludeLockedShipments?: boolean;
|
|
406
|
-
paymentMethods?: string;
|
|
407
|
-
channelShipmentId?: string;
|
|
408
|
-
channelOrderId?: string;
|
|
409
|
-
customMeta?: string;
|
|
410
|
-
orderingChannel?: string;
|
|
411
|
-
companyAffiliateTag?: string;
|
|
412
|
-
myOrders?: boolean;
|
|
413
|
-
platformUserId?: string;
|
|
414
|
-
tags?: string;
|
|
415
|
-
}): Promise<ShipmentInternalPlatformViewResponse>;
|
|
416
|
-
/**
|
|
417
|
-
* @param {Object} arg - Arg object.
|
|
418
|
-
* @returns {Promise<BagStateTransitionMap>} - Success response
|
|
419
|
-
* @summary:
|
|
420
|
-
* @description:
|
|
421
|
-
*/
|
|
422
|
-
getStateTransitionMap({}?: any): Promise<BagStateTransitionMap>;
|
|
423
|
-
/**
|
|
424
|
-
* @param {Object} arg - Arg object.
|
|
425
|
-
* @param {string} arg.view - Name of view
|
|
426
|
-
* @param {string} [arg.groupEntity] - Name of group entity
|
|
427
|
-
* @returns {Promise<FiltersResponse>} - Success response
|
|
428
|
-
* @summary:
|
|
429
|
-
* @description:
|
|
430
|
-
*/
|
|
431
|
-
getfilters({ view, groupEntity }?: {
|
|
432
|
-
view: string;
|
|
433
|
-
groupEntity?: string;
|
|
434
|
-
}): Promise<FiltersResponse>;
|
|
435
|
-
/**
|
|
436
|
-
* @param {Object} arg - Arg object.
|
|
437
|
-
* @param {InvalidateShipmentCachePayload} arg.body
|
|
438
|
-
* @returns {Promise<InvalidateShipmentCacheResponse>} - Success response
|
|
439
|
-
* @summary:
|
|
440
|
-
* @description: Invalidate shipment Cache
|
|
441
|
-
*/
|
|
442
|
-
invalidateShipmentCache({ body }?: {
|
|
443
|
-
body: InvalidateShipmentCachePayload;
|
|
444
|
-
}): Promise<InvalidateShipmentCacheResponse>;
|
|
445
|
-
/**
|
|
446
|
-
* @param {Object} arg - Arg object.
|
|
447
|
-
* @param {PlatformOrderUpdate} arg.body
|
|
448
|
-
* @returns {Promise<ResponseDetail>} - Success response
|
|
449
|
-
* @summary:
|
|
450
|
-
* @description:
|
|
451
|
-
*/
|
|
452
|
-
orderUpdate({ body }?: {
|
|
453
|
-
body: PlatformOrderUpdate;
|
|
454
|
-
}): Promise<ResponseDetail>;
|
|
455
|
-
/**
|
|
456
|
-
* @param {Object} arg - Arg object.
|
|
457
|
-
* @param {PostShipmentHistory} arg.body
|
|
458
|
-
* @returns {Promise<ShipmentHistoryResponse>} - Success response
|
|
459
|
-
* @summary:
|
|
460
|
-
* @description:
|
|
461
|
-
*/
|
|
462
|
-
postShipmentHistory({ body }?: {
|
|
463
|
-
body: PostShipmentHistory;
|
|
464
|
-
}): Promise<ShipmentHistoryResponse>;
|
|
465
|
-
/**
|
|
466
|
-
* @param {Object} arg - Arg object.
|
|
467
|
-
* @param {CreateOrderPayload} arg.body
|
|
468
|
-
* @returns {Promise<CreateOrderResponse>} - Success response
|
|
469
|
-
* @summary:
|
|
470
|
-
* @description:
|
|
471
|
-
*/
|
|
472
|
-
processManifest({ body }?: {
|
|
473
|
-
body: CreateOrderPayload;
|
|
474
|
-
}): Promise<CreateOrderResponse>;
|
|
475
|
-
/**
|
|
476
|
-
* @param {Object} arg - Arg object.
|
|
477
|
-
* @param {StoreReassign} arg.body
|
|
478
|
-
* @returns {Promise<StoreReassignResponse>} - Success response
|
|
479
|
-
* @summary:
|
|
480
|
-
* @description: Reassign Location
|
|
481
|
-
*/
|
|
482
|
-
reassignLocation({ body }?: {
|
|
483
|
-
body: StoreReassign;
|
|
484
|
-
}): Promise<StoreReassignResponse>;
|
|
485
|
-
/**
|
|
486
|
-
* @param {Object} arg - Arg object.
|
|
487
|
-
* @param {SendSmsPayload} arg.body
|
|
488
|
-
* @returns {Promise<OrderStatusResult>} - Success response
|
|
489
|
-
* @summary:
|
|
490
|
-
* @description:
|
|
491
|
-
*/
|
|
492
|
-
sendSmsNinja({ body }?: {
|
|
493
|
-
body: SendSmsPayload;
|
|
494
|
-
}): Promise<OrderStatusResult>;
|
|
495
|
-
/**
|
|
496
|
-
* @param {Object} arg - Arg object.
|
|
497
|
-
* @param {SendUserMobileOTP} arg.body
|
|
498
|
-
* @returns {Promise<SendUserMobileOtpResponse>} - Success response
|
|
499
|
-
* @summary:
|
|
500
|
-
* @description:
|
|
501
|
-
*/
|
|
502
|
-
sendUserMobileOTP({ body }?: {
|
|
503
|
-
body: SendUserMobileOTP;
|
|
504
|
-
}): Promise<SendUserMobileOtpResponse>;
|
|
273
|
+
* @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
|
|
274
|
+
*/
|
|
275
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
|
|
276
|
+
/**
|
|
277
|
+
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
278
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
279
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
|
|
281
|
+
* - Success response
|
|
282
|
+
*
|
|
283
|
+
* @name getShipments
|
|
284
|
+
* @summary:
|
|
285
|
+
* @description: Get Shipments Listing for the company id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
286
|
+
*/
|
|
287
|
+
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
|
|
505
288
|
/**
|
|
506
|
-
* @param {
|
|
507
|
-
* @param {
|
|
508
|
-
* @param {
|
|
509
|
-
* @
|
|
510
|
-
* @
|
|
511
|
-
* @param {string} [arg.pincode] -
|
|
512
|
-
* @param {string} [arg.phone] -
|
|
513
|
-
* @param {string} [arg.email] -
|
|
514
|
-
* @param {string} [arg.landmark] -
|
|
515
|
-
* @param {string} arg.addressCategory -
|
|
516
|
-
* @param {string} [arg.city] -
|
|
517
|
-
* @param {string} [arg.state] -
|
|
518
|
-
* @param {string} [arg.country] -
|
|
519
|
-
* @returns {Promise<BaseResponse>} - Success response
|
|
289
|
+
* @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
|
|
290
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
291
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
292
|
+
* @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
|
|
293
|
+
* @name getStateTransitionMap
|
|
520
294
|
* @summary:
|
|
521
|
-
* @description:
|
|
295
|
+
* @description: Get State Transition Map - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
|
|
522
296
|
*/
|
|
523
|
-
|
|
524
|
-
shipmentId: string;
|
|
525
|
-
name?: string;
|
|
526
|
-
address?: string;
|
|
527
|
-
addressType?: string;
|
|
528
|
-
pincode?: string;
|
|
529
|
-
phone?: string;
|
|
530
|
-
email?: string;
|
|
531
|
-
landmark?: string;
|
|
532
|
-
addressCategory: string;
|
|
533
|
-
city?: string;
|
|
534
|
-
state?: string;
|
|
535
|
-
country?: string;
|
|
536
|
-
}): Promise<BaseResponse>;
|
|
297
|
+
getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
|
|
537
298
|
/**
|
|
538
|
-
* @param {
|
|
539
|
-
* @param {
|
|
540
|
-
* @
|
|
299
|
+
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
300
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
301
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
302
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
|
|
303
|
+
* @name getfilters
|
|
541
304
|
* @summary:
|
|
542
|
-
* @description:
|
|
305
|
+
* @description: Get Listing Filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
543
306
|
*/
|
|
544
|
-
|
|
545
|
-
body: UpdatePackagingDimensionsPayload;
|
|
546
|
-
}): Promise<UpdatePackagingDimensionsResponse>;
|
|
307
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
|
|
547
308
|
/**
|
|
548
|
-
* @param {
|
|
549
|
-
* @param {
|
|
550
|
-
* @
|
|
309
|
+
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
310
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
311
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
312
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
|
|
313
|
+
* Success response
|
|
314
|
+
* @name invalidateShipmentCache
|
|
551
315
|
* @summary:
|
|
552
|
-
* @description:
|
|
316
|
+
* @description: Invalidate shipment Cache - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
|
|
553
317
|
*/
|
|
554
|
-
|
|
555
|
-
body: UpdateShipmentLockPayload;
|
|
556
|
-
}): Promise<UpdateShipmentLockResponse>;
|
|
318
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
|
|
557
319
|
/**
|
|
558
|
-
* @param {
|
|
559
|
-
* @param {
|
|
560
|
-
* @
|
|
320
|
+
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
321
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
322
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
323
|
+
* @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
|
|
324
|
+
* @name orderUpdate
|
|
561
325
|
* @summary:
|
|
562
|
-
* @description:
|
|
563
|
-
*/
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
* @param {
|
|
569
|
-
* @
|
|
570
|
-
* @
|
|
571
|
-
* @summary:
|
|
572
|
-
* @description:
|
|
573
|
-
*/
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
* @param {
|
|
579
|
-
* @
|
|
580
|
-
* @
|
|
581
|
-
* @summary:
|
|
582
|
-
* @description:
|
|
583
|
-
*/
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
326
|
+
* @description: Update Order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
|
|
327
|
+
*/
|
|
328
|
+
orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
|
|
329
|
+
/**
|
|
330
|
+
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
331
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
332
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
333
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
334
|
+
* @name postShipmentHistory
|
|
335
|
+
* @summary:
|
|
336
|
+
* @description: Post shipment history - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
|
|
337
|
+
*/
|
|
338
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
339
|
+
/**
|
|
340
|
+
* @param {OrderPlatformValidator.ProcessManifestParam} arg - Arg object
|
|
341
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
342
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
343
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
|
|
344
|
+
* @name processManifest
|
|
345
|
+
* @summary:
|
|
346
|
+
* @description: Process Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/processManifest/).
|
|
347
|
+
*/
|
|
348
|
+
processManifest({ body, requestHeaders }?: OrderPlatformValidator.ProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
349
|
+
/**
|
|
350
|
+
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
351
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
352
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
353
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
|
|
354
|
+
* @name reassignLocation
|
|
355
|
+
* @summary:
|
|
356
|
+
* @description: Reassign Location - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
|
|
357
|
+
*/
|
|
358
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
|
|
359
|
+
/**
|
|
360
|
+
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
361
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
362
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
363
|
+
* @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
|
|
364
|
+
* @name sendSmsNinja
|
|
365
|
+
* @summary:
|
|
366
|
+
* @description: Send SMS Ninja Panel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
|
|
367
|
+
*/
|
|
368
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
369
|
+
/**
|
|
370
|
+
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
371
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
372
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
373
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
|
|
374
|
+
* @name sendUserMobileOTP
|
|
375
|
+
* @summary:
|
|
376
|
+
* @description: Send User Mobile OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
|
|
377
|
+
*/
|
|
378
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
|
|
379
|
+
/**
|
|
380
|
+
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
381
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
382
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
383
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
|
|
384
|
+
* Success response
|
|
385
|
+
* @name trackShipment
|
|
386
|
+
* @summary: Get courier partner tracking details
|
|
387
|
+
* @description: This endpoint allows users to get courier partner tracking details for a given shipment id or awb no. The service will fetch courier partner statuses that are pushed to oms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
|
|
388
|
+
*/
|
|
389
|
+
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
|
|
390
|
+
/**
|
|
391
|
+
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
392
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
393
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
394
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
395
|
+
* @name updateAddress
|
|
396
|
+
* @summary:
|
|
397
|
+
* @description: Update Address for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
398
|
+
*/
|
|
399
|
+
updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, requestHeaders, }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
400
|
+
/**
|
|
401
|
+
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
402
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
403
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
404
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>}
|
|
405
|
+
* - Success response
|
|
406
|
+
*
|
|
407
|
+
* @name updatePackagingDimensions
|
|
408
|
+
* @summary:
|
|
409
|
+
* @description: Update Packaging Dimensions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
|
|
410
|
+
*/
|
|
411
|
+
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
|
|
412
|
+
/**
|
|
413
|
+
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
414
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
415
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
416
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
|
|
417
|
+
* Success response
|
|
418
|
+
* @name updateShipmentLock
|
|
419
|
+
* @summary:
|
|
420
|
+
* @description: update shipment/bag lock and check status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
421
|
+
*/
|
|
422
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
|
|
423
|
+
/**
|
|
424
|
+
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
425
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
426
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
427
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>}
|
|
428
|
+
* - Success response
|
|
429
|
+
*
|
|
430
|
+
* @name updateShipmentStatus
|
|
431
|
+
* @summary:
|
|
432
|
+
* @description: This API is for Shipment State transition or Shipment data update or both below example is for partial state transition with data update - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
|
|
433
|
+
*/
|
|
434
|
+
updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
|
|
435
|
+
/**
|
|
436
|
+
* @param {OrderPlatformValidator.UpdateShipmentTrackingParam} arg - Arg object
|
|
437
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
438
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
439
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingDetails>} -
|
|
440
|
+
* Success response
|
|
441
|
+
* @name updateShipmentTracking
|
|
442
|
+
* @summary: Post courier partner tracking details
|
|
443
|
+
* @description: This endpoint allows users to post courier partner tracking details for a given shipment id or awb no. The service will add entry for courier partner statuses and will be saved to oms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
|
|
444
|
+
*/
|
|
445
|
+
updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
|
|
446
|
+
/**
|
|
447
|
+
* @param {OrderPlatformValidator.UploadConsentParam} arg - Arg object
|
|
448
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
449
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
450
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
451
|
+
* @name uploadConsent
|
|
452
|
+
* @summary:
|
|
453
|
+
* @description: Upload Consent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsent/).
|
|
454
|
+
*/
|
|
455
|
+
uploadConsent({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
456
|
+
/**
|
|
457
|
+
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
458
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
459
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
460
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
|
|
461
|
+
* @name verifyMobileOTP
|
|
462
|
+
* @summary:
|
|
463
|
+
* @description: Verify Mobile OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
|
|
464
|
+
*/
|
|
465
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;
|
|
587
466
|
}
|
|
467
|
+
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
468
|
+
import OrderPlatformModel = require("./OrderPlatformModel");
|