@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- 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 +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- 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 +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- 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 +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- 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 +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -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/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = SharePlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef ClickStatsResult
|
|
4
4
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
5
5
|
* the short link.
|
|
6
6
|
*/
|
|
@@ -55,12 +55,24 @@ export = SharePlatformModel;
|
|
|
55
55
|
* @property {Attribution} [attribution]
|
|
56
56
|
* @property {SocialMediaTags} [social_media_tags]
|
|
57
57
|
* @property {number} [count]
|
|
58
|
+
* @property {shortLinkReqMeta} [meta]
|
|
59
|
+
*/
|
|
60
|
+
/**
|
|
61
|
+
* @typedef shortLinkReqMeta
|
|
62
|
+
* @property {boolean} [for_sms] - For_sms flag specifies that the short-link
|
|
63
|
+
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
64
|
+
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
65
|
+
* @property {string} [sms_header] - This field is used to override the sms
|
|
66
|
+
* header to be used to generate a short-link for SMS communication in
|
|
67
|
+
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
68
|
+
* for_sms flag set to true.
|
|
58
69
|
*/
|
|
59
70
|
/**
|
|
60
71
|
* @typedef UrlInfo
|
|
61
72
|
* @property {string} [original]
|
|
62
73
|
* @property {string} [hash]
|
|
63
74
|
* @property {string} [short_url]
|
|
75
|
+
* @property {string} [alias]
|
|
64
76
|
*/
|
|
65
77
|
/**
|
|
66
78
|
* @typedef ShortLinkRes
|
|
@@ -87,13 +99,14 @@ export = SharePlatformModel;
|
|
|
87
99
|
*/
|
|
88
100
|
/**
|
|
89
101
|
* @typedef Page
|
|
90
|
-
* @property {number} [item_total] - The total number of items
|
|
102
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
91
103
|
* @property {string} [next_id] - The identifier for the next page.
|
|
92
104
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
93
105
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
94
106
|
* @property {number} [current] - The current page number.
|
|
95
|
-
* @property {string} type - The type of the page,
|
|
107
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
96
108
|
* @property {number} [size] - The number of items per page.
|
|
109
|
+
* @property {number} [page_size] - The number of items per page.
|
|
97
110
|
*/
|
|
98
111
|
/**
|
|
99
112
|
* @typedef ShortLinkList
|
|
@@ -107,11 +120,11 @@ export = SharePlatformModel;
|
|
|
107
120
|
declare class SharePlatformModel {
|
|
108
121
|
}
|
|
109
122
|
declare namespace SharePlatformModel {
|
|
110
|
-
export {
|
|
123
|
+
export { ClickStatsResult, ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, shortLinkReqMeta, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
|
|
111
124
|
}
|
|
112
|
-
/** @returns {
|
|
113
|
-
declare function
|
|
114
|
-
type
|
|
125
|
+
/** @returns {ClickStatsResult} */
|
|
126
|
+
declare function ClickStatsResult(): ClickStatsResult;
|
|
127
|
+
type ClickStatsResult = {
|
|
115
128
|
/**
|
|
116
129
|
* - An array of click statistics for
|
|
117
130
|
* the short link.
|
|
@@ -192,6 +205,24 @@ type ShortLinkReq = {
|
|
|
192
205
|
attribution?: Attribution;
|
|
193
206
|
social_media_tags?: SocialMediaTags;
|
|
194
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;
|
|
195
226
|
};
|
|
196
227
|
/** @returns {UrlInfo} */
|
|
197
228
|
declare function UrlInfo(): UrlInfo;
|
|
@@ -199,6 +230,7 @@ type UrlInfo = {
|
|
|
199
230
|
original?: string;
|
|
200
231
|
hash?: string;
|
|
201
232
|
short_url?: string;
|
|
233
|
+
alias?: string;
|
|
202
234
|
};
|
|
203
235
|
/** @returns {ShortLinkRes} */
|
|
204
236
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -231,7 +263,7 @@ type ShortLinkRes = {
|
|
|
231
263
|
declare function Page(): Page;
|
|
232
264
|
type Page = {
|
|
233
265
|
/**
|
|
234
|
-
* - The total number of items
|
|
266
|
+
* - The total number of all items across all pages.
|
|
235
267
|
*/
|
|
236
268
|
item_total?: number;
|
|
237
269
|
/**
|
|
@@ -251,13 +283,17 @@ type Page = {
|
|
|
251
283
|
*/
|
|
252
284
|
current?: number;
|
|
253
285
|
/**
|
|
254
|
-
* - The type of the page,
|
|
286
|
+
* - The type of the page, can be 'cursor' or 'number'.
|
|
255
287
|
*/
|
|
256
288
|
type: string;
|
|
257
289
|
/**
|
|
258
290
|
* - The number of items per page.
|
|
259
291
|
*/
|
|
260
292
|
size?: number;
|
|
293
|
+
/**
|
|
294
|
+
* - The number of items per page.
|
|
295
|
+
*/
|
|
296
|
+
page_size?: number;
|
|
261
297
|
};
|
|
262
298
|
/** @returns {ShortLinkList} */
|
|
263
299
|
declare function ShortLinkList(): ShortLinkList;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef ClickStatsResult
|
|
5
5
|
* @property {ClickStatsItem[]} click_stats - An array of click statistics for
|
|
6
6
|
* the short link.
|
|
7
7
|
*/
|
|
@@ -64,6 +64,18 @@ const Joi = require("joi");
|
|
|
64
64
|
* @property {Attribution} [attribution]
|
|
65
65
|
* @property {SocialMediaTags} [social_media_tags]
|
|
66
66
|
* @property {number} [count]
|
|
67
|
+
* @property {shortLinkReqMeta} [meta]
|
|
68
|
+
*/
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* @typedef shortLinkReqMeta
|
|
72
|
+
* @property {boolean} [for_sms] - For_sms flag specifies that the short-link
|
|
73
|
+
* will be used in SMS communication and based on TRAI (Indian) guidelines,
|
|
74
|
+
* the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
|
|
75
|
+
* @property {string} [sms_header] - This field is used to override the sms
|
|
76
|
+
* header to be used to generate a short-link for SMS communication in
|
|
77
|
+
* compliance with TRAI guidelines, this should be used in conjunction with
|
|
78
|
+
* for_sms flag set to true.
|
|
67
79
|
*/
|
|
68
80
|
|
|
69
81
|
/**
|
|
@@ -71,6 +83,7 @@ const Joi = require("joi");
|
|
|
71
83
|
* @property {string} [original]
|
|
72
84
|
* @property {string} [hash]
|
|
73
85
|
* @property {string} [short_url]
|
|
86
|
+
* @property {string} [alias]
|
|
74
87
|
*/
|
|
75
88
|
|
|
76
89
|
/**
|
|
@@ -99,13 +112,14 @@ const Joi = require("joi");
|
|
|
99
112
|
|
|
100
113
|
/**
|
|
101
114
|
* @typedef Page
|
|
102
|
-
* @property {number} [item_total] - The total number of items
|
|
115
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
103
116
|
* @property {string} [next_id] - The identifier for the next page.
|
|
104
117
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
105
118
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
106
119
|
* @property {number} [current] - The current page number.
|
|
107
|
-
* @property {string} type - The type of the page,
|
|
120
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
108
121
|
* @property {number} [size] - The number of items per page.
|
|
122
|
+
* @property {number} [page_size] - The number of items per page.
|
|
109
123
|
*/
|
|
110
124
|
|
|
111
125
|
/**
|
|
@@ -120,8 +134,8 @@ const Joi = require("joi");
|
|
|
120
134
|
*/
|
|
121
135
|
|
|
122
136
|
class SharePlatformModel {
|
|
123
|
-
/** @returns {
|
|
124
|
-
static
|
|
137
|
+
/** @returns {ClickStatsResult} */
|
|
138
|
+
static ClickStatsResult() {
|
|
125
139
|
return Joi.object({
|
|
126
140
|
click_stats: Joi.array()
|
|
127
141
|
.items(SharePlatformModel.ClickStatsItem())
|
|
@@ -202,6 +216,15 @@ class SharePlatformModel {
|
|
|
202
216
|
attribution: SharePlatformModel.Attribution(),
|
|
203
217
|
social_media_tags: SharePlatformModel.SocialMediaTags(),
|
|
204
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(""),
|
|
205
228
|
});
|
|
206
229
|
}
|
|
207
230
|
|
|
@@ -211,6 +234,7 @@ class SharePlatformModel {
|
|
|
211
234
|
original: Joi.string().allow(""),
|
|
212
235
|
hash: Joi.string().allow(""),
|
|
213
236
|
short_url: Joi.string().allow(""),
|
|
237
|
+
alias: Joi.string().allow(""),
|
|
214
238
|
});
|
|
215
239
|
}
|
|
216
240
|
|
|
@@ -229,7 +253,7 @@ class SharePlatformModel {
|
|
|
229
253
|
application: Joi.string().allow(""),
|
|
230
254
|
user_id: Joi.string().allow(""),
|
|
231
255
|
created_at: Joi.string().allow(""),
|
|
232
|
-
meta: Joi.any(),
|
|
256
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
233
257
|
updated_at: Joi.string().allow(""),
|
|
234
258
|
personalized: Joi.boolean(),
|
|
235
259
|
campaign: SharePlatformModel.CampaignShortLink(),
|
|
@@ -250,6 +274,7 @@ class SharePlatformModel {
|
|
|
250
274
|
current: Joi.number(),
|
|
251
275
|
type: Joi.string().allow("").required(),
|
|
252
276
|
size: Joi.number(),
|
|
277
|
+
page_size: Joi.number(),
|
|
253
278
|
});
|
|
254
279
|
}
|
|
255
280
|
|
|
@@ -12,7 +12,7 @@ declare class Theme {
|
|
|
12
12
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
13
13
|
* @name addThemeToApplication
|
|
14
14
|
* @summary: Create theme in sales channel
|
|
15
|
-
* @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://
|
|
15
|
+
* @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/addThemeToApplication/).
|
|
16
16
|
*/
|
|
17
17
|
addThemeToApplication({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddThemeToApplicationParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
18
18
|
/**
|
|
@@ -22,7 +22,7 @@ declare class Theme {
|
|
|
22
22
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
23
23
|
* @name applyTheme
|
|
24
24
|
* @summary: Apply a theme
|
|
25
|
-
* @description: Change current applied theme with new draft theme. - Check out [method documentation](https://
|
|
25
|
+
* @description: Change current applied theme with new draft theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/applyTheme/).
|
|
26
26
|
*/
|
|
27
27
|
applyTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ApplyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
28
28
|
/**
|
|
@@ -32,7 +32,7 @@ declare class Theme {
|
|
|
32
32
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
33
33
|
* @name createPage
|
|
34
34
|
* @summary: Create theme page
|
|
35
|
-
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://
|
|
35
|
+
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/createPage/).
|
|
36
36
|
*/
|
|
37
37
|
createPage({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
38
38
|
/**
|
|
@@ -42,7 +42,7 @@ declare class Theme {
|
|
|
42
42
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
43
43
|
* @name deletePage
|
|
44
44
|
* @summary: Delete a page
|
|
45
|
-
* @description: Remove a page from a theme of the platform. - Check out [method documentation](https://
|
|
45
|
+
* @description: Remove a page from a theme of the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deletePage/).
|
|
46
46
|
*/
|
|
47
47
|
deletePage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
48
48
|
/**
|
|
@@ -52,7 +52,7 @@ declare class Theme {
|
|
|
52
52
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
53
53
|
* @name deleteTheme
|
|
54
54
|
* @summary: Delete theme
|
|
55
|
-
* @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://
|
|
55
|
+
* @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/deleteTheme/).
|
|
56
56
|
*/
|
|
57
57
|
deleteTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DeleteThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
58
58
|
/**
|
|
@@ -62,7 +62,7 @@ declare class Theme {
|
|
|
62
62
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
63
63
|
* @name duplicateTheme
|
|
64
64
|
* @summary: Duplicate a theme
|
|
65
|
-
* @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://
|
|
65
|
+
* @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/duplicateTheme/).
|
|
66
66
|
*/
|
|
67
67
|
duplicateTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DuplicateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
68
68
|
/**
|
|
@@ -72,7 +72,7 @@ declare class Theme {
|
|
|
72
72
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
73
73
|
* @name getAllPages
|
|
74
74
|
* @summary: List pages of a theme
|
|
75
|
-
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://
|
|
75
|
+
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getAllPages/).
|
|
76
76
|
*/
|
|
77
77
|
getAllPages({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
78
78
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Theme {
|
|
|
84
84
|
* @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
|
|
85
85
|
* @name getApplicationThemes
|
|
86
86
|
* @summary: List sales channel themes
|
|
87
|
-
* @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://
|
|
87
|
+
* @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getApplicationThemes/).
|
|
88
88
|
*/
|
|
89
89
|
getApplicationThemes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema[]>;
|
|
90
90
|
/**
|
|
@@ -96,7 +96,7 @@ declare class Theme {
|
|
|
96
96
|
* @returns {Promise<Object>} - Success response
|
|
97
97
|
* @name getApplicationThemesCount
|
|
98
98
|
* @summary: Get sales channel themes count
|
|
99
|
-
* @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://
|
|
99
|
+
* @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getApplicationThemesCount/).
|
|
100
100
|
*/
|
|
101
101
|
getApplicationThemesCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
102
102
|
/**
|
|
@@ -106,7 +106,7 @@ declare class Theme {
|
|
|
106
106
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
107
107
|
* @name getAppliedTheme
|
|
108
108
|
* @summary: Get applied theme
|
|
109
|
-
* @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://
|
|
109
|
+
* @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getAppliedTheme/).
|
|
110
110
|
*/
|
|
111
111
|
getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
112
112
|
/**
|
|
@@ -118,7 +118,7 @@ declare class Theme {
|
|
|
118
118
|
* @returns {Promise<ThemePlatformModel.GetExtensionSectionRes[]>} - Success response
|
|
119
119
|
* @name getExtensionSections
|
|
120
120
|
* @summary: Get extension sections
|
|
121
|
-
* @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://
|
|
121
|
+
* @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getExtensionSections/).
|
|
122
122
|
*/
|
|
123
123
|
getExtensionSections({ type, companyMode, requestHeaders }?: ThemePlatformApplicationValidator.GetExtensionSectionsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.GetExtensionSectionRes[]>;
|
|
124
124
|
/**
|
|
@@ -128,9 +128,9 @@ declare class Theme {
|
|
|
128
128
|
* @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
|
|
129
129
|
* @name getFonts
|
|
130
130
|
* @summary: List theme fonts
|
|
131
|
-
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://
|
|
131
|
+
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getFonts/).
|
|
132
132
|
*/
|
|
133
|
-
getFonts({ requestHeaders }?:
|
|
133
|
+
getFonts({ capability, requestHeaders }?: ThemePlatformApplicationValidator.GetFontsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
|
|
134
134
|
/**
|
|
135
135
|
* @param {ThemePlatformApplicationValidator.GetPageParam} arg - Arg object
|
|
136
136
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -138,7 +138,7 @@ declare class Theme {
|
|
|
138
138
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
139
139
|
* @name getPage
|
|
140
140
|
* @summary: Get a page
|
|
141
|
-
* @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://
|
|
141
|
+
* @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getPage/).
|
|
142
142
|
*/
|
|
143
143
|
getPage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
144
144
|
/**
|
|
@@ -148,7 +148,7 @@ declare class Theme {
|
|
|
148
148
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
149
149
|
* @name getThemeById
|
|
150
150
|
* @summary: Get theme
|
|
151
|
-
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://
|
|
151
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeById/).
|
|
152
152
|
*/
|
|
153
153
|
getThemeById({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeByIdParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
154
154
|
/**
|
|
@@ -158,7 +158,7 @@ declare class Theme {
|
|
|
158
158
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
159
159
|
* @name getThemeForPreview
|
|
160
160
|
* @summary: Get theme for preview
|
|
161
|
-
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://
|
|
161
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeForPreview/).
|
|
162
162
|
*/
|
|
163
163
|
getThemeForPreview({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
164
164
|
/**
|
|
@@ -170,19 +170,19 @@ declare class Theme {
|
|
|
170
170
|
* @returns {Promise<any>} - Success response
|
|
171
171
|
* @name getThemeLastModified
|
|
172
172
|
* @summary: Get theme last modified date
|
|
173
|
-
* @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://
|
|
173
|
+
* @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/getThemeLastModified/).
|
|
174
174
|
*/
|
|
175
175
|
getThemeLastModified({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLastModifiedParam, { responseHeaders }?: object): Promise<any>;
|
|
176
176
|
/**
|
|
177
177
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
178
178
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ThemePlatformModel.
|
|
180
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
181
181
|
* @name isUpgradable
|
|
182
182
|
* @summary: Check theme is upgradable
|
|
183
|
-
* @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://docs.fynd.com/partners/commerce/sdk/platform/theme/isUpgradable/).
|
|
184
184
|
*/
|
|
185
|
-
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.
|
|
185
|
+
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
|
|
186
186
|
/**
|
|
187
187
|
* @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
|
|
188
188
|
* - Arg object
|
|
@@ -192,7 +192,7 @@ declare class Theme {
|
|
|
192
192
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
193
193
|
* @name updateMultiplePages
|
|
194
194
|
* @summary: Update theme pages
|
|
195
|
-
* @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://
|
|
195
|
+
* @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateMultiplePages/).
|
|
196
196
|
*/
|
|
197
197
|
updateMultiplePages({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateMultiplePagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
198
198
|
/**
|
|
@@ -202,9 +202,9 @@ declare class Theme {
|
|
|
202
202
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
203
203
|
* @name updatePage
|
|
204
204
|
* @summary: Update a page
|
|
205
|
-
* @description: Modify and update the content of a page. - Check out [method documentation](https://
|
|
205
|
+
* @description: Modify and update the content of a page. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updatePage/).
|
|
206
206
|
*/
|
|
207
|
-
updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
207
|
+
updatePage({ themeId, pageValue, socketId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
208
208
|
/**
|
|
209
209
|
* @param {ThemePlatformApplicationValidator.UpdateThemeParam} arg - Arg object
|
|
210
210
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -212,7 +212,7 @@ declare class Theme {
|
|
|
212
212
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
213
213
|
* @name updateTheme
|
|
214
214
|
* @summary: Update theme
|
|
215
|
-
* @description: Modify and update the content and settings of a theme. - Check out [method documentation](https://
|
|
215
|
+
* @description: Modify and update the content and settings of a theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateTheme/).
|
|
216
216
|
*/
|
|
217
217
|
updateTheme({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
218
218
|
/**
|
|
@@ -222,7 +222,7 @@ declare class Theme {
|
|
|
222
222
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
223
223
|
* @name updateThemeName
|
|
224
224
|
* @summary: Update theme name
|
|
225
|
-
* @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://
|
|
225
|
+
* @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/updateThemeName/).
|
|
226
226
|
*/
|
|
227
227
|
updateThemeName({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeNameParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
228
228
|
/**
|
|
@@ -232,7 +232,7 @@ declare class Theme {
|
|
|
232
232
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
233
233
|
* @name upgradeTheme
|
|
234
234
|
* @summary: Upgrade theme
|
|
235
|
-
* @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://
|
|
235
|
+
* @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/theme/upgradeTheme/).
|
|
236
236
|
*/
|
|
237
237
|
upgradeTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UpgradeThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
238
238
|
}
|