@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.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 +1 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -6,50 +6,52 @@ declare class Discount {
|
|
|
6
6
|
* @param {DiscountPlatformValidator.CancelDownloadJobParam} arg - Arg object
|
|
7
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
9
|
+
* @returns {Promise<DiscountPlatformModel.CancelJobResponseSchema>} -
|
|
10
|
+
* Success response
|
|
10
11
|
* @name cancelDownloadJob
|
|
11
|
-
* @summary:
|
|
12
|
-
* @description: Cancel download
|
|
12
|
+
* @summary: delete discount download job
|
|
13
|
+
* @description: Cancel a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelDownloadJob/).
|
|
13
14
|
*/
|
|
14
|
-
cancelDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.
|
|
15
|
+
cancelDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponseSchema>;
|
|
15
16
|
/**
|
|
16
17
|
* @param {DiscountPlatformValidator.CancelValidationJobParam} arg - Arg object
|
|
17
18
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
20
|
+
* @returns {Promise<DiscountPlatformModel.CancelJobResponseSchema>} -
|
|
21
|
+
* Success response
|
|
20
22
|
* @name cancelValidationJob
|
|
21
|
-
* @summary:
|
|
22
|
-
* @description:
|
|
23
|
+
* @summary: deletel validation job discount
|
|
24
|
+
* @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
|
|
23
25
|
*/
|
|
24
|
-
cancelValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.
|
|
26
|
+
cancelValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.CancelValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.CancelJobResponseSchema>;
|
|
25
27
|
/**
|
|
26
28
|
* @param {DiscountPlatformValidator.CreateDiscountParam} arg - Arg object
|
|
27
29
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
30
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
31
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
30
32
|
* @name createDiscount
|
|
31
|
-
* @summary: Create discount
|
|
32
|
-
* @description:
|
|
33
|
+
* @summary: Create discount
|
|
34
|
+
* @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
|
|
33
35
|
*/
|
|
34
36
|
createDiscount({ body, requestHeaders }?: DiscountPlatformValidator.CreateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
35
37
|
/**
|
|
36
38
|
* @param {DiscountPlatformValidator.DownloadDiscountFileParam} arg - Arg object
|
|
37
39
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
40
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
41
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
40
42
|
* @name downloadDiscountFile
|
|
41
|
-
* @summary:
|
|
42
|
-
* @description:
|
|
43
|
+
* @summary: Get discount file
|
|
44
|
+
* @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
|
|
43
45
|
*/
|
|
44
|
-
downloadDiscountFile({ type, body, requestHeaders }?: DiscountPlatformValidator.DownloadDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.
|
|
46
|
+
downloadDiscountFile({ type, body, requestHeaders }?: DiscountPlatformValidator.DownloadDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
45
47
|
/**
|
|
46
48
|
* @param {DiscountPlatformValidator.GetDiscountParam} arg - Arg object
|
|
47
49
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
50
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
51
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
50
52
|
* @name getDiscount
|
|
51
|
-
* @summary: Get discount
|
|
52
|
-
* @description: Retrieve
|
|
53
|
+
* @summary: Get discount
|
|
54
|
+
* @description: Retrieve a single discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
|
|
53
55
|
*/
|
|
54
56
|
getDiscount({ id, requestHeaders }?: DiscountPlatformValidator.GetDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
55
57
|
/**
|
|
@@ -58,24 +60,32 @@ declare class Discount {
|
|
|
58
60
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
61
|
* @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
|
|
60
62
|
* @name getDiscounts
|
|
61
|
-
* @summary:
|
|
62
|
-
* @description: Retrieve a list of
|
|
63
|
+
* @summary: List discounts
|
|
64
|
+
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
|
|
63
65
|
*/
|
|
64
66
|
getDiscounts({ view, q, pageNo, pageSize, archived, month, year, type, appIds, requestHeaders, }?: DiscountPlatformValidator.GetDiscountsParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.ListOrCalender>;
|
|
65
67
|
/**
|
|
66
68
|
* @param {Object} arg - Arg object.
|
|
67
|
-
* @param {string} [arg.view] -
|
|
69
|
+
* @param {string} [arg.view] - Specifies the format in which the discounts
|
|
70
|
+
* are displayed. Options are 'listing' for a list view or 'calendar' for
|
|
71
|
+
* a calendar view. Defaults to 'listing'.
|
|
68
72
|
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
69
73
|
* complete name of a discount.
|
|
70
|
-
* @param {number} [arg.pageSize] -
|
|
71
|
-
*
|
|
72
|
-
* @param {
|
|
73
|
-
*
|
|
74
|
-
* @param {
|
|
75
|
-
*
|
|
74
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
75
|
+
* page. Default is 12.
|
|
76
|
+
* @param {boolean} [arg.archived] - Indicates whether to include expired
|
|
77
|
+
* discounts in the results. Defaults to false.
|
|
78
|
+
* @param {number} [arg.month] - The month for which discounts is requested.
|
|
79
|
+
* Defaults to the current month if not specified.
|
|
80
|
+
* @param {number} [arg.year] - The year for which discounts is requested.
|
|
81
|
+
* Defaults to the current year if not specified.
|
|
82
|
+
* @param {string} [arg.type] - Specifies the type of disocunt to list,
|
|
83
|
+
* either 'basic' or 'custom'.
|
|
84
|
+
* @param {string[]} [arg.appIds] - A `application_id` is a unique
|
|
85
|
+
* identifier for a particular sales channel.
|
|
76
86
|
* @returns {Paginator<DiscountPlatformModel.ListOrCalender>}
|
|
77
|
-
* @summary:
|
|
78
|
-
* @description: Retrieve a list of
|
|
87
|
+
* @summary: List discounts
|
|
88
|
+
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount
|
|
79
89
|
*/
|
|
80
90
|
getDiscountsPaginator({ view, q, pageSize, archived, month, year, type, appIds, }?: {
|
|
81
91
|
view?: string;
|
|
@@ -91,30 +101,30 @@ declare class Discount {
|
|
|
91
101
|
* @param {DiscountPlatformValidator.GetDownloadJobParam} arg - Arg object
|
|
92
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
93
103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
94
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
104
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
95
105
|
* @name getDownloadJob
|
|
96
|
-
* @summary:
|
|
97
|
-
* @description:
|
|
106
|
+
* @summary: List discount download job
|
|
107
|
+
* @description: Retrieve a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
|
|
98
108
|
*/
|
|
99
|
-
getDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.GetDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.
|
|
109
|
+
getDownloadJob({ id, requestHeaders }?: DiscountPlatformValidator.GetDownloadJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
100
110
|
/**
|
|
101
111
|
* @param {DiscountPlatformValidator.GetValidationJobParam} arg - Arg object
|
|
102
112
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
113
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
114
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
105
115
|
* @name getValidationJob
|
|
106
|
-
* @summary:
|
|
107
|
-
* @description:
|
|
116
|
+
* @summary: List validation job discount
|
|
117
|
+
* @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
|
|
108
118
|
*/
|
|
109
|
-
getValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.GetValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.
|
|
119
|
+
getValidationJob({ id, requestHeaders }?: DiscountPlatformValidator.GetValidationJobParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
110
120
|
/**
|
|
111
121
|
* @param {DiscountPlatformValidator.UpdateDiscountParam} arg - Arg object
|
|
112
122
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
113
123
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
114
124
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
115
125
|
* @name updateDiscount
|
|
116
|
-
* @summary: Update discount
|
|
117
|
-
* @description:
|
|
126
|
+
* @summary: Update discount
|
|
127
|
+
* @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
|
|
118
128
|
*/
|
|
119
129
|
updateDiscount({ id, body, requestHeaders }?: DiscountPlatformValidator.UpdateDiscountParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.DiscountJob>;
|
|
120
130
|
/**
|
|
@@ -123,20 +133,20 @@ declare class Discount {
|
|
|
123
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
134
|
* @returns {Promise<Object>} - Success response
|
|
125
135
|
* @name upsertDiscountItems
|
|
126
|
-
* @summary: Upsert discount items
|
|
127
|
-
* @description:
|
|
136
|
+
* @summary: Upsert discount items
|
|
137
|
+
* @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
|
|
128
138
|
*/
|
|
129
139
|
upsertDiscountItems({ id, body, requestHeaders }?: DiscountPlatformValidator.UpsertDiscountItemsParam, { responseHeaders }?: object): Promise<any>;
|
|
130
140
|
/**
|
|
131
141
|
* @param {DiscountPlatformValidator.ValidateDiscountFileParam} arg - Arg object
|
|
132
142
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
133
143
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
134
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
144
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
135
145
|
* @name validateDiscountFile
|
|
136
|
-
* @summary: Validate discount file
|
|
137
|
-
* @description:
|
|
146
|
+
* @summary: Validate discount file
|
|
147
|
+
* @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
|
|
138
148
|
*/
|
|
139
|
-
validateDiscountFile({ body, discount, requestHeaders }?: DiscountPlatformValidator.ValidateDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.
|
|
149
|
+
validateDiscountFile({ body, discount, requestHeaders }?: DiscountPlatformValidator.ValidateDiscountFileParam, { responseHeaders }?: object): Promise<DiscountPlatformModel.FileJobResponseSchema>;
|
|
140
150
|
}
|
|
141
151
|
import DiscountPlatformValidator = require("./DiscountPlatformValidator");
|
|
142
152
|
import DiscountPlatformModel = require("./DiscountPlatformModel");
|
|
@@ -18,10 +18,11 @@ class Discount {
|
|
|
18
18
|
* @param {DiscountPlatformValidator.CancelDownloadJobParam} arg - Arg object
|
|
19
19
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
21
|
+
* @returns {Promise<DiscountPlatformModel.CancelJobResponseSchema>} -
|
|
22
|
+
* Success response
|
|
22
23
|
* @name cancelDownloadJob
|
|
23
|
-
* @summary:
|
|
24
|
-
* @description: Cancel download
|
|
24
|
+
* @summary: delete discount download job
|
|
25
|
+
* @description: Cancel a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelDownloadJob/).
|
|
25
26
|
*/
|
|
26
27
|
async cancelDownloadJob(
|
|
27
28
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -74,7 +75,7 @@ class Discount {
|
|
|
74
75
|
|
|
75
76
|
const {
|
|
76
77
|
error: res_error,
|
|
77
|
-
} = DiscountPlatformModel.
|
|
78
|
+
} = DiscountPlatformModel.CancelJobResponseSchema().validate(responseData, {
|
|
78
79
|
abortEarly: false,
|
|
79
80
|
allowUnknown: true,
|
|
80
81
|
});
|
|
@@ -97,10 +98,11 @@ class Discount {
|
|
|
97
98
|
* @param {DiscountPlatformValidator.CancelValidationJobParam} arg - Arg object
|
|
98
99
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
101
|
+
* @returns {Promise<DiscountPlatformModel.CancelJobResponseSchema>} -
|
|
102
|
+
* Success response
|
|
101
103
|
* @name cancelValidationJob
|
|
102
|
-
* @summary:
|
|
103
|
-
* @description:
|
|
104
|
+
* @summary: deletel validation job discount
|
|
105
|
+
* @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
|
|
104
106
|
*/
|
|
105
107
|
async cancelValidationJob(
|
|
106
108
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -153,7 +155,7 @@ class Discount {
|
|
|
153
155
|
|
|
154
156
|
const {
|
|
155
157
|
error: res_error,
|
|
156
|
-
} = DiscountPlatformModel.
|
|
158
|
+
} = DiscountPlatformModel.CancelJobResponseSchema().validate(responseData, {
|
|
157
159
|
abortEarly: false,
|
|
158
160
|
allowUnknown: true,
|
|
159
161
|
});
|
|
@@ -178,8 +180,8 @@ class Discount {
|
|
|
178
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
181
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
180
182
|
* @name createDiscount
|
|
181
|
-
* @summary: Create discount
|
|
182
|
-
* @description:
|
|
183
|
+
* @summary: Create discount
|
|
184
|
+
* @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
|
|
183
185
|
*/
|
|
184
186
|
async createDiscount(
|
|
185
187
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -255,10 +257,10 @@ class Discount {
|
|
|
255
257
|
* @param {DiscountPlatformValidator.DownloadDiscountFileParam} arg - Arg object
|
|
256
258
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
259
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
260
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
259
261
|
* @name downloadDiscountFile
|
|
260
|
-
* @summary:
|
|
261
|
-
* @description:
|
|
262
|
+
* @summary: Get discount file
|
|
263
|
+
* @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
|
|
262
264
|
*/
|
|
263
265
|
async downloadDiscountFile(
|
|
264
266
|
{ type, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -313,7 +315,7 @@ class Discount {
|
|
|
313
315
|
|
|
314
316
|
const {
|
|
315
317
|
error: res_error,
|
|
316
|
-
} = DiscountPlatformModel.
|
|
318
|
+
} = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
|
|
317
319
|
abortEarly: false,
|
|
318
320
|
allowUnknown: true,
|
|
319
321
|
});
|
|
@@ -338,8 +340,8 @@ class Discount {
|
|
|
338
340
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
341
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
340
342
|
* @name getDiscount
|
|
341
|
-
* @summary: Get discount
|
|
342
|
-
* @description: Retrieve
|
|
343
|
+
* @summary: Get discount
|
|
344
|
+
* @description: Retrieve a single discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
|
|
343
345
|
*/
|
|
344
346
|
async getDiscount(
|
|
345
347
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -417,8 +419,8 @@ class Discount {
|
|
|
417
419
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
418
420
|
* @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
|
|
419
421
|
* @name getDiscounts
|
|
420
|
-
* @summary:
|
|
421
|
-
* @description: Retrieve a list of
|
|
422
|
+
* @summary: List discounts
|
|
423
|
+
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
|
|
422
424
|
*/
|
|
423
425
|
async getDiscounts(
|
|
424
426
|
{
|
|
@@ -528,18 +530,26 @@ class Discount {
|
|
|
528
530
|
|
|
529
531
|
/**
|
|
530
532
|
* @param {Object} arg - Arg object.
|
|
531
|
-
* @param {string} [arg.view] -
|
|
533
|
+
* @param {string} [arg.view] - Specifies the format in which the discounts
|
|
534
|
+
* are displayed. Options are 'listing' for a list view or 'calendar' for
|
|
535
|
+
* a calendar view. Defaults to 'listing'.
|
|
532
536
|
* @param {string} [arg.q] - The search query. This can be a partial or
|
|
533
537
|
* complete name of a discount.
|
|
534
|
-
* @param {number} [arg.pageSize] -
|
|
535
|
-
*
|
|
536
|
-
* @param {
|
|
537
|
-
*
|
|
538
|
-
* @param {
|
|
539
|
-
*
|
|
538
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
539
|
+
* page. Default is 12.
|
|
540
|
+
* @param {boolean} [arg.archived] - Indicates whether to include expired
|
|
541
|
+
* discounts in the results. Defaults to false.
|
|
542
|
+
* @param {number} [arg.month] - The month for which discounts is requested.
|
|
543
|
+
* Defaults to the current month if not specified.
|
|
544
|
+
* @param {number} [arg.year] - The year for which discounts is requested.
|
|
545
|
+
* Defaults to the current year if not specified.
|
|
546
|
+
* @param {string} [arg.type] - Specifies the type of disocunt to list,
|
|
547
|
+
* either 'basic' or 'custom'.
|
|
548
|
+
* @param {string[]} [arg.appIds] - A `application_id` is a unique
|
|
549
|
+
* identifier for a particular sales channel.
|
|
540
550
|
* @returns {Paginator<DiscountPlatformModel.ListOrCalender>}
|
|
541
|
-
* @summary:
|
|
542
|
-
* @description: Retrieve a list of
|
|
551
|
+
* @summary: List discounts
|
|
552
|
+
* @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount
|
|
543
553
|
*/
|
|
544
554
|
getDiscountsPaginator({
|
|
545
555
|
view,
|
|
@@ -581,10 +591,10 @@ class Discount {
|
|
|
581
591
|
* @param {DiscountPlatformValidator.GetDownloadJobParam} arg - Arg object
|
|
582
592
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
583
593
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
584
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
594
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
585
595
|
* @name getDownloadJob
|
|
586
|
-
* @summary:
|
|
587
|
-
* @description:
|
|
596
|
+
* @summary: List discount download job
|
|
597
|
+
* @description: Retrieve a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
|
|
588
598
|
*/
|
|
589
599
|
async getDownloadJob(
|
|
590
600
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -637,7 +647,7 @@ class Discount {
|
|
|
637
647
|
|
|
638
648
|
const {
|
|
639
649
|
error: res_error,
|
|
640
|
-
} = DiscountPlatformModel.
|
|
650
|
+
} = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
|
|
641
651
|
abortEarly: false,
|
|
642
652
|
allowUnknown: true,
|
|
643
653
|
});
|
|
@@ -660,10 +670,10 @@ class Discount {
|
|
|
660
670
|
* @param {DiscountPlatformValidator.GetValidationJobParam} arg - Arg object
|
|
661
671
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
662
672
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
663
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
673
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
664
674
|
* @name getValidationJob
|
|
665
|
-
* @summary:
|
|
666
|
-
* @description:
|
|
675
|
+
* @summary: List validation job discount
|
|
676
|
+
* @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
|
|
667
677
|
*/
|
|
668
678
|
async getValidationJob(
|
|
669
679
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -716,7 +726,7 @@ class Discount {
|
|
|
716
726
|
|
|
717
727
|
const {
|
|
718
728
|
error: res_error,
|
|
719
|
-
} = DiscountPlatformModel.
|
|
729
|
+
} = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
|
|
720
730
|
abortEarly: false,
|
|
721
731
|
allowUnknown: true,
|
|
722
732
|
});
|
|
@@ -741,8 +751,8 @@ class Discount {
|
|
|
741
751
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
742
752
|
* @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
|
|
743
753
|
* @name updateDiscount
|
|
744
|
-
* @summary: Update discount
|
|
745
|
-
* @description:
|
|
754
|
+
* @summary: Update discount
|
|
755
|
+
* @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
|
|
746
756
|
*/
|
|
747
757
|
async updateDiscount(
|
|
748
758
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -822,8 +832,8 @@ class Discount {
|
|
|
822
832
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
823
833
|
* @returns {Promise<Object>} - Success response
|
|
824
834
|
* @name upsertDiscountItems
|
|
825
|
-
* @summary: Upsert discount items
|
|
826
|
-
* @description:
|
|
835
|
+
* @summary: Upsert discount items
|
|
836
|
+
* @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
|
|
827
837
|
*/
|
|
828
838
|
async upsertDiscountItems(
|
|
829
839
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -899,10 +909,10 @@ class Discount {
|
|
|
899
909
|
* @param {DiscountPlatformValidator.ValidateDiscountFileParam} arg - Arg object
|
|
900
910
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
901
911
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
902
|
-
* @returns {Promise<DiscountPlatformModel.
|
|
912
|
+
* @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
|
|
903
913
|
* @name validateDiscountFile
|
|
904
|
-
* @summary: Validate discount file
|
|
905
|
-
* @description:
|
|
914
|
+
* @summary: Validate discount file
|
|
915
|
+
* @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
|
|
906
916
|
*/
|
|
907
917
|
async validateDiscountFile(
|
|
908
918
|
{ body, discount, requestHeaders } = { requestHeaders: {} },
|
|
@@ -958,7 +968,7 @@ class Discount {
|
|
|
958
968
|
|
|
959
969
|
const {
|
|
960
970
|
error: res_error,
|
|
961
|
-
} = DiscountPlatformModel.
|
|
971
|
+
} = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
|
|
962
972
|
abortEarly: false,
|
|
963
973
|
allowUnknown: true,
|
|
964
974
|
});
|