@gofynd/fdk-client-javascript 1.1.6 → 1.2.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 +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -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 +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -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 +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -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 +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -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 +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -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 +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -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 +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -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 +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -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 +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -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 +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -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 +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -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 +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -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 +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -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 +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -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 +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -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 +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -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 +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- 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 +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -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/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -3,585 +3,372 @@ declare class Order {
|
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
5
|
/**
|
|
6
|
-
* @param {
|
|
7
|
-
* @param {
|
|
8
|
-
* @returns {Promise<AttachOrderUserResponse>} - Success response
|
|
6
|
+
* @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
|
|
7
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
8
|
+
* @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
|
|
9
|
+
* @name attachOrderUser
|
|
9
10
|
* @summary:
|
|
10
|
-
* @description:
|
|
11
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
|
|
11
12
|
*/
|
|
12
|
-
attachOrderUser({ body }?: {
|
|
13
|
-
body: AttachOrderUser;
|
|
14
|
-
}): Promise<AttachOrderUserResponse>;
|
|
13
|
+
attachOrderUser({ body }?: OrderPlatformValidator.AttachOrderUserParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.AttachOrderUserResponse>;
|
|
15
14
|
/**
|
|
16
|
-
* @param {
|
|
17
|
-
* @param {
|
|
18
|
-
* @returns {Promise<OrderStatusResult>} - Success response
|
|
15
|
+
* @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
|
|
16
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
17
|
+
* @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
|
|
18
|
+
* @name checkOrderStatus
|
|
19
19
|
* @summary:
|
|
20
|
-
* @description:
|
|
20
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
|
|
21
21
|
*/
|
|
22
|
-
checkOrderStatus({ body }?: {
|
|
23
|
-
body: OrderStatus;
|
|
24
|
-
}): Promise<OrderStatusResult>;
|
|
22
|
+
checkOrderStatus({ body }?: OrderPlatformValidator.CheckOrderStatusParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
25
23
|
/**
|
|
26
|
-
* @param {
|
|
27
|
-
* @param {
|
|
28
|
-
* @
|
|
29
|
-
* @
|
|
30
|
-
* @param {string} [arg.callerId] - Caller Id
|
|
31
|
-
* @param {string} [arg.method] - Provider Method to Call
|
|
32
|
-
* @returns {Promise<Click2CallResponse>} - Success response
|
|
24
|
+
* @param {OrderPlatformValidator.Click2CallParam} arg - Arg object
|
|
25
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
|
+
* @returns {Promise<OrderPlatformModel.Click2CallResponse>} - Success response
|
|
27
|
+
* @name click2Call
|
|
33
28
|
* @summary:
|
|
34
|
-
* @description:
|
|
29
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/click2Call/).
|
|
35
30
|
*/
|
|
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>;
|
|
31
|
+
click2Call({ caller, receiver, bagId, callerId, method }?: OrderPlatformValidator.Click2CallParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.Click2CallResponse>;
|
|
43
32
|
/**
|
|
44
|
-
* @param {
|
|
45
|
-
* @param {
|
|
46
|
-
* @returns {Promise<CreateChannelConfigResponse>} -
|
|
33
|
+
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
34
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
35
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponse>} -
|
|
36
|
+
* Success response
|
|
37
|
+
* @name createChannelConfig
|
|
47
38
|
* @summary:
|
|
48
|
-
* @description: createChannelConfig
|
|
39
|
+
* @description: createChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
49
40
|
*/
|
|
50
|
-
createChannelConfig({ body }?: {
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
* @
|
|
55
|
-
* @
|
|
56
|
-
* @
|
|
41
|
+
createChannelConfig({ body }?: OrderPlatformValidator.CreateChannelConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.CreateChannelConfigResponse>;
|
|
42
|
+
/**
|
|
43
|
+
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
44
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
45
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
|
|
46
|
+
* @name createOrder
|
|
47
|
+
* @summary:
|
|
48
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
49
|
+
*/
|
|
50
|
+
createOrder({ body }?: OrderPlatformValidator.CreateOrderParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
51
|
+
/**
|
|
52
|
+
* @param {OrderPlatformValidator.DispatchManifestParam} arg - Arg object
|
|
53
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
55
|
+
* @name dispatchManifest
|
|
56
|
+
* @summary:
|
|
57
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifest/).
|
|
58
|
+
*/
|
|
59
|
+
dispatchManifest({ body }?: OrderPlatformValidator.DispatchManifestParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.SuccessResponse>;
|
|
60
|
+
/**
|
|
61
|
+
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
62
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
63
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
64
|
+
* @name downloadBulkActionTemplate
|
|
65
|
+
* @summary:
|
|
66
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
|
|
67
|
+
*/
|
|
68
|
+
downloadBulkActionTemplate({ templateSlug }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.FileResponse>;
|
|
69
|
+
/**
|
|
70
|
+
* @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
|
|
71
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
|
+
* @returns {Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>}
|
|
73
|
+
* - Success response
|
|
74
|
+
*
|
|
75
|
+
* @name fetchCreditBalanceDetail
|
|
76
|
+
* @summary:
|
|
77
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
|
|
78
|
+
*/
|
|
79
|
+
fetchCreditBalanceDetail({ body }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
|
|
80
|
+
/**
|
|
81
|
+
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
82
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
83
|
+
* @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
|
|
84
|
+
* Success response
|
|
85
|
+
* @name fetchRefundModeConfig
|
|
86
|
+
* @summary:
|
|
87
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
|
|
88
|
+
*/
|
|
89
|
+
fetchRefundModeConfig({ body }?: OrderPlatformValidator.FetchRefundModeConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
|
|
90
|
+
/**
|
|
91
|
+
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
92
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
93
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
|
|
94
|
+
* Success response
|
|
95
|
+
* @name generatePOSReceiptByOrderId
|
|
96
|
+
* @summary:
|
|
97
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
|
|
98
|
+
*/
|
|
99
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
|
|
100
|
+
/**
|
|
101
|
+
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
102
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
|
|
104
|
+
* @name getAnnouncements
|
|
105
|
+
* @summary:
|
|
106
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
|
|
107
|
+
*/
|
|
108
|
+
getAnnouncements({ date }?: OrderPlatformValidator.GetAnnouncementsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.AnnouncementsResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
111
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
112
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
|
|
113
|
+
* Success response
|
|
114
|
+
* @name getBagById
|
|
115
|
+
* @summary:
|
|
116
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
117
|
+
*/
|
|
118
|
+
getBagById({ bagId, channelBagId, channelId }?: OrderPlatformValidator.GetBagByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
121
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
122
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
|
|
123
|
+
* @name getBags
|
|
124
|
+
* @summary:
|
|
125
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
|
|
126
|
+
*/
|
|
127
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, }?: OrderPlatformValidator.GetBagsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
|
|
128
|
+
/**
|
|
129
|
+
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
130
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
131
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
|
|
132
|
+
* Success response
|
|
133
|
+
* @name getBulkActionTemplate
|
|
134
|
+
* @summary:
|
|
135
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
|
|
136
|
+
*/
|
|
137
|
+
getBulkActionTemplate({ headers }?: any): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
|
|
138
|
+
/**
|
|
139
|
+
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
140
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
141
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
142
|
+
* @name getBulkShipmentExcelFile
|
|
143
|
+
* @summary:
|
|
144
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
145
|
+
*/
|
|
146
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, fromDate, toDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.FileResponse>;
|
|
147
|
+
/**
|
|
148
|
+
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
149
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
151
|
+
* @name getChannelConfig
|
|
152
|
+
* @summary:
|
|
153
|
+
* @description: getChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
154
|
+
*/
|
|
155
|
+
getChannelConfig({ headers }?: any): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
156
|
+
/**
|
|
157
|
+
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
158
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
159
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
|
|
160
|
+
* @name getLaneConfig
|
|
161
|
+
* @summary:
|
|
162
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
163
|
+
*/
|
|
164
|
+
getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, }?: OrderPlatformValidator.GetLaneConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.LaneConfigResponse>;
|
|
165
|
+
/**
|
|
166
|
+
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
167
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
168
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
|
|
169
|
+
* @name getOrderById
|
|
170
|
+
* @summary:
|
|
171
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
172
|
+
*/
|
|
173
|
+
getOrderById({ orderId }?: OrderPlatformValidator.GetOrderByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
174
|
+
/**
|
|
175
|
+
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
176
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
177
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
|
|
178
|
+
* @name getOrders
|
|
179
|
+
* @summary:
|
|
180
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
181
|
+
*/
|
|
182
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, }?: OrderPlatformValidator.GetOrdersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.OrderListingResponse>;
|
|
183
|
+
/**
|
|
184
|
+
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
185
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
186
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
|
|
187
|
+
* @name getRoleBasedActions
|
|
57
188
|
* @summary:
|
|
58
|
-
* @description:
|
|
189
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
|
|
59
190
|
*/
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
* @
|
|
65
|
-
* @
|
|
66
|
-
* @
|
|
67
|
-
* @
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
* @
|
|
75
|
-
* @
|
|
76
|
-
* @
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
* @
|
|
85
|
-
* @param {FetchCreditBalanceRequestPayload} arg.body
|
|
86
|
-
* @returns {Promise<FetchCreditBalanceResponsePayload>} - Success response
|
|
87
|
-
* @summary:
|
|
88
|
-
* @description:
|
|
89
|
-
*/
|
|
90
|
-
fetchCreditBalanceDetail({ body }?: {
|
|
91
|
-
body: FetchCreditBalanceRequestPayload;
|
|
92
|
-
}): Promise<FetchCreditBalanceResponsePayload>;
|
|
93
|
-
/**
|
|
94
|
-
* @param {Object} arg - Arg object.
|
|
95
|
-
* @param {RefundModeConfigRequestPayload} arg.body
|
|
96
|
-
* @returns {Promise<RefundModeConfigResponsePayload>} - Success response
|
|
97
|
-
* @summary:
|
|
98
|
-
* @description:
|
|
99
|
-
*/
|
|
100
|
-
fetchRefundModeConfig({ body }?: {
|
|
101
|
-
body: RefundModeConfigRequestPayload;
|
|
102
|
-
}): Promise<RefundModeConfigResponsePayload>;
|
|
103
|
-
/**
|
|
104
|
-
* @param {Object} arg - Arg object.
|
|
105
|
-
* @param {string} arg.orderId -
|
|
106
|
-
* @param {string} [arg.shipmentId] -
|
|
107
|
-
* @param {string} [arg.documentType] -
|
|
108
|
-
* @returns {Promise<GeneratePosOrderReceiptResponse>} - Success response
|
|
109
|
-
* @summary:
|
|
110
|
-
* @description:
|
|
111
|
-
*/
|
|
112
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, }?: {
|
|
113
|
-
orderId: string;
|
|
114
|
-
shipmentId?: string;
|
|
115
|
-
documentType?: string;
|
|
116
|
-
}): Promise<GeneratePosOrderReceiptResponse>;
|
|
117
|
-
/**
|
|
118
|
-
* @param {Object} arg - Arg object.
|
|
119
|
-
* @param {string} [arg.date] - Date On which the announcement is Active
|
|
120
|
-
* (Date should in ISO Datetime format IST Time)
|
|
121
|
-
* @returns {Promise<AnnouncementsResponse>} - Success response
|
|
122
|
-
* @summary:
|
|
123
|
-
* @description:
|
|
124
|
-
*/
|
|
125
|
-
getAnnouncements({ date }?: {
|
|
126
|
-
date?: string;
|
|
127
|
-
}): Promise<AnnouncementsResponse>;
|
|
128
|
-
/**
|
|
129
|
-
* @param {Object} arg - Arg object.
|
|
130
|
-
* @param {string} [arg.bagId] - Id of bag
|
|
131
|
-
* @param {string} [arg.channelBagId] - Id of application bag
|
|
132
|
-
* @param {string} [arg.channelId] - Id of application
|
|
133
|
-
* @returns {Promise<BagDetailsPlatformResponse>} - Success response
|
|
134
|
-
* @summary:
|
|
135
|
-
* @description:
|
|
136
|
-
*/
|
|
137
|
-
getBagById({ bagId, channelBagId, channelId }?: {
|
|
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
|
|
191
|
+
getRoleBasedActions({ headers }?: any): Promise<OrderPlatformModel.GetActionsResponse>;
|
|
192
|
+
/**
|
|
193
|
+
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
194
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
195
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
|
|
196
|
+
* @name getShipmentById
|
|
197
|
+
* @summary:
|
|
198
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
199
|
+
*/
|
|
200
|
+
getShipmentById({ channelShipmentId, shipmentId }?: OrderPlatformValidator.GetShipmentByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.ShipmentInfoResponse>;
|
|
201
|
+
/**
|
|
202
|
+
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
203
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
204
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
205
|
+
* @name getShipmentHistory
|
|
206
|
+
* @summary:
|
|
207
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
208
|
+
*/
|
|
209
|
+
getShipmentHistory({ shipmentId, bagId }?: OrderPlatformValidator.GetShipmentHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
210
|
+
/**
|
|
211
|
+
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
212
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
213
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
|
|
214
|
+
* Success response
|
|
215
|
+
* @name getShipmentReasons
|
|
351
216
|
* @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 {
|
|
368
|
-
* @param {
|
|
369
|
-
* @
|
|
370
|
-
* @
|
|
371
|
-
* @
|
|
372
|
-
* @
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
* @param {
|
|
377
|
-
* @param {
|
|
378
|
-
* @
|
|
379
|
-
* @
|
|
380
|
-
* @
|
|
381
|
-
* @
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
* @param {
|
|
386
|
-
* @
|
|
387
|
-
* @
|
|
388
|
-
*
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
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>;
|
|
217
|
+
* @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/).
|
|
218
|
+
*/
|
|
219
|
+
getShipmentReasons({ shipmentId, bagId, state }?: OrderPlatformValidator.GetShipmentReasonsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
|
|
220
|
+
/**
|
|
221
|
+
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
222
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
223
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
|
|
224
|
+
* - Success response
|
|
225
|
+
*
|
|
226
|
+
* @name getShipments
|
|
227
|
+
* @summary:
|
|
228
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
229
|
+
*/
|
|
230
|
+
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, }?: OrderPlatformValidator.GetShipmentsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
|
|
231
|
+
/**
|
|
232
|
+
* @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
|
|
233
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
234
|
+
* @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
|
|
235
|
+
* @name getStateTransitionMap
|
|
236
|
+
* @summary:
|
|
237
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
|
|
238
|
+
*/
|
|
239
|
+
getStateTransitionMap({ headers }?: any): Promise<OrderPlatformModel.BagStateTransitionMap>;
|
|
240
|
+
/**
|
|
241
|
+
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
242
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
243
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
|
|
244
|
+
* @name getfilters
|
|
245
|
+
* @summary:
|
|
246
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
247
|
+
*/
|
|
248
|
+
getfilters({ view, groupEntity }?: OrderPlatformValidator.GetfiltersParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.FiltersResponse>;
|
|
249
|
+
/**
|
|
250
|
+
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
251
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
252
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
|
|
253
|
+
* Success response
|
|
254
|
+
* @name invalidateShipmentCache
|
|
255
|
+
* @summary:
|
|
256
|
+
* @description: Invalidate shipment Cache - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
|
|
257
|
+
*/
|
|
258
|
+
invalidateShipmentCache({ body }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
|
|
259
|
+
/**
|
|
260
|
+
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
261
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
|
+
* @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
|
|
263
|
+
* @name orderUpdate
|
|
264
|
+
* @summary:
|
|
265
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
|
|
266
|
+
*/
|
|
267
|
+
orderUpdate({ body }?: OrderPlatformValidator.OrderUpdateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.ResponseDetail>;
|
|
505
268
|
/**
|
|
506
|
-
* @param {
|
|
507
|
-
* @param {
|
|
508
|
-
* @
|
|
509
|
-
* @
|
|
510
|
-
* @param {string} [arg.addressType] -
|
|
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
|
|
269
|
+
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
270
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
271
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
272
|
+
* @name postShipmentHistory
|
|
520
273
|
* @summary:
|
|
521
|
-
* @description:
|
|
274
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
|
|
522
275
|
*/
|
|
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>;
|
|
276
|
+
postShipmentHistory({ body }?: OrderPlatformValidator.PostShipmentHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
537
277
|
/**
|
|
538
|
-
* @param {
|
|
539
|
-
* @param {
|
|
540
|
-
* @returns {Promise<
|
|
278
|
+
* @param {OrderPlatformValidator.ProcessManifestParam} arg - Arg object
|
|
279
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
|
|
281
|
+
* @name processManifest
|
|
541
282
|
* @summary:
|
|
542
|
-
* @description:
|
|
283
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/processManifest/).
|
|
543
284
|
*/
|
|
544
|
-
|
|
545
|
-
body: UpdatePackagingDimensionsPayload;
|
|
546
|
-
}): Promise<UpdatePackagingDimensionsResponse>;
|
|
285
|
+
processManifest({ body }?: OrderPlatformValidator.ProcessManifestParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
547
286
|
/**
|
|
548
|
-
* @param {
|
|
549
|
-
* @param {
|
|
550
|
-
* @returns {Promise<
|
|
287
|
+
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
288
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
289
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
|
|
290
|
+
* @name reassignLocation
|
|
551
291
|
* @summary:
|
|
552
|
-
* @description:
|
|
292
|
+
* @description: Reassign Location - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
|
|
553
293
|
*/
|
|
554
|
-
|
|
555
|
-
body: UpdateShipmentLockPayload;
|
|
556
|
-
}): Promise<UpdateShipmentLockResponse>;
|
|
294
|
+
reassignLocation({ body }?: OrderPlatformValidator.ReassignLocationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.StoreReassignResponse>;
|
|
557
295
|
/**
|
|
558
|
-
* @param {
|
|
559
|
-
* @param {
|
|
560
|
-
* @returns {Promise<
|
|
296
|
+
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
297
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
298
|
+
* @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
|
|
299
|
+
* @name sendSmsNinja
|
|
561
300
|
* @summary:
|
|
562
|
-
* @description:
|
|
563
|
-
*/
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
* @
|
|
569
|
-
* @
|
|
570
|
-
* @
|
|
571
|
-
* @
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
* @
|
|
579
|
-
* @
|
|
580
|
-
* @
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
301
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
|
|
302
|
+
*/
|
|
303
|
+
sendSmsNinja({ body }?: OrderPlatformValidator.SendSmsNinjaParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
304
|
+
/**
|
|
305
|
+
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
306
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
307
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
|
|
308
|
+
* @name sendUserMobileOTP
|
|
309
|
+
* @summary:
|
|
310
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
|
|
311
|
+
*/
|
|
312
|
+
sendUserMobileOTP({ body }?: OrderPlatformValidator.SendUserMobileOTPParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
|
|
313
|
+
/**
|
|
314
|
+
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
315
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
316
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
317
|
+
* @name updateAddress
|
|
318
|
+
* @summary:
|
|
319
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
320
|
+
*/
|
|
321
|
+
updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, }?: OrderPlatformValidator.UpdateAddressParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.BaseResponse>;
|
|
322
|
+
/**
|
|
323
|
+
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
324
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
325
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>}
|
|
326
|
+
* - Success response
|
|
327
|
+
*
|
|
328
|
+
* @name updatePackagingDimensions
|
|
329
|
+
* @summary:
|
|
330
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
|
|
331
|
+
*/
|
|
332
|
+
updatePackagingDimensions({ body }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
|
|
333
|
+
/**
|
|
334
|
+
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
335
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
|
|
337
|
+
* Success response
|
|
338
|
+
* @name updateShipmentLock
|
|
339
|
+
* @summary:
|
|
340
|
+
* @description: update shipment/bag lock and check status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
341
|
+
*/
|
|
342
|
+
updateShipmentLock({ body }?: OrderPlatformValidator.UpdateShipmentLockParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
|
|
343
|
+
/**
|
|
344
|
+
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
345
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>}
|
|
347
|
+
* - Success response
|
|
348
|
+
*
|
|
349
|
+
* @name updateShipmentStatus
|
|
350
|
+
* @summary:
|
|
351
|
+
* @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/).
|
|
352
|
+
*/
|
|
353
|
+
updateShipmentStatus({ body }?: OrderPlatformValidator.UpdateShipmentStatusParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
|
|
354
|
+
/**
|
|
355
|
+
* @param {OrderPlatformValidator.UploadConsentParam} arg - Arg object
|
|
356
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
357
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
358
|
+
* @name uploadConsent
|
|
359
|
+
* @summary:
|
|
360
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsent/).
|
|
361
|
+
*/
|
|
362
|
+
uploadConsent({ body }?: OrderPlatformValidator.UploadConsentParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.SuccessResponse>;
|
|
363
|
+
/**
|
|
364
|
+
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
365
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
366
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
|
|
367
|
+
* @name verifyMobileOTP
|
|
368
|
+
* @summary:
|
|
369
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
|
|
370
|
+
*/
|
|
371
|
+
verifyMobileOTP({ body }?: OrderPlatformValidator.VerifyMobileOTPParam, { headers }?: import("../PlatformAPIClient").Options): Promise<OrderPlatformModel.VerifyOtpResponse>;
|
|
587
372
|
}
|
|
373
|
+
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
374
|
+
import OrderPlatformModel = require("./OrderPlatformModel");
|