@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
|
@@ -21,7 +21,7 @@ class Share {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
23
23
|
* @name createShortLink
|
|
24
|
-
* @summary: Create short link
|
|
24
|
+
* @summary: Create short link
|
|
25
25
|
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
|
|
26
26
|
*/
|
|
27
27
|
async createShortLink(
|
|
@@ -61,7 +61,7 @@ class Share {
|
|
|
61
61
|
const response = await PlatformAPIClient.execute(
|
|
62
62
|
this.config,
|
|
63
63
|
"post",
|
|
64
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link
|
|
64
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
|
|
65
65
|
query_params,
|
|
66
66
|
body,
|
|
67
67
|
requestHeaders,
|
|
@@ -100,7 +100,7 @@ class Share {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
102
102
|
* @name getShortLinkByHash
|
|
103
|
-
* @summary: Get short link by hash
|
|
103
|
+
* @summary: Get short link by hash
|
|
104
104
|
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
|
|
105
105
|
*/
|
|
106
106
|
async getShortLinkByHash(
|
|
@@ -140,7 +140,7 @@ class Share {
|
|
|
140
140
|
const response = await PlatformAPIClient.execute(
|
|
141
141
|
this.config,
|
|
142
142
|
"get",
|
|
143
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}
|
|
143
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
|
|
144
144
|
query_params,
|
|
145
145
|
undefined,
|
|
146
146
|
requestHeaders,
|
|
@@ -173,13 +173,91 @@ class Share {
|
|
|
173
173
|
return response;
|
|
174
174
|
}
|
|
175
175
|
|
|
176
|
+
/**
|
|
177
|
+
* @param {SharePlatformApplicationValidator.GetShortLinkClickStatsParam} arg
|
|
178
|
+
* - Arg object
|
|
179
|
+
*
|
|
180
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
|
+
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
183
|
+
* @name getShortLinkClickStats
|
|
184
|
+
* @summary: Get short link click statistics
|
|
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/).
|
|
186
|
+
*/
|
|
187
|
+
async getShortLinkClickStats(
|
|
188
|
+
{ surlId, requestHeaders } = { requestHeaders: {} },
|
|
189
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
190
|
+
) {
|
|
191
|
+
const {
|
|
192
|
+
error,
|
|
193
|
+
} = SharePlatformApplicationValidator.getShortLinkClickStats().validate(
|
|
194
|
+
{ surlId },
|
|
195
|
+
{ abortEarly: false, allowUnknown: true }
|
|
196
|
+
);
|
|
197
|
+
if (error) {
|
|
198
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
// Showing warrnings if extra unknown parameters are found
|
|
202
|
+
const {
|
|
203
|
+
error: warrning,
|
|
204
|
+
} = SharePlatformApplicationValidator.getShortLinkClickStats().validate(
|
|
205
|
+
{ surlId },
|
|
206
|
+
{ abortEarly: false, allowUnknown: false }
|
|
207
|
+
);
|
|
208
|
+
if (warrning) {
|
|
209
|
+
Logger({
|
|
210
|
+
level: "WARN",
|
|
211
|
+
message: `Parameter Validation warrnings for platform > Share > getShortLinkClickStats \n ${warrning}`,
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
const query_params = {};
|
|
216
|
+
query_params["surl_id"] = surlId;
|
|
217
|
+
|
|
218
|
+
const response = await PlatformAPIClient.execute(
|
|
219
|
+
this.config,
|
|
220
|
+
"get",
|
|
221
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/click-stats`,
|
|
222
|
+
query_params,
|
|
223
|
+
undefined,
|
|
224
|
+
requestHeaders,
|
|
225
|
+
{ responseHeaders }
|
|
226
|
+
);
|
|
227
|
+
|
|
228
|
+
let responseData = response;
|
|
229
|
+
if (responseHeaders) {
|
|
230
|
+
responseData = response[0];
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
const {
|
|
234
|
+
error: res_error,
|
|
235
|
+
} = SharePlatformModel.ClickStatsResult().validate(responseData, {
|
|
236
|
+
abortEarly: false,
|
|
237
|
+
allowUnknown: true,
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
if (res_error) {
|
|
241
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
242
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
243
|
+
} else {
|
|
244
|
+
Logger({
|
|
245
|
+
level: "WARN",
|
|
246
|
+
message: `Response Validation Warnings for platform > Share > getShortLinkClickStats \n ${res_error}`,
|
|
247
|
+
});
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
return response;
|
|
252
|
+
}
|
|
253
|
+
|
|
176
254
|
/**
|
|
177
255
|
* @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
|
|
178
256
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
258
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
181
259
|
* @name getShortLinks
|
|
182
|
-
* @summary: Get short links
|
|
260
|
+
* @summary: Get short links
|
|
183
261
|
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
184
262
|
*/
|
|
185
263
|
async getShortLinks(
|
|
@@ -247,7 +325,7 @@ class Share {
|
|
|
247
325
|
const response = await PlatformAPIClient.execute(
|
|
248
326
|
this.config,
|
|
249
327
|
"get",
|
|
250
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link
|
|
328
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
|
|
251
329
|
query_params,
|
|
252
330
|
undefined,
|
|
253
331
|
requestHeaders,
|
|
@@ -288,7 +366,7 @@ class Share {
|
|
|
288
366
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
289
367
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
290
368
|
* @name updateShortLinkById
|
|
291
|
-
* @summary: Update short link
|
|
369
|
+
* @summary: Update short link
|
|
292
370
|
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
|
|
293
371
|
*/
|
|
294
372
|
async updateShortLinkById(
|
|
@@ -330,7 +408,7 @@ class Share {
|
|
|
330
408
|
const response = await PlatformAPIClient.execute(
|
|
331
409
|
this.config,
|
|
332
410
|
"patch",
|
|
333
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}
|
|
411
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
|
|
334
412
|
query_params,
|
|
335
413
|
body,
|
|
336
414
|
requestHeaders,
|
|
@@ -5,12 +5,17 @@ export = SharePlatformApplicationValidator;
|
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
7
7
|
* @typedef GetShortLinkByHashParam
|
|
8
|
-
* @property {string} hash
|
|
8
|
+
* @property {string} hash - Hash of short url
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* @typedef GetShortLinkClickStatsParam
|
|
12
|
+
* @property {string} surlId - Short link ID for which click statistics are to
|
|
13
|
+
* be retrieved.
|
|
9
14
|
*/
|
|
10
15
|
/**
|
|
11
16
|
* @typedef GetShortLinksParam
|
|
12
17
|
* @property {number} [pageNo] - Current page number
|
|
13
|
-
* @property {number} [pageSize] -
|
|
18
|
+
* @property {number} [pageSize] - Current page size
|
|
14
19
|
* @property {string} [createdBy] - Short link creator
|
|
15
20
|
* @property {string} [active] - Short link active status
|
|
16
21
|
* @property {string} [shortUrl] - Search for short url
|
|
@@ -19,7 +24,7 @@ export = SharePlatformApplicationValidator;
|
|
|
19
24
|
*/
|
|
20
25
|
/**
|
|
21
26
|
* @typedef UpdateShortLinkByIdParam
|
|
22
|
-
* @property {string} id -
|
|
27
|
+
* @property {string} id - Short link document identifier
|
|
23
28
|
* @property {SharePlatformModel.ShortLinkReq} body
|
|
24
29
|
*/
|
|
25
30
|
declare class SharePlatformApplicationValidator {
|
|
@@ -27,27 +32,39 @@ declare class SharePlatformApplicationValidator {
|
|
|
27
32
|
static createShortLink(): CreateShortLinkParam;
|
|
28
33
|
/** @returns {GetShortLinkByHashParam} */
|
|
29
34
|
static getShortLinkByHash(): GetShortLinkByHashParam;
|
|
35
|
+
/** @returns {GetShortLinkClickStatsParam} */
|
|
36
|
+
static getShortLinkClickStats(): GetShortLinkClickStatsParam;
|
|
30
37
|
/** @returns {GetShortLinksParam} */
|
|
31
38
|
static getShortLinks(): GetShortLinksParam;
|
|
32
39
|
/** @returns {UpdateShortLinkByIdParam} */
|
|
33
40
|
static updateShortLinkById(): UpdateShortLinkByIdParam;
|
|
34
41
|
}
|
|
35
42
|
declare namespace SharePlatformApplicationValidator {
|
|
36
|
-
export { CreateShortLinkParam, GetShortLinkByHashParam, GetShortLinksParam, UpdateShortLinkByIdParam };
|
|
43
|
+
export { CreateShortLinkParam, GetShortLinkByHashParam, GetShortLinkClickStatsParam, GetShortLinksParam, UpdateShortLinkByIdParam };
|
|
37
44
|
}
|
|
38
45
|
type CreateShortLinkParam = {
|
|
39
46
|
body: SharePlatformModel.ShortLinkReq;
|
|
40
47
|
};
|
|
41
48
|
type GetShortLinkByHashParam = {
|
|
49
|
+
/**
|
|
50
|
+
* - Hash of short url
|
|
51
|
+
*/
|
|
42
52
|
hash: string;
|
|
43
53
|
};
|
|
54
|
+
type GetShortLinkClickStatsParam = {
|
|
55
|
+
/**
|
|
56
|
+
* - Short link ID for which click statistics are to
|
|
57
|
+
* be retrieved.
|
|
58
|
+
*/
|
|
59
|
+
surlId: string;
|
|
60
|
+
};
|
|
44
61
|
type GetShortLinksParam = {
|
|
45
62
|
/**
|
|
46
63
|
* - Current page number
|
|
47
64
|
*/
|
|
48
65
|
pageNo?: number;
|
|
49
66
|
/**
|
|
50
|
-
* -
|
|
67
|
+
* - Current page size
|
|
51
68
|
*/
|
|
52
69
|
pageSize?: number;
|
|
53
70
|
/**
|
|
@@ -73,7 +90,7 @@ type GetShortLinksParam = {
|
|
|
73
90
|
};
|
|
74
91
|
type UpdateShortLinkByIdParam = {
|
|
75
92
|
/**
|
|
76
|
-
* -
|
|
93
|
+
* - Short link document identifier
|
|
77
94
|
*/
|
|
78
95
|
id: string;
|
|
79
96
|
body: SharePlatformModel.ShortLinkReq;
|
|
@@ -9,13 +9,19 @@ const SharePlatformModel = require("./SharePlatformModel");
|
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
11
|
* @typedef GetShortLinkByHashParam
|
|
12
|
-
* @property {string} hash
|
|
12
|
+
* @property {string} hash - Hash of short url
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @typedef GetShortLinkClickStatsParam
|
|
17
|
+
* @property {string} surlId - Short link ID for which click statistics are to
|
|
18
|
+
* be retrieved.
|
|
13
19
|
*/
|
|
14
20
|
|
|
15
21
|
/**
|
|
16
22
|
* @typedef GetShortLinksParam
|
|
17
23
|
* @property {number} [pageNo] - Current page number
|
|
18
|
-
* @property {number} [pageSize] -
|
|
24
|
+
* @property {number} [pageSize] - Current page size
|
|
19
25
|
* @property {string} [createdBy] - Short link creator
|
|
20
26
|
* @property {string} [active] - Short link active status
|
|
21
27
|
* @property {string} [shortUrl] - Search for short url
|
|
@@ -25,7 +31,7 @@ const SharePlatformModel = require("./SharePlatformModel");
|
|
|
25
31
|
|
|
26
32
|
/**
|
|
27
33
|
* @typedef UpdateShortLinkByIdParam
|
|
28
|
-
* @property {string} id -
|
|
34
|
+
* @property {string} id - Short link document identifier
|
|
29
35
|
* @property {SharePlatformModel.ShortLinkReq} body
|
|
30
36
|
*/
|
|
31
37
|
|
|
@@ -44,6 +50,13 @@ class SharePlatformApplicationValidator {
|
|
|
44
50
|
}).required();
|
|
45
51
|
}
|
|
46
52
|
|
|
53
|
+
/** @returns {GetShortLinkClickStatsParam} */
|
|
54
|
+
static getShortLinkClickStats() {
|
|
55
|
+
return Joi.object({
|
|
56
|
+
surlId: Joi.string().allow("").required(),
|
|
57
|
+
}).required();
|
|
58
|
+
}
|
|
59
|
+
|
|
47
60
|
/** @returns {GetShortLinksParam} */
|
|
48
61
|
static getShortLinks() {
|
|
49
62
|
return Joi.object({
|
|
@@ -1,4 +1,9 @@
|
|
|
1
1
|
export = SharePlatformModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef ClickStatsResult
|
|
4
|
+
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
5
|
+
* the short link.
|
|
6
|
+
*/
|
|
2
7
|
/**
|
|
3
8
|
* @typedef ClickStatsItem
|
|
4
9
|
* @property {string} display - The display name of the click statistic.
|
|
@@ -50,10 +55,24 @@ export = SharePlatformModel;
|
|
|
50
55
|
* @property {Attribution} [attribution]
|
|
51
56
|
* @property {SocialMediaTags} [social_media_tags]
|
|
52
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.
|
|
53
69
|
*/
|
|
54
70
|
/**
|
|
55
71
|
* @typedef UrlInfo
|
|
72
|
+
* @property {string} [original]
|
|
56
73
|
* @property {string} [hash]
|
|
74
|
+
* @property {string} [short_url]
|
|
75
|
+
* @property {string} [alias]
|
|
57
76
|
*/
|
|
58
77
|
/**
|
|
59
78
|
* @typedef ShortLinkRes
|
|
@@ -87,8 +106,7 @@ export = SharePlatformModel;
|
|
|
87
106
|
* @property {number} [current] - The current page number.
|
|
88
107
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
89
108
|
* @property {number} [size] - The number of items per page.
|
|
90
|
-
* @property {number} [
|
|
91
|
-
* @property {number} [page] - Current page number
|
|
109
|
+
* @property {number} [page_size] - The number of items per page.
|
|
92
110
|
*/
|
|
93
111
|
/**
|
|
94
112
|
* @typedef ShortLinkList
|
|
@@ -102,8 +120,17 @@ export = SharePlatformModel;
|
|
|
102
120
|
declare class SharePlatformModel {
|
|
103
121
|
}
|
|
104
122
|
declare namespace SharePlatformModel {
|
|
105
|
-
export { ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
|
|
123
|
+
export { ClickStatsResult, ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, shortLinkReqMeta, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
|
|
106
124
|
}
|
|
125
|
+
/** @returns {ClickStatsResult} */
|
|
126
|
+
declare function ClickStatsResult(): ClickStatsResult;
|
|
127
|
+
type ClickStatsResult = {
|
|
128
|
+
/**
|
|
129
|
+
* - An array of click statistics for
|
|
130
|
+
* the short link.
|
|
131
|
+
*/
|
|
132
|
+
click_stats: ClickStatsItem[];
|
|
133
|
+
};
|
|
107
134
|
/** @returns {ClickStatsItem} */
|
|
108
135
|
declare function ClickStatsItem(): ClickStatsItem;
|
|
109
136
|
type ClickStatsItem = {
|
|
@@ -178,11 +205,32 @@ type ShortLinkReq = {
|
|
|
178
205
|
attribution?: Attribution;
|
|
179
206
|
social_media_tags?: SocialMediaTags;
|
|
180
207
|
count?: number;
|
|
208
|
+
meta?: shortLinkReqMeta;
|
|
209
|
+
};
|
|
210
|
+
/** @returns {shortLinkReqMeta} */
|
|
211
|
+
declare function shortLinkReqMeta(): shortLinkReqMeta;
|
|
212
|
+
type shortLinkReqMeta = {
|
|
213
|
+
/**
|
|
214
|
+
* - For_sms flag specifies that the short-link
|
|
215
|
+
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
216
|
+
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
217
|
+
*/
|
|
218
|
+
for_sms?: boolean;
|
|
219
|
+
/**
|
|
220
|
+
* - This field is used to override the sms
|
|
221
|
+
* header to be used to generate a short-link for SMS communication in
|
|
222
|
+
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
223
|
+
* for_sms flag set to true.
|
|
224
|
+
*/
|
|
225
|
+
sms_header?: string;
|
|
181
226
|
};
|
|
182
227
|
/** @returns {UrlInfo} */
|
|
183
228
|
declare function UrlInfo(): UrlInfo;
|
|
184
229
|
type UrlInfo = {
|
|
230
|
+
original?: string;
|
|
185
231
|
hash?: string;
|
|
232
|
+
short_url?: string;
|
|
233
|
+
alias?: string;
|
|
186
234
|
};
|
|
187
235
|
/** @returns {ShortLinkRes} */
|
|
188
236
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -243,13 +291,9 @@ type Page = {
|
|
|
243
291
|
*/
|
|
244
292
|
size?: number;
|
|
245
293
|
/**
|
|
246
|
-
* -
|
|
247
|
-
*/
|
|
248
|
-
total?: number;
|
|
249
|
-
/**
|
|
250
|
-
* - Current page number
|
|
294
|
+
* - The number of items per page.
|
|
251
295
|
*/
|
|
252
|
-
|
|
296
|
+
page_size?: number;
|
|
253
297
|
};
|
|
254
298
|
/** @returns {ShortLinkList} */
|
|
255
299
|
declare function ShortLinkList(): ShortLinkList;
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @typedef ClickStatsResult
|
|
5
|
+
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
6
|
+
* the short link.
|
|
7
|
+
*/
|
|
8
|
+
|
|
3
9
|
/**
|
|
4
10
|
* @typedef ClickStatsItem
|
|
5
11
|
* @property {string} display - The display name of the click statistic.
|
|
@@ -58,11 +64,26 @@ const Joi = require("joi");
|
|
|
58
64
|
* @property {Attribution} [attribution]
|
|
59
65
|
* @property {SocialMediaTags} [social_media_tags]
|
|
60
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.
|
|
61
79
|
*/
|
|
62
80
|
|
|
63
81
|
/**
|
|
64
82
|
* @typedef UrlInfo
|
|
83
|
+
* @property {string} [original]
|
|
65
84
|
* @property {string} [hash]
|
|
85
|
+
* @property {string} [short_url]
|
|
86
|
+
* @property {string} [alias]
|
|
66
87
|
*/
|
|
67
88
|
|
|
68
89
|
/**
|
|
@@ -98,8 +119,7 @@ const Joi = require("joi");
|
|
|
98
119
|
* @property {number} [current] - The current page number.
|
|
99
120
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
100
121
|
* @property {number} [size] - The number of items per page.
|
|
101
|
-
* @property {number} [
|
|
102
|
-
* @property {number} [page] - Current page number
|
|
122
|
+
* @property {number} [page_size] - The number of items per page.
|
|
103
123
|
*/
|
|
104
124
|
|
|
105
125
|
/**
|
|
@@ -114,6 +134,15 @@ const Joi = require("joi");
|
|
|
114
134
|
*/
|
|
115
135
|
|
|
116
136
|
class SharePlatformModel {
|
|
137
|
+
/** @returns {ClickStatsResult} */
|
|
138
|
+
static ClickStatsResult() {
|
|
139
|
+
return Joi.object({
|
|
140
|
+
click_stats: Joi.array()
|
|
141
|
+
.items(SharePlatformModel.ClickStatsItem())
|
|
142
|
+
.required(),
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
|
|
117
146
|
/** @returns {ClickStatsItem} */
|
|
118
147
|
static ClickStatsItem() {
|
|
119
148
|
return Joi.object({
|
|
@@ -187,13 +216,25 @@ class SharePlatformModel {
|
|
|
187
216
|
attribution: SharePlatformModel.Attribution(),
|
|
188
217
|
social_media_tags: SharePlatformModel.SocialMediaTags(),
|
|
189
218
|
count: Joi.number(),
|
|
219
|
+
meta: SharePlatformModel.shortLinkReqMeta(),
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
/** @returns {shortLinkReqMeta} */
|
|
224
|
+
static shortLinkReqMeta() {
|
|
225
|
+
return Joi.object({
|
|
226
|
+
for_sms: Joi.boolean(),
|
|
227
|
+
sms_header: Joi.string().allow(""),
|
|
190
228
|
});
|
|
191
229
|
}
|
|
192
230
|
|
|
193
231
|
/** @returns {UrlInfo} */
|
|
194
232
|
static UrlInfo() {
|
|
195
233
|
return Joi.object({
|
|
234
|
+
original: Joi.string().allow(""),
|
|
196
235
|
hash: Joi.string().allow(""),
|
|
236
|
+
short_url: Joi.string().allow(""),
|
|
237
|
+
alias: Joi.string().allow(""),
|
|
197
238
|
});
|
|
198
239
|
}
|
|
199
240
|
|
|
@@ -212,7 +253,7 @@ class SharePlatformModel {
|
|
|
212
253
|
application: Joi.string().allow(""),
|
|
213
254
|
user_id: Joi.string().allow(""),
|
|
214
255
|
created_at: Joi.string().allow(""),
|
|
215
|
-
meta: Joi.any(),
|
|
256
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
216
257
|
updated_at: Joi.string().allow(""),
|
|
217
258
|
personalized: Joi.boolean(),
|
|
218
259
|
campaign: SharePlatformModel.CampaignShortLink(),
|
|
@@ -233,8 +274,7 @@ class SharePlatformModel {
|
|
|
233
274
|
current: Joi.number(),
|
|
234
275
|
type: Joi.string().allow("").required(),
|
|
235
276
|
size: Joi.number(),
|
|
236
|
-
|
|
237
|
-
page: Joi.number(),
|
|
277
|
+
page_size: Joi.number(),
|
|
238
278
|
});
|
|
239
279
|
}
|
|
240
280
|
|
|
@@ -3,6 +3,18 @@ declare class Theme {
|
|
|
3
3
|
constructor(config: any, applicationId: any);
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
|
+
/**
|
|
7
|
+
* @param {ThemePlatformApplicationValidator.AddThemeToApplicationParam} arg
|
|
8
|
+
* - Arg object
|
|
9
|
+
*
|
|
10
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
+
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
13
|
+
* @name addThemeToApplication
|
|
14
|
+
* @summary: Create theme in sales channel
|
|
15
|
+
* @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addThemeToApplication/).
|
|
16
|
+
*/
|
|
17
|
+
addThemeToApplication({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddThemeToApplicationParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
6
18
|
/**
|
|
7
19
|
* @param {ThemePlatformApplicationValidator.ApplyThemeParam} arg - Arg object
|
|
8
20
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -23,16 +35,6 @@ declare class Theme {
|
|
|
23
35
|
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/createPage/).
|
|
24
36
|
*/
|
|
25
37
|
createPage({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
26
|
-
/**
|
|
27
|
-
* @param {ThemePlatformApplicationValidator.CreateThemeParam} arg - Arg object
|
|
28
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
29
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
|
-
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
31
|
-
* @name createTheme
|
|
32
|
-
* @summary: Get Create theme
|
|
33
|
-
* @description: Creating a new theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/createTheme/).
|
|
34
|
-
*/
|
|
35
|
-
createTheme({ body, requestHeaders }?: ThemePlatformApplicationValidator.CreateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
36
38
|
/**
|
|
37
39
|
* @param {ThemePlatformApplicationValidator.DeletePageParam} arg - Arg object
|
|
38
40
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -128,29 +130,7 @@ declare class Theme {
|
|
|
128
130
|
* @summary: List theme fonts
|
|
129
131
|
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
|
|
130
132
|
*/
|
|
131
|
-
getFonts({ requestHeaders }?:
|
|
132
|
-
/**
|
|
133
|
-
* @param {ThemePlatformApplicationValidator.GetFontsV2Param} arg - Arg object
|
|
134
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
135
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
136
|
-
* @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
|
|
137
|
-
* @name getFontsV2
|
|
138
|
-
* @summary: List theme fonts
|
|
139
|
-
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFontsV2/).
|
|
140
|
-
*/
|
|
141
|
-
getFontsV2({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
|
|
142
|
-
/**
|
|
143
|
-
* @param {ThemePlatformApplicationValidator.GetLatestVersionOfThemeBySlugParam} arg
|
|
144
|
-
* - Arg object
|
|
145
|
-
*
|
|
146
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
147
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
148
|
-
* @returns {Promise<ThemePlatformModel.MarketplaceTheme[]>} - Success response
|
|
149
|
-
* @name getLatestVersionOfThemeBySlug
|
|
150
|
-
* @summary: Get latest version of theme by slug.
|
|
151
|
-
* @description: Retrieve the most recent version of a theme using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getLatestVersionOfThemeBySlug/).
|
|
152
|
-
*/
|
|
153
|
-
getLatestVersionOfThemeBySlug({ slugName, requestHeaders }?: ThemePlatformApplicationValidator.GetLatestVersionOfThemeBySlugParam, { responseHeaders }?: object): Promise<ThemePlatformModel.MarketplaceTheme[]>;
|
|
133
|
+
getFonts({ capability, requestHeaders }?: ThemePlatformApplicationValidator.GetFontsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
|
|
154
134
|
/**
|
|
155
135
|
* @param {ThemePlatformApplicationValidator.GetPageParam} arg - Arg object
|
|
156
136
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -197,12 +177,12 @@ declare class Theme {
|
|
|
197
177
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
198
178
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
199
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
200
|
-
* @returns {Promise<ThemePlatformModel.
|
|
180
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
201
181
|
* @name isUpgradable
|
|
202
182
|
* @summary: Check theme is upgradable
|
|
203
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.
|
|
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/).
|
|
204
184
|
*/
|
|
205
|
-
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.
|
|
185
|
+
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
|
|
206
186
|
/**
|
|
207
187
|
* @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
|
|
208
188
|
* - Arg object
|
|
@@ -224,7 +204,7 @@ declare class Theme {
|
|
|
224
204
|
* @summary: Update a page
|
|
225
205
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
226
206
|
*/
|
|
227
|
-
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>;
|
|
228
208
|
/**
|
|
229
209
|
* @param {ThemePlatformApplicationValidator.UpdateThemeParam} arg - Arg object
|
|
230
210
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|