@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
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 +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -9,7 +9,7 @@ declare class Share {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
11
11
|
* @name createShortLink
|
|
12
|
-
* @summary: Create short link
|
|
12
|
+
* @summary: Create short link.
|
|
13
13
|
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
|
|
14
14
|
*/
|
|
15
15
|
createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
@@ -19,29 +19,17 @@ declare class Share {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
21
21
|
* @name getShortLinkByHash
|
|
22
|
-
* @summary: Get short link by hash
|
|
22
|
+
* @summary: Get short link by hash.
|
|
23
23
|
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
|
|
24
24
|
*/
|
|
25
25
|
getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
26
|
-
/**
|
|
27
|
-
* @param {SharePlatformApplicationValidator.GetShortLinkClickStatsParam} arg
|
|
28
|
-
* - Arg object
|
|
29
|
-
*
|
|
30
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
|
-
* @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
|
|
33
|
-
* @name getShortLinkClickStats
|
|
34
|
-
* @summary: Get short link click statistics
|
|
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
|
-
*/
|
|
37
|
-
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResult>;
|
|
38
26
|
/**
|
|
39
27
|
* @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
|
|
40
28
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
30
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
43
31
|
* @name getShortLinks
|
|
44
|
-
* @summary: Get short links
|
|
32
|
+
* @summary: Get short links.
|
|
45
33
|
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
46
34
|
*/
|
|
47
35
|
getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
|
|
@@ -53,7 +41,7 @@ declare class Share {
|
|
|
53
41
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
42
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
55
43
|
* @name updateShortLinkById
|
|
56
|
-
* @summary: Update short link
|
|
44
|
+
* @summary: Update short link by ID.
|
|
57
45
|
* @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/).
|
|
58
46
|
*/
|
|
59
47
|
updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
@@ -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,91 +173,13 @@ 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
|
-
|
|
254
176
|
/**
|
|
255
177
|
* @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
|
|
256
178
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
180
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
259
181
|
* @name getShortLinks
|
|
260
|
-
* @summary: Get short links
|
|
182
|
+
* @summary: Get short links.
|
|
261
183
|
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
262
184
|
*/
|
|
263
185
|
async getShortLinks(
|
|
@@ -325,7 +247,7 @@ class Share {
|
|
|
325
247
|
const response = await PlatformAPIClient.execute(
|
|
326
248
|
this.config,
|
|
327
249
|
"get",
|
|
328
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link
|
|
250
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link`,
|
|
329
251
|
query_params,
|
|
330
252
|
undefined,
|
|
331
253
|
requestHeaders,
|
|
@@ -366,7 +288,7 @@ class Share {
|
|
|
366
288
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
367
289
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
368
290
|
* @name updateShortLinkById
|
|
369
|
-
* @summary: Update short link
|
|
291
|
+
* @summary: Update short link by ID.
|
|
370
292
|
* @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/).
|
|
371
293
|
*/
|
|
372
294
|
async updateShortLinkById(
|
|
@@ -408,7 +330,7 @@ class Share {
|
|
|
408
330
|
const response = await PlatformAPIClient.execute(
|
|
409
331
|
this.config,
|
|
410
332
|
"patch",
|
|
411
|
-
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}
|
|
333
|
+
`/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}`,
|
|
412
334
|
query_params,
|
|
413
335
|
body,
|
|
414
336
|
requestHeaders,
|
|
@@ -5,17 +5,12 @@ export = SharePlatformApplicationValidator;
|
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
7
7
|
* @typedef GetShortLinkByHashParam
|
|
8
|
-
* @property {string} hash
|
|
9
|
-
*/
|
|
10
|
-
/**
|
|
11
|
-
* @typedef GetShortLinkClickStatsParam
|
|
12
|
-
* @property {string} surlId - Short link ID for which click statistics are to
|
|
13
|
-
* be retrieved.
|
|
8
|
+
* @property {string} hash
|
|
14
9
|
*/
|
|
15
10
|
/**
|
|
16
11
|
* @typedef GetShortLinksParam
|
|
17
12
|
* @property {number} [pageNo] - Current page number
|
|
18
|
-
* @property {number} [pageSize] -
|
|
13
|
+
* @property {number} [pageSize] - Number of items displayed per page
|
|
19
14
|
* @property {string} [createdBy] - Short link creator
|
|
20
15
|
* @property {string} [active] - Short link active status
|
|
21
16
|
* @property {string} [shortUrl] - Search for short url
|
|
@@ -24,7 +19,7 @@ export = SharePlatformApplicationValidator;
|
|
|
24
19
|
*/
|
|
25
20
|
/**
|
|
26
21
|
* @typedef UpdateShortLinkByIdParam
|
|
27
|
-
* @property {string} id -
|
|
22
|
+
* @property {string} id - Document Id
|
|
28
23
|
* @property {SharePlatformModel.ShortLinkReq} body
|
|
29
24
|
*/
|
|
30
25
|
declare class SharePlatformApplicationValidator {
|
|
@@ -32,39 +27,27 @@ declare class SharePlatformApplicationValidator {
|
|
|
32
27
|
static createShortLink(): CreateShortLinkParam;
|
|
33
28
|
/** @returns {GetShortLinkByHashParam} */
|
|
34
29
|
static getShortLinkByHash(): GetShortLinkByHashParam;
|
|
35
|
-
/** @returns {GetShortLinkClickStatsParam} */
|
|
36
|
-
static getShortLinkClickStats(): GetShortLinkClickStatsParam;
|
|
37
30
|
/** @returns {GetShortLinksParam} */
|
|
38
31
|
static getShortLinks(): GetShortLinksParam;
|
|
39
32
|
/** @returns {UpdateShortLinkByIdParam} */
|
|
40
33
|
static updateShortLinkById(): UpdateShortLinkByIdParam;
|
|
41
34
|
}
|
|
42
35
|
declare namespace SharePlatformApplicationValidator {
|
|
43
|
-
export { CreateShortLinkParam, GetShortLinkByHashParam,
|
|
36
|
+
export { CreateShortLinkParam, GetShortLinkByHashParam, GetShortLinksParam, UpdateShortLinkByIdParam };
|
|
44
37
|
}
|
|
45
38
|
type CreateShortLinkParam = {
|
|
46
39
|
body: SharePlatformModel.ShortLinkReq;
|
|
47
40
|
};
|
|
48
41
|
type GetShortLinkByHashParam = {
|
|
49
|
-
/**
|
|
50
|
-
* - Hash of short url
|
|
51
|
-
*/
|
|
52
42
|
hash: string;
|
|
53
43
|
};
|
|
54
|
-
type GetShortLinkClickStatsParam = {
|
|
55
|
-
/**
|
|
56
|
-
* - Short link ID for which click statistics are to
|
|
57
|
-
* be retrieved.
|
|
58
|
-
*/
|
|
59
|
-
surlId: string;
|
|
60
|
-
};
|
|
61
44
|
type GetShortLinksParam = {
|
|
62
45
|
/**
|
|
63
46
|
* - Current page number
|
|
64
47
|
*/
|
|
65
48
|
pageNo?: number;
|
|
66
49
|
/**
|
|
67
|
-
* -
|
|
50
|
+
* - Number of items displayed per page
|
|
68
51
|
*/
|
|
69
52
|
pageSize?: number;
|
|
70
53
|
/**
|
|
@@ -90,7 +73,7 @@ type GetShortLinksParam = {
|
|
|
90
73
|
};
|
|
91
74
|
type UpdateShortLinkByIdParam = {
|
|
92
75
|
/**
|
|
93
|
-
* -
|
|
76
|
+
* - Document Id
|
|
94
77
|
*/
|
|
95
78
|
id: string;
|
|
96
79
|
body: SharePlatformModel.ShortLinkReq;
|
|
@@ -9,19 +9,13 @@ const SharePlatformModel = require("./SharePlatformModel");
|
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
11
|
* @typedef GetShortLinkByHashParam
|
|
12
|
-
* @property {string} hash
|
|
13
|
-
*/
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* @typedef GetShortLinkClickStatsParam
|
|
17
|
-
* @property {string} surlId - Short link ID for which click statistics are to
|
|
18
|
-
* be retrieved.
|
|
12
|
+
* @property {string} hash
|
|
19
13
|
*/
|
|
20
14
|
|
|
21
15
|
/**
|
|
22
16
|
* @typedef GetShortLinksParam
|
|
23
17
|
* @property {number} [pageNo] - Current page number
|
|
24
|
-
* @property {number} [pageSize] -
|
|
18
|
+
* @property {number} [pageSize] - Number of items displayed per page
|
|
25
19
|
* @property {string} [createdBy] - Short link creator
|
|
26
20
|
* @property {string} [active] - Short link active status
|
|
27
21
|
* @property {string} [shortUrl] - Search for short url
|
|
@@ -31,7 +25,7 @@ const SharePlatformModel = require("./SharePlatformModel");
|
|
|
31
25
|
|
|
32
26
|
/**
|
|
33
27
|
* @typedef UpdateShortLinkByIdParam
|
|
34
|
-
* @property {string} id -
|
|
28
|
+
* @property {string} id - Document Id
|
|
35
29
|
* @property {SharePlatformModel.ShortLinkReq} body
|
|
36
30
|
*/
|
|
37
31
|
|
|
@@ -50,13 +44,6 @@ class SharePlatformApplicationValidator {
|
|
|
50
44
|
}).required();
|
|
51
45
|
}
|
|
52
46
|
|
|
53
|
-
/** @returns {GetShortLinkClickStatsParam} */
|
|
54
|
-
static getShortLinkClickStats() {
|
|
55
|
-
return Joi.object({
|
|
56
|
-
surlId: Joi.string().allow("").required(),
|
|
57
|
-
}).required();
|
|
58
|
-
}
|
|
59
|
-
|
|
60
47
|
/** @returns {GetShortLinksParam} */
|
|
61
48
|
static getShortLinks() {
|
|
62
49
|
return Joi.object({
|
|
@@ -1,9 +1,4 @@
|
|
|
1
1
|
export = SharePlatformModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef ClickStatsResult
|
|
4
|
-
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
5
|
-
* the short link.
|
|
6
|
-
*/
|
|
7
2
|
/**
|
|
8
3
|
* @typedef ClickStatsItem
|
|
9
4
|
* @property {string} display - The display name of the click statistic.
|
|
@@ -55,24 +50,10 @@ export = SharePlatformModel;
|
|
|
55
50
|
* @property {Attribution} [attribution]
|
|
56
51
|
* @property {SocialMediaTags} [social_media_tags]
|
|
57
52
|
* @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.
|
|
69
53
|
*/
|
|
70
54
|
/**
|
|
71
55
|
* @typedef UrlInfo
|
|
72
|
-
* @property {string} [original]
|
|
73
56
|
* @property {string} [hash]
|
|
74
|
-
* @property {string} [short_url]
|
|
75
|
-
* @property {string} [alias]
|
|
76
57
|
*/
|
|
77
58
|
/**
|
|
78
59
|
* @typedef ShortLinkRes
|
|
@@ -106,6 +87,8 @@ export = SharePlatformModel;
|
|
|
106
87
|
* @property {number} [current] - The current page number.
|
|
107
88
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
108
89
|
* @property {number} [size] - The number of items per page.
|
|
90
|
+
* @property {number} [total] - Total number of items.
|
|
91
|
+
* @property {number} [page] - Current page number
|
|
109
92
|
*/
|
|
110
93
|
/**
|
|
111
94
|
* @typedef ShortLinkList
|
|
@@ -119,17 +102,8 @@ export = SharePlatformModel;
|
|
|
119
102
|
declare class SharePlatformModel {
|
|
120
103
|
}
|
|
121
104
|
declare namespace SharePlatformModel {
|
|
122
|
-
export {
|
|
105
|
+
export { ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
|
|
123
106
|
}
|
|
124
|
-
/** @returns {ClickStatsResult} */
|
|
125
|
-
declare function ClickStatsResult(): ClickStatsResult;
|
|
126
|
-
type ClickStatsResult = {
|
|
127
|
-
/**
|
|
128
|
-
* - An array of click statistics for
|
|
129
|
-
* the short link.
|
|
130
|
-
*/
|
|
131
|
-
click_stats: ClickStatsItem[];
|
|
132
|
-
};
|
|
133
107
|
/** @returns {ClickStatsItem} */
|
|
134
108
|
declare function ClickStatsItem(): ClickStatsItem;
|
|
135
109
|
type ClickStatsItem = {
|
|
@@ -204,32 +178,11 @@ type ShortLinkReq = {
|
|
|
204
178
|
attribution?: Attribution;
|
|
205
179
|
social_media_tags?: SocialMediaTags;
|
|
206
180
|
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;
|
|
225
181
|
};
|
|
226
182
|
/** @returns {UrlInfo} */
|
|
227
183
|
declare function UrlInfo(): UrlInfo;
|
|
228
184
|
type UrlInfo = {
|
|
229
|
-
original?: string;
|
|
230
185
|
hash?: string;
|
|
231
|
-
short_url?: string;
|
|
232
|
-
alias?: string;
|
|
233
186
|
};
|
|
234
187
|
/** @returns {ShortLinkRes} */
|
|
235
188
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -289,6 +242,14 @@ type Page = {
|
|
|
289
242
|
* - The number of items per page.
|
|
290
243
|
*/
|
|
291
244
|
size?: number;
|
|
245
|
+
/**
|
|
246
|
+
* - Total number of items.
|
|
247
|
+
*/
|
|
248
|
+
total?: number;
|
|
249
|
+
/**
|
|
250
|
+
* - Current page number
|
|
251
|
+
*/
|
|
252
|
+
page?: number;
|
|
292
253
|
};
|
|
293
254
|
/** @returns {ShortLinkList} */
|
|
294
255
|
declare function ShortLinkList(): ShortLinkList;
|
|
@@ -1,11 +1,5 @@
|
|
|
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
|
-
|
|
9
3
|
/**
|
|
10
4
|
* @typedef ClickStatsItem
|
|
11
5
|
* @property {string} display - The display name of the click statistic.
|
|
@@ -64,26 +58,11 @@ const Joi = require("joi");
|
|
|
64
58
|
* @property {Attribution} [attribution]
|
|
65
59
|
* @property {SocialMediaTags} [social_media_tags]
|
|
66
60
|
* @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.
|
|
79
61
|
*/
|
|
80
62
|
|
|
81
63
|
/**
|
|
82
64
|
* @typedef UrlInfo
|
|
83
|
-
* @property {string} [original]
|
|
84
65
|
* @property {string} [hash]
|
|
85
|
-
* @property {string} [short_url]
|
|
86
|
-
* @property {string} [alias]
|
|
87
66
|
*/
|
|
88
67
|
|
|
89
68
|
/**
|
|
@@ -119,6 +98,8 @@ const Joi = require("joi");
|
|
|
119
98
|
* @property {number} [current] - The current page number.
|
|
120
99
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
121
100
|
* @property {number} [size] - The number of items per page.
|
|
101
|
+
* @property {number} [total] - Total number of items.
|
|
102
|
+
* @property {number} [page] - Current page number
|
|
122
103
|
*/
|
|
123
104
|
|
|
124
105
|
/**
|
|
@@ -133,15 +114,6 @@ const Joi = require("joi");
|
|
|
133
114
|
*/
|
|
134
115
|
|
|
135
116
|
class SharePlatformModel {
|
|
136
|
-
/** @returns {ClickStatsResult} */
|
|
137
|
-
static ClickStatsResult() {
|
|
138
|
-
return Joi.object({
|
|
139
|
-
click_stats: Joi.array()
|
|
140
|
-
.items(SharePlatformModel.ClickStatsItem())
|
|
141
|
-
.required(),
|
|
142
|
-
});
|
|
143
|
-
}
|
|
144
|
-
|
|
145
117
|
/** @returns {ClickStatsItem} */
|
|
146
118
|
static ClickStatsItem() {
|
|
147
119
|
return Joi.object({
|
|
@@ -215,25 +187,13 @@ class SharePlatformModel {
|
|
|
215
187
|
attribution: SharePlatformModel.Attribution(),
|
|
216
188
|
social_media_tags: SharePlatformModel.SocialMediaTags(),
|
|
217
189
|
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(""),
|
|
227
190
|
});
|
|
228
191
|
}
|
|
229
192
|
|
|
230
193
|
/** @returns {UrlInfo} */
|
|
231
194
|
static UrlInfo() {
|
|
232
195
|
return Joi.object({
|
|
233
|
-
original: Joi.string().allow(""),
|
|
234
196
|
hash: Joi.string().allow(""),
|
|
235
|
-
short_url: Joi.string().allow(""),
|
|
236
|
-
alias: Joi.string().allow(""),
|
|
237
197
|
});
|
|
238
198
|
}
|
|
239
199
|
|
|
@@ -252,7 +212,7 @@ class SharePlatformModel {
|
|
|
252
212
|
application: Joi.string().allow(""),
|
|
253
213
|
user_id: Joi.string().allow(""),
|
|
254
214
|
created_at: Joi.string().allow(""),
|
|
255
|
-
meta: Joi.
|
|
215
|
+
meta: Joi.any(),
|
|
256
216
|
updated_at: Joi.string().allow(""),
|
|
257
217
|
personalized: Joi.boolean(),
|
|
258
218
|
campaign: SharePlatformModel.CampaignShortLink(),
|
|
@@ -273,6 +233,8 @@ class SharePlatformModel {
|
|
|
273
233
|
current: Joi.number(),
|
|
274
234
|
type: Joi.string().allow("").required(),
|
|
275
235
|
size: Joi.number(),
|
|
236
|
+
total: Joi.number(),
|
|
237
|
+
page: Joi.number(),
|
|
276
238
|
});
|
|
277
239
|
}
|
|
278
240
|
|
|
@@ -3,18 +3,6 @@ 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>;
|
|
18
6
|
/**
|
|
19
7
|
* @param {ThemePlatformApplicationValidator.ApplyThemeParam} arg - Arg object
|
|
20
8
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -35,6 +23,16 @@ declare class Theme {
|
|
|
35
23
|
* @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/).
|
|
36
24
|
*/
|
|
37
25
|
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>;
|
|
38
36
|
/**
|
|
39
37
|
* @param {ThemePlatformApplicationValidator.DeletePageParam} arg - Arg object
|
|
40
38
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -131,6 +129,28 @@ declare class Theme {
|
|
|
131
129
|
* @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/).
|
|
132
130
|
*/
|
|
133
131
|
getFonts({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
|
|
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[]>;
|
|
134
154
|
/**
|
|
135
155
|
* @param {ThemePlatformApplicationValidator.GetPageParam} arg - Arg object
|
|
136
156
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -177,12 +197,12 @@ declare class Theme {
|
|
|
177
197
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
178
198
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
199
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ThemePlatformModel.
|
|
200
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradableResponse>} - Success response
|
|
181
201
|
* @name isUpgradable
|
|
182
202
|
* @summary: Check theme is upgradable
|
|
183
|
-
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.
|
|
203
|
+
* @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
204
|
*/
|
|
185
|
-
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.
|
|
205
|
+
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradableResponse>;
|
|
186
206
|
/**
|
|
187
207
|
* @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
|
|
188
208
|
* - Arg object
|
|
@@ -204,7 +224,7 @@ declare class Theme {
|
|
|
204
224
|
* @summary: Update a page
|
|
205
225
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
206
226
|
*/
|
|
207
|
-
updatePage({ themeId, pageValue,
|
|
227
|
+
updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
208
228
|
/**
|
|
209
229
|
* @param {ThemePlatformApplicationValidator.UpdateThemeParam} arg - Arg object
|
|
210
230
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|