@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +108 -1199
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
- package/sdk/application/Content/ContentApplicationClient.js +43 -1065
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +157 -30
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- 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 +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5060 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1985 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +178 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +122 -191
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
- package/sdk/platform/Content/ContentPlatformModel.js +514 -487
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +424 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
- package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +145 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- 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 +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +132 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- 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/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +795 -7
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- 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 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -4,21 +4,26 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* @typedef BulkServiceabilityParam
|
|
7
|
-
* @property {string} extensionId - Unique Identifier of
|
|
8
|
-
* @property {string} schemeId - Unique identifier of
|
|
9
|
-
* @property {ServiceabilityPlatformModel.
|
|
7
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
8
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
9
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
|
|
10
10
|
*/
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
13
|
* @typedef BulkTatParam
|
|
14
|
-
* @property {string} extensionId - Unique Identifier of
|
|
15
|
-
* @property {string} schemeId - Unique identifier of
|
|
16
|
-
* @property {ServiceabilityPlatformModel.
|
|
14
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
15
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
16
|
+
* @property {ServiceabilityPlatformModel.BulkRegionJobDetails} body
|
|
17
17
|
*/
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
20
|
* @typedef CreateCourierPartnerAccountParam
|
|
21
|
-
* @property {ServiceabilityPlatformModel.
|
|
21
|
+
* @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* @typedef CreateCourierPartnerSchemeParam
|
|
26
|
+
* @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
|
|
22
27
|
*/
|
|
23
28
|
|
|
24
29
|
/**
|
|
@@ -40,8 +45,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
40
45
|
|
|
41
46
|
/**
|
|
42
47
|
* @typedef GetBulkServiceabilityParam
|
|
43
|
-
* @property {string} extensionId - Unique Identifier of
|
|
44
|
-
* @property {string} schemeId - Unique identifier of
|
|
48
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
49
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
45
50
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
46
51
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
47
52
|
* @property {string} [batchId] - Unique identifier of bulk job
|
|
@@ -55,8 +60,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
55
60
|
|
|
56
61
|
/**
|
|
57
62
|
* @typedef GetBulkTatParam
|
|
58
|
-
* @property {string} extensionId - Unique Identifier of
|
|
59
|
-
* @property {string} schemeId - Unique identifier of
|
|
63
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
64
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
60
65
|
* @property {number} [pageNo] - Index of the item to start returning with
|
|
61
66
|
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
62
67
|
* @property {string} [batchId] - Unique identifier of bulk job
|
|
@@ -70,9 +75,19 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
70
75
|
|
|
71
76
|
/** @typedef GetCompanyConfigurationParam */
|
|
72
77
|
|
|
78
|
+
/**
|
|
79
|
+
* @typedef GetCountriesParam
|
|
80
|
+
* @property {boolean} [onboarding] - Only fetch countries which allowed for
|
|
81
|
+
* onboard on Platform.
|
|
82
|
+
* @property {number} [pageNo] - Page number.
|
|
83
|
+
* @property {number} [pageSize] - Page size.
|
|
84
|
+
* @property {string} [q] - Search.
|
|
85
|
+
* @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
|
|
86
|
+
*/
|
|
87
|
+
|
|
73
88
|
/**
|
|
74
89
|
* @typedef GetCourierPartnerAccountParam
|
|
75
|
-
* @property {string} accountId - Unique ID of courier account
|
|
90
|
+
* @property {string} accountId - Unique ID of courier partner account
|
|
76
91
|
*/
|
|
77
92
|
|
|
78
93
|
/**
|
|
@@ -84,9 +99,25 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
84
99
|
* @property {string} [transportType] - Filters dp accounts based on transport_type
|
|
85
100
|
*/
|
|
86
101
|
|
|
102
|
+
/**
|
|
103
|
+
* @typedef GetCourierPartnerSchemeParam
|
|
104
|
+
* @property {string} schemeId - Unique Identifier of Scheme
|
|
105
|
+
*/
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* @typedef GetCourierPartnerSchemesParam
|
|
109
|
+
* @property {string} [schemeType] - Indicates whether a scheme is created by an
|
|
110
|
+
* admin for global purposes or customized for a specific company.
|
|
111
|
+
* @property {string} [paymentMode] - Indicates payment mode for a scheme.
|
|
112
|
+
* @property {string[]} [capabilities] - Indicates whether the scheme possesses
|
|
113
|
+
* certain capabilities.
|
|
114
|
+
* @property {string[]} [schemeIds] - List of scheme ids which need to be
|
|
115
|
+
* returned in the response.
|
|
116
|
+
*/
|
|
117
|
+
|
|
87
118
|
/**
|
|
88
119
|
* @typedef GetOptimalLocationsParam
|
|
89
|
-
* @property {ServiceabilityPlatformModel.
|
|
120
|
+
* @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
|
|
90
121
|
*/
|
|
91
122
|
|
|
92
123
|
/**
|
|
@@ -113,14 +144,20 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
113
144
|
|
|
114
145
|
/**
|
|
115
146
|
* @typedef GetPackageMaterialsParam
|
|
116
|
-
* @property {string} packageMaterialId -
|
|
117
|
-
|
|
147
|
+
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
148
|
+
*/
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* @typedef GetSampleFileServiceabilityStatusParam
|
|
152
|
+
* @property {number} [pageNo] - Index of the item to start returning with
|
|
153
|
+
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
154
|
+
* @property {string} [batchId] - Batch id of the execution
|
|
118
155
|
*/
|
|
119
156
|
|
|
120
157
|
/**
|
|
121
158
|
* @typedef GetServiceabilityParam
|
|
122
|
-
* @property {string} extensionId - Unique Identifier of
|
|
123
|
-
* @property {string} schemeId - Unique identifier of
|
|
159
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
160
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
124
161
|
* @property {string} regionId - Unique identifier of a region
|
|
125
162
|
*/
|
|
126
163
|
|
|
@@ -143,6 +180,11 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
143
180
|
* @property {string} [sector] - Sector value to search zones
|
|
144
181
|
*/
|
|
145
182
|
|
|
183
|
+
/**
|
|
184
|
+
* @typedef SampleFileServiceabilityParam
|
|
185
|
+
* @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
|
|
186
|
+
*/
|
|
187
|
+
|
|
146
188
|
/**
|
|
147
189
|
* @typedef UpdateCompanyConfigurationParam
|
|
148
190
|
* @property {ServiceabilityPlatformModel.CompanyConfig} body
|
|
@@ -150,8 +192,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
150
192
|
|
|
151
193
|
/**
|
|
152
194
|
* @typedef UpdateCourierPartnerAccountParam
|
|
153
|
-
* @property {string} accountId - Unique ID of courier account
|
|
154
|
-
* @property {ServiceabilityPlatformModel.
|
|
195
|
+
* @property {string} accountId - Unique ID of courier partner account
|
|
196
|
+
* @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
|
|
197
|
+
*/
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* @typedef UpdateCourierPartnerSchemeParam
|
|
201
|
+
* @property {string} schemeId - Unique Identifier of Scheme
|
|
202
|
+
* @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
|
|
155
203
|
*/
|
|
156
204
|
|
|
157
205
|
/**
|
|
@@ -163,15 +211,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
163
211
|
|
|
164
212
|
/**
|
|
165
213
|
* @typedef UpdatePackageMaterialsParam
|
|
166
|
-
* @property {string} packageMaterialId -
|
|
167
|
-
* identifier for a Package Material
|
|
214
|
+
* @property {string} packageMaterialId - Unique identifier for a Package. Material
|
|
168
215
|
* @property {ServiceabilityPlatformModel.PackageMaterial} body
|
|
169
216
|
*/
|
|
170
217
|
|
|
171
218
|
/**
|
|
172
219
|
* @typedef UpdateServiceabilityParam
|
|
173
|
-
* @property {string} extensionId - Unique Identifier of
|
|
174
|
-
* @property {string} schemeId - Unique identifier of
|
|
220
|
+
* @property {string} extensionId - Unique Identifier of courier partner extension.
|
|
221
|
+
* @property {string} schemeId - Unique identifier of courier partner scheme.
|
|
175
222
|
* @property {string} regionId - Unique identifier of a region
|
|
176
223
|
* @property {ServiceabilityPlatformModel.ServiceabilityModel} body
|
|
177
224
|
*/
|
|
@@ -188,7 +235,7 @@ class ServiceabilityPlatformValidator {
|
|
|
188
235
|
return Joi.object({
|
|
189
236
|
extensionId: Joi.string().allow("").required(),
|
|
190
237
|
schemeId: Joi.string().allow("").required(),
|
|
191
|
-
body: ServiceabilityPlatformModel.
|
|
238
|
+
body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
|
|
192
239
|
}).required();
|
|
193
240
|
}
|
|
194
241
|
|
|
@@ -197,14 +244,21 @@ class ServiceabilityPlatformValidator {
|
|
|
197
244
|
return Joi.object({
|
|
198
245
|
extensionId: Joi.string().allow("").required(),
|
|
199
246
|
schemeId: Joi.string().allow("").required(),
|
|
200
|
-
body: ServiceabilityPlatformModel.
|
|
247
|
+
body: ServiceabilityPlatformModel.BulkRegionJobDetails().required(),
|
|
201
248
|
}).required();
|
|
202
249
|
}
|
|
203
250
|
|
|
204
251
|
/** @returns {CreateCourierPartnerAccountParam} */
|
|
205
252
|
static createCourierPartnerAccount() {
|
|
206
253
|
return Joi.object({
|
|
207
|
-
body: ServiceabilityPlatformModel.
|
|
254
|
+
body: ServiceabilityPlatformModel.CourierAccountDetailsBody().required(),
|
|
255
|
+
}).required();
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
/** @returns {CreateCourierPartnerSchemeParam} */
|
|
259
|
+
static createCourierPartnerScheme() {
|
|
260
|
+
return Joi.object({
|
|
261
|
+
body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel().required(),
|
|
208
262
|
}).required();
|
|
209
263
|
}
|
|
210
264
|
|
|
@@ -273,6 +327,17 @@ class ServiceabilityPlatformValidator {
|
|
|
273
327
|
return Joi.object({}).required();
|
|
274
328
|
}
|
|
275
329
|
|
|
330
|
+
/** @returns {GetCountriesParam} */
|
|
331
|
+
static getCountries() {
|
|
332
|
+
return Joi.object({
|
|
333
|
+
onboarding: Joi.boolean(),
|
|
334
|
+
pageNo: Joi.number(),
|
|
335
|
+
pageSize: Joi.number(),
|
|
336
|
+
q: Joi.string().allow(""),
|
|
337
|
+
hierarchy: Joi.string().allow(""),
|
|
338
|
+
}).required();
|
|
339
|
+
}
|
|
340
|
+
|
|
276
341
|
/** @returns {GetCourierPartnerAccountParam} */
|
|
277
342
|
static getCourierPartnerAccount() {
|
|
278
343
|
return Joi.object({
|
|
@@ -291,10 +356,27 @@ class ServiceabilityPlatformValidator {
|
|
|
291
356
|
}).required();
|
|
292
357
|
}
|
|
293
358
|
|
|
359
|
+
/** @returns {GetCourierPartnerSchemeParam} */
|
|
360
|
+
static getCourierPartnerScheme() {
|
|
361
|
+
return Joi.object({
|
|
362
|
+
schemeId: Joi.string().allow("").required(),
|
|
363
|
+
}).required();
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
/** @returns {GetCourierPartnerSchemesParam} */
|
|
367
|
+
static getCourierPartnerSchemes() {
|
|
368
|
+
return Joi.object({
|
|
369
|
+
schemeType: Joi.string().allow(""),
|
|
370
|
+
paymentMode: Joi.string().allow(""),
|
|
371
|
+
capabilities: Joi.array().items(Joi.string().allow("")),
|
|
372
|
+
schemeIds: Joi.array().items(Joi.string().allow("")),
|
|
373
|
+
}).required();
|
|
374
|
+
}
|
|
375
|
+
|
|
294
376
|
/** @returns {GetOptimalLocationsParam} */
|
|
295
377
|
static getOptimalLocations() {
|
|
296
378
|
return Joi.object({
|
|
297
|
-
body: ServiceabilityPlatformModel.
|
|
379
|
+
body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema().required(),
|
|
298
380
|
}).required();
|
|
299
381
|
}
|
|
300
382
|
|
|
@@ -332,6 +414,15 @@ class ServiceabilityPlatformValidator {
|
|
|
332
414
|
}).required();
|
|
333
415
|
}
|
|
334
416
|
|
|
417
|
+
/** @returns {GetSampleFileServiceabilityStatusParam} */
|
|
418
|
+
static getSampleFileServiceabilityStatus() {
|
|
419
|
+
return Joi.object({
|
|
420
|
+
pageNo: Joi.number(),
|
|
421
|
+
pageSize: Joi.number(),
|
|
422
|
+
batchId: Joi.string().allow(""),
|
|
423
|
+
}).required();
|
|
424
|
+
}
|
|
425
|
+
|
|
335
426
|
/** @returns {GetServiceabilityParam} */
|
|
336
427
|
static getServiceability() {
|
|
337
428
|
return Joi.object({
|
|
@@ -364,6 +455,13 @@ class ServiceabilityPlatformValidator {
|
|
|
364
455
|
}).required();
|
|
365
456
|
}
|
|
366
457
|
|
|
458
|
+
/** @returns {SampleFileServiceabilityParam} */
|
|
459
|
+
static sampleFileServiceability() {
|
|
460
|
+
return Joi.object({
|
|
461
|
+
body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails().required(),
|
|
462
|
+
}).required();
|
|
463
|
+
}
|
|
464
|
+
|
|
367
465
|
/** @returns {UpdateCompanyConfigurationParam} */
|
|
368
466
|
static updateCompanyConfiguration() {
|
|
369
467
|
return Joi.object({
|
|
@@ -375,7 +473,15 @@ class ServiceabilityPlatformValidator {
|
|
|
375
473
|
static updateCourierPartnerAccount() {
|
|
376
474
|
return Joi.object({
|
|
377
475
|
accountId: Joi.string().allow("").required(),
|
|
378
|
-
body: ServiceabilityPlatformModel.
|
|
476
|
+
body: ServiceabilityPlatformModel.CourierAccountUpdateDetails().required(),
|
|
477
|
+
}).required();
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
/** @returns {UpdateCourierPartnerSchemeParam} */
|
|
481
|
+
static updateCourierPartnerScheme() {
|
|
482
|
+
return Joi.object({
|
|
483
|
+
schemeId: Joi.string().allow("").required(),
|
|
484
|
+
body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails().required(),
|
|
379
485
|
}).required();
|
|
380
486
|
}
|
|
381
487
|
|
|
@@ -29,12 +29,12 @@ declare class Share {
|
|
|
29
29
|
*
|
|
30
30
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
31
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
|
-
* @returns {Promise<SharePlatformModel.
|
|
32
|
+
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
33
33
|
* @name getShortLinkClickStats
|
|
34
34
|
* @summary: Get short link click statistics
|
|
35
35
|
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
|
|
36
36
|
*/
|
|
37
|
-
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.
|
|
37
|
+
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResult>;
|
|
38
38
|
/**
|
|
39
39
|
* @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
|
|
40
40
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -179,7 +179,7 @@ class Share {
|
|
|
179
179
|
*
|
|
180
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
|
-
* @returns {Promise<SharePlatformModel.
|
|
182
|
+
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
183
183
|
* @name getShortLinkClickStats
|
|
184
184
|
* @summary: Get short link click statistics
|
|
185
185
|
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
|
|
@@ -232,7 +232,7 @@ class Share {
|
|
|
232
232
|
|
|
233
233
|
const {
|
|
234
234
|
error: res_error,
|
|
235
|
-
} = SharePlatformModel.
|
|
235
|
+
} = SharePlatformModel.ClickStatsResult().validate(responseData, {
|
|
236
236
|
abortEarly: false,
|
|
237
237
|
allowUnknown: true,
|
|
238
238
|
});
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = SharePlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef ClickStatsResult
|
|
4
4
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
5
5
|
* the short link.
|
|
6
6
|
*/
|
|
@@ -55,12 +55,24 @@ export = SharePlatformModel;
|
|
|
55
55
|
* @property {Attribution} [attribution]
|
|
56
56
|
* @property {SocialMediaTags} [social_media_tags]
|
|
57
57
|
* @property {number} [count]
|
|
58
|
+
* @property {shortLinkReqMeta} [meta]
|
|
59
|
+
*/
|
|
60
|
+
/**
|
|
61
|
+
* @typedef shortLinkReqMeta
|
|
62
|
+
* @property {boolean} [for_sms] - For_sms flag specifies that the short-link
|
|
63
|
+
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
64
|
+
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
65
|
+
* @property {string} [sms_header] - This field is used to override the sms
|
|
66
|
+
* header to be used to generate a short-link for SMS communication in
|
|
67
|
+
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
68
|
+
* for_sms flag set to true.
|
|
58
69
|
*/
|
|
59
70
|
/**
|
|
60
71
|
* @typedef UrlInfo
|
|
61
72
|
* @property {string} [original]
|
|
62
73
|
* @property {string} [hash]
|
|
63
74
|
* @property {string} [short_url]
|
|
75
|
+
* @property {string} [alias]
|
|
64
76
|
*/
|
|
65
77
|
/**
|
|
66
78
|
* @typedef ShortLinkRes
|
|
@@ -107,11 +119,11 @@ export = SharePlatformModel;
|
|
|
107
119
|
declare class SharePlatformModel {
|
|
108
120
|
}
|
|
109
121
|
declare namespace SharePlatformModel {
|
|
110
|
-
export {
|
|
122
|
+
export { ClickStatsResult, ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, shortLinkReqMeta, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
|
|
111
123
|
}
|
|
112
|
-
/** @returns {
|
|
113
|
-
declare function
|
|
114
|
-
type
|
|
124
|
+
/** @returns {ClickStatsResult} */
|
|
125
|
+
declare function ClickStatsResult(): ClickStatsResult;
|
|
126
|
+
type ClickStatsResult = {
|
|
115
127
|
/**
|
|
116
128
|
* - An array of click statistics for
|
|
117
129
|
* the short link.
|
|
@@ -192,6 +204,24 @@ type ShortLinkReq = {
|
|
|
192
204
|
attribution?: Attribution;
|
|
193
205
|
social_media_tags?: SocialMediaTags;
|
|
194
206
|
count?: number;
|
|
207
|
+
meta?: shortLinkReqMeta;
|
|
208
|
+
};
|
|
209
|
+
/** @returns {shortLinkReqMeta} */
|
|
210
|
+
declare function shortLinkReqMeta(): shortLinkReqMeta;
|
|
211
|
+
type shortLinkReqMeta = {
|
|
212
|
+
/**
|
|
213
|
+
* - For_sms flag specifies that the short-link
|
|
214
|
+
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
215
|
+
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
216
|
+
*/
|
|
217
|
+
for_sms?: boolean;
|
|
218
|
+
/**
|
|
219
|
+
* - This field is used to override the sms
|
|
220
|
+
* header to be used to generate a short-link for SMS communication in
|
|
221
|
+
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
222
|
+
* for_sms flag set to true.
|
|
223
|
+
*/
|
|
224
|
+
sms_header?: string;
|
|
195
225
|
};
|
|
196
226
|
/** @returns {UrlInfo} */
|
|
197
227
|
declare function UrlInfo(): UrlInfo;
|
|
@@ -199,6 +229,7 @@ type UrlInfo = {
|
|
|
199
229
|
original?: string;
|
|
200
230
|
hash?: string;
|
|
201
231
|
short_url?: string;
|
|
232
|
+
alias?: string;
|
|
202
233
|
};
|
|
203
234
|
/** @returns {ShortLinkRes} */
|
|
204
235
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef ClickStatsResult
|
|
5
5
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
6
6
|
* the short link.
|
|
7
7
|
*/
|
|
@@ -64,6 +64,18 @@ const Joi = require("joi");
|
|
|
64
64
|
* @property {Attribution} [attribution]
|
|
65
65
|
* @property {SocialMediaTags} [social_media_tags]
|
|
66
66
|
* @property {number} [count]
|
|
67
|
+
* @property {shortLinkReqMeta} [meta]
|
|
68
|
+
*/
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* @typedef shortLinkReqMeta
|
|
72
|
+
* @property {boolean} [for_sms] - For_sms flag specifies that the short-link
|
|
73
|
+
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
74
|
+
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
75
|
+
* @property {string} [sms_header] - This field is used to override the sms
|
|
76
|
+
* header to be used to generate a short-link for SMS communication in
|
|
77
|
+
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
78
|
+
* for_sms flag set to true.
|
|
67
79
|
*/
|
|
68
80
|
|
|
69
81
|
/**
|
|
@@ -71,6 +83,7 @@ const Joi = require("joi");
|
|
|
71
83
|
* @property {string} [original]
|
|
72
84
|
* @property {string} [hash]
|
|
73
85
|
* @property {string} [short_url]
|
|
86
|
+
* @property {string} [alias]
|
|
74
87
|
*/
|
|
75
88
|
|
|
76
89
|
/**
|
|
@@ -120,8 +133,8 @@ const Joi = require("joi");
|
|
|
120
133
|
*/
|
|
121
134
|
|
|
122
135
|
class SharePlatformModel {
|
|
123
|
-
/** @returns {
|
|
124
|
-
static
|
|
136
|
+
/** @returns {ClickStatsResult} */
|
|
137
|
+
static ClickStatsResult() {
|
|
125
138
|
return Joi.object({
|
|
126
139
|
click_stats: Joi.array()
|
|
127
140
|
.items(SharePlatformModel.ClickStatsItem())
|
|
@@ -202,6 +215,15 @@ class SharePlatformModel {
|
|
|
202
215
|
attribution: SharePlatformModel.Attribution(),
|
|
203
216
|
social_media_tags: SharePlatformModel.SocialMediaTags(),
|
|
204
217
|
count: Joi.number(),
|
|
218
|
+
meta: SharePlatformModel.shortLinkReqMeta(),
|
|
219
|
+
});
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/** @returns {shortLinkReqMeta} */
|
|
223
|
+
static shortLinkReqMeta() {
|
|
224
|
+
return Joi.object({
|
|
225
|
+
for_sms: Joi.boolean(),
|
|
226
|
+
sms_header: Joi.string().allow(""),
|
|
205
227
|
});
|
|
206
228
|
}
|
|
207
229
|
|
|
@@ -211,6 +233,7 @@ class SharePlatformModel {
|
|
|
211
233
|
original: Joi.string().allow(""),
|
|
212
234
|
hash: Joi.string().allow(""),
|
|
213
235
|
short_url: Joi.string().allow(""),
|
|
236
|
+
alias: Joi.string().allow(""),
|
|
214
237
|
});
|
|
215
238
|
}
|
|
216
239
|
|
|
@@ -229,7 +252,7 @@ class SharePlatformModel {
|
|
|
229
252
|
application: Joi.string().allow(""),
|
|
230
253
|
user_id: Joi.string().allow(""),
|
|
231
254
|
created_at: Joi.string().allow(""),
|
|
232
|
-
meta: Joi.any(),
|
|
255
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
233
256
|
updated_at: Joi.string().allow(""),
|
|
234
257
|
personalized: Joi.boolean(),
|
|
235
258
|
campaign: SharePlatformModel.CampaignShortLink(),
|
|
@@ -177,12 +177,12 @@ declare class Theme {
|
|
|
177
177
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
178
178
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ThemePlatformModel.
|
|
180
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
181
181
|
* @name isUpgradable
|
|
182
182
|
* @summary: Check theme is upgradable
|
|
183
183
|
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
184
184
|
*/
|
|
185
|
-
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.
|
|
185
|
+
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
|
|
186
186
|
/**
|
|
187
187
|
* @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
|
|
188
188
|
* - Arg object
|
|
@@ -204,7 +204,7 @@ declare class Theme {
|
|
|
204
204
|
* @summary: Update a page
|
|
205
205
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
206
206
|
*/
|
|
207
|
-
updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
207
|
+
updatePage({ themeId, pageValue, socketId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
208
208
|
/**
|
|
209
209
|
* @param {ThemePlatformApplicationValidator.UpdateThemeParam} arg - Arg object
|
|
210
210
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1260,7 +1260,7 @@ class Theme {
|
|
|
1260
1260
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
1261
1261
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1262
1262
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1263
|
-
* @returns {Promise<ThemePlatformModel.
|
|
1263
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
1264
1264
|
* @name isUpgradable
|
|
1265
1265
|
* @summary: Check theme is upgradable
|
|
1266
1266
|
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
@@ -1314,7 +1314,7 @@ class Theme {
|
|
|
1314
1314
|
|
|
1315
1315
|
const {
|
|
1316
1316
|
error: res_error,
|
|
1317
|
-
} = ThemePlatformModel.
|
|
1317
|
+
} = ThemePlatformModel.ThemeUpgradable().validate(responseData, {
|
|
1318
1318
|
abortEarly: false,
|
|
1319
1319
|
allowUnknown: true,
|
|
1320
1320
|
});
|
|
@@ -1426,13 +1426,16 @@ class Theme {
|
|
|
1426
1426
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
1427
1427
|
*/
|
|
1428
1428
|
async updatePage(
|
|
1429
|
-
{ themeId, pageValue, body, requestHeaders } = {
|
|
1429
|
+
{ themeId, pageValue, socketId, body, requestHeaders } = {
|
|
1430
|
+
requestHeaders: {},
|
|
1431
|
+
},
|
|
1430
1432
|
{ responseHeaders } = { responseHeaders: false }
|
|
1431
1433
|
) {
|
|
1432
1434
|
const { error } = ThemePlatformApplicationValidator.updatePage().validate(
|
|
1433
1435
|
{
|
|
1434
1436
|
themeId,
|
|
1435
1437
|
pageValue,
|
|
1438
|
+
socketId,
|
|
1436
1439
|
body,
|
|
1437
1440
|
},
|
|
1438
1441
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -1448,6 +1451,7 @@ class Theme {
|
|
|
1448
1451
|
{
|
|
1449
1452
|
themeId,
|
|
1450
1453
|
pageValue,
|
|
1454
|
+
socketId,
|
|
1451
1455
|
body,
|
|
1452
1456
|
},
|
|
1453
1457
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -1464,7 +1468,7 @@ class Theme {
|
|
|
1464
1468
|
const response = await PlatformAPIClient.execute(
|
|
1465
1469
|
this.config,
|
|
1466
1470
|
"put",
|
|
1467
|
-
`/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/${themeId}/${pageValue}`,
|
|
1471
|
+
`/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/${themeId}/${pageValue}/${socketId}`,
|
|
1468
1472
|
query_params,
|
|
1469
1473
|
body,
|
|
1470
1474
|
requestHeaders,
|
|
@@ -68,6 +68,7 @@ export = ThemePlatformApplicationValidator;
|
|
|
68
68
|
* @typedef UpdatePageParam
|
|
69
69
|
* @property {string} themeId - ID of the theme
|
|
70
70
|
* @property {string} pageValue - Value of the page to be updated
|
|
71
|
+
* @property {string} socketId - Unique socket id for websocket
|
|
71
72
|
* @property {ThemePlatformModel.AvailablePageSchema} body
|
|
72
73
|
*/
|
|
73
74
|
/**
|
|
@@ -237,6 +238,10 @@ type UpdatePageParam = {
|
|
|
237
238
|
* - Value of the page to be updated
|
|
238
239
|
*/
|
|
239
240
|
pageValue: string;
|
|
241
|
+
/**
|
|
242
|
+
* - Unique socket id for websocket
|
|
243
|
+
*/
|
|
244
|
+
socketId: string;
|
|
240
245
|
body: ThemePlatformModel.AvailablePageSchema;
|
|
241
246
|
};
|
|
242
247
|
type UpdateThemeParam = {
|
|
@@ -89,6 +89,7 @@ const ThemePlatformModel = require("./ThemePlatformModel");
|
|
|
89
89
|
* @typedef UpdatePageParam
|
|
90
90
|
* @property {string} themeId - ID of the theme
|
|
91
91
|
* @property {string} pageValue - Value of the page to be updated
|
|
92
|
+
* @property {string} socketId - Unique socket id for websocket
|
|
92
93
|
* @property {ThemePlatformModel.AvailablePageSchema} body
|
|
93
94
|
*/
|
|
94
95
|
|
|
@@ -238,6 +239,7 @@ class ThemePlatformApplicationValidator {
|
|
|
238
239
|
return Joi.object({
|
|
239
240
|
themeId: Joi.string().allow("").required(),
|
|
240
241
|
pageValue: Joi.string().allow("").required(),
|
|
242
|
+
socketId: Joi.string().allow("").required(),
|
|
241
243
|
body: ThemePlatformModel.AvailablePageSchema().required(),
|
|
242
244
|
}).required();
|
|
243
245
|
}
|