@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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 +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -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 +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/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
|
@@ -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,23 @@ 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
|
-
* @property {string} [original]
|
|
62
72
|
* @property {string} [hash]
|
|
63
73
|
* @property {string} [short_url]
|
|
74
|
+
* @property {string} [alias]
|
|
64
75
|
*/
|
|
65
76
|
/**
|
|
66
77
|
* @typedef ShortLinkRes
|
|
@@ -94,6 +105,8 @@ export = SharePlatformModel;
|
|
|
94
105
|
* @property {number} [current] - The current page number.
|
|
95
106
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
96
107
|
* @property {number} [size] - The number of items per page.
|
|
108
|
+
* @property {number} [total] - Total number of items.
|
|
109
|
+
* @property {number} [page] - Current page number
|
|
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,13 +205,31 @@ 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;
|
|
198
229
|
type UrlInfo = {
|
|
199
|
-
original?: string;
|
|
200
230
|
hash?: string;
|
|
201
231
|
short_url?: string;
|
|
232
|
+
alias?: string;
|
|
202
233
|
};
|
|
203
234
|
/** @returns {ShortLinkRes} */
|
|
204
235
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -258,6 +289,14 @@ type Page = {
|
|
|
258
289
|
* - The number of items per page.
|
|
259
290
|
*/
|
|
260
291
|
size?: number;
|
|
292
|
+
/**
|
|
293
|
+
* - Total number of items.
|
|
294
|
+
*/
|
|
295
|
+
total?: number;
|
|
296
|
+
/**
|
|
297
|
+
* - Current page number
|
|
298
|
+
*/
|
|
299
|
+
page?: number;
|
|
261
300
|
};
|
|
262
301
|
/** @returns {ShortLinkList} */
|
|
263
302
|
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,13 +64,25 @@ 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
|
/**
|
|
70
82
|
* @typedef UrlInfo
|
|
71
|
-
* @property {string} [original]
|
|
72
83
|
* @property {string} [hash]
|
|
73
84
|
* @property {string} [short_url]
|
|
85
|
+
* @property {string} [alias]
|
|
74
86
|
*/
|
|
75
87
|
|
|
76
88
|
/**
|
|
@@ -106,6 +118,8 @@ const Joi = require("joi");
|
|
|
106
118
|
* @property {number} [current] - The current page number.
|
|
107
119
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
108
120
|
* @property {number} [size] - The number of items per page.
|
|
121
|
+
* @property {number} [total] - Total number of items.
|
|
122
|
+
* @property {number} [page] - Current page number
|
|
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,15 +216,24 @@ 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
|
|
|
208
231
|
/** @returns {UrlInfo} */
|
|
209
232
|
static UrlInfo() {
|
|
210
233
|
return Joi.object({
|
|
211
|
-
original: Joi.string().allow(""),
|
|
212
234
|
hash: Joi.string().allow(""),
|
|
213
235
|
short_url: Joi.string().allow(""),
|
|
236
|
+
alias: Joi.string().allow(""),
|
|
214
237
|
});
|
|
215
238
|
}
|
|
216
239
|
|
|
@@ -229,7 +252,7 @@ class SharePlatformModel {
|
|
|
229
252
|
application: Joi.string().allow(""),
|
|
230
253
|
user_id: Joi.string().allow(""),
|
|
231
254
|
created_at: Joi.string().allow(""),
|
|
232
|
-
meta: Joi.any(),
|
|
255
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
233
256
|
updated_at: Joi.string().allow(""),
|
|
234
257
|
personalized: Joi.boolean(),
|
|
235
258
|
campaign: SharePlatformModel.CampaignShortLink(),
|
|
@@ -250,6 +273,8 @@ class SharePlatformModel {
|
|
|
250
273
|
current: Joi.number(),
|
|
251
274
|
type: Joi.string().allow("").required(),
|
|
252
275
|
size: Joi.number(),
|
|
276
|
+
total: Joi.number(),
|
|
277
|
+
page: Joi.number(),
|
|
253
278
|
});
|
|
254
279
|
}
|
|
255
280
|
|
|
@@ -177,12 +177,12 @@ declare class Theme {
|
|
|
177
177
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
178
178
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ThemePlatformModel.
|
|
180
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
181
181
|
* @name isUpgradable
|
|
182
182
|
* @summary: Check theme is upgradable
|
|
183
183
|
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
184
184
|
*/
|
|
185
|
-
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.
|
|
185
|
+
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
|
|
186
186
|
/**
|
|
187
187
|
* @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
|
|
188
188
|
* - Arg object
|
|
@@ -204,7 +204,7 @@ declare class Theme {
|
|
|
204
204
|
* @summary: Update a page
|
|
205
205
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
206
206
|
*/
|
|
207
|
-
updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
207
|
+
updatePage({ themeId, pageValue, socketId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
208
208
|
/**
|
|
209
209
|
* @param {ThemePlatformApplicationValidator.UpdateThemeParam} arg - Arg object
|
|
210
210
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1260,7 +1260,7 @@ class Theme {
|
|
|
1260
1260
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
1261
1261
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1262
1262
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1263
|
-
* @returns {Promise<ThemePlatformModel.
|
|
1263
|
+
* @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
|
|
1264
1264
|
* @name isUpgradable
|
|
1265
1265
|
* @summary: Check theme is upgradable
|
|
1266
1266
|
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
@@ -1314,7 +1314,7 @@ class Theme {
|
|
|
1314
1314
|
|
|
1315
1315
|
const {
|
|
1316
1316
|
error: res_error,
|
|
1317
|
-
} = ThemePlatformModel.
|
|
1317
|
+
} = ThemePlatformModel.ThemeUpgradable().validate(responseData, {
|
|
1318
1318
|
abortEarly: false,
|
|
1319
1319
|
allowUnknown: true,
|
|
1320
1320
|
});
|
|
@@ -1426,13 +1426,16 @@ class Theme {
|
|
|
1426
1426
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
1427
1427
|
*/
|
|
1428
1428
|
async updatePage(
|
|
1429
|
-
{ themeId, pageValue, body, requestHeaders } = {
|
|
1429
|
+
{ themeId, pageValue, socketId, body, requestHeaders } = {
|
|
1430
|
+
requestHeaders: {},
|
|
1431
|
+
},
|
|
1430
1432
|
{ responseHeaders } = { responseHeaders: false }
|
|
1431
1433
|
) {
|
|
1432
1434
|
const { error } = ThemePlatformApplicationValidator.updatePage().validate(
|
|
1433
1435
|
{
|
|
1434
1436
|
themeId,
|
|
1435
1437
|
pageValue,
|
|
1438
|
+
socketId,
|
|
1436
1439
|
body,
|
|
1437
1440
|
},
|
|
1438
1441
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -1448,6 +1451,7 @@ class Theme {
|
|
|
1448
1451
|
{
|
|
1449
1452
|
themeId,
|
|
1450
1453
|
pageValue,
|
|
1454
|
+
socketId,
|
|
1451
1455
|
body,
|
|
1452
1456
|
},
|
|
1453
1457
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -1464,7 +1468,7 @@ class Theme {
|
|
|
1464
1468
|
const response = await PlatformAPIClient.execute(
|
|
1465
1469
|
this.config,
|
|
1466
1470
|
"put",
|
|
1467
|
-
`/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/${themeId}/${pageValue}`,
|
|
1471
|
+
`/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/${themeId}/${pageValue}/${socketId}`,
|
|
1468
1472
|
query_params,
|
|
1469
1473
|
body,
|
|
1470
1474
|
requestHeaders,
|
|
@@ -68,6 +68,7 @@ export = ThemePlatformApplicationValidator;
|
|
|
68
68
|
* @typedef UpdatePageParam
|
|
69
69
|
* @property {string} themeId - ID of the theme
|
|
70
70
|
* @property {string} pageValue - Value of the page to be updated
|
|
71
|
+
* @property {string} socketId - Unique socket id for websocket
|
|
71
72
|
* @property {ThemePlatformModel.AvailablePageSchema} body
|
|
72
73
|
*/
|
|
73
74
|
/**
|
|
@@ -237,6 +238,10 @@ type UpdatePageParam = {
|
|
|
237
238
|
* - Value of the page to be updated
|
|
238
239
|
*/
|
|
239
240
|
pageValue: string;
|
|
241
|
+
/**
|
|
242
|
+
* - Unique socket id for websocket
|
|
243
|
+
*/
|
|
244
|
+
socketId: string;
|
|
240
245
|
body: ThemePlatformModel.AvailablePageSchema;
|
|
241
246
|
};
|
|
242
247
|
type UpdateThemeParam = {
|
|
@@ -89,6 +89,7 @@ const ThemePlatformModel = require("./ThemePlatformModel");
|
|
|
89
89
|
* @typedef UpdatePageParam
|
|
90
90
|
* @property {string} themeId - ID of the theme
|
|
91
91
|
* @property {string} pageValue - Value of the page to be updated
|
|
92
|
+
* @property {string} socketId - Unique socket id for websocket
|
|
92
93
|
* @property {ThemePlatformModel.AvailablePageSchema} body
|
|
93
94
|
*/
|
|
94
95
|
|
|
@@ -238,6 +239,7 @@ class ThemePlatformApplicationValidator {
|
|
|
238
239
|
return Joi.object({
|
|
239
240
|
themeId: Joi.string().allow("").required(),
|
|
240
241
|
pageValue: Joi.string().allow("").required(),
|
|
242
|
+
socketId: Joi.string().allow("").required(),
|
|
241
243
|
body: ThemePlatformModel.AvailablePageSchema().required(),
|
|
242
244
|
}).required();
|
|
243
245
|
}
|
|
@@ -135,7 +135,15 @@ export = ThemePlatformModel;
|
|
|
135
135
|
* @property {Object[]} [blocks]
|
|
136
136
|
* @property {Object} [preset]
|
|
137
137
|
* @property {AvailablePagePredicate} [predicate]
|
|
138
|
-
* @property {
|
|
138
|
+
* @property {SectionSource} [__source]
|
|
139
|
+
*/
|
|
140
|
+
/**
|
|
141
|
+
* @typedef SectionSource
|
|
142
|
+
* @property {string} [id] - The source id specifying the source of the section.
|
|
143
|
+
* @property {string} [bundle_name] - This is the extension binding name
|
|
144
|
+
* containing this section.
|
|
145
|
+
* @property {string} [type] - This is source type. It will either be
|
|
146
|
+
* themeBundle or extension.
|
|
139
147
|
*/
|
|
140
148
|
/**
|
|
141
149
|
* @typedef AvailablePagePredicate
|
|
@@ -237,7 +245,7 @@ export = ThemePlatformModel;
|
|
|
237
245
|
* @property {string} [src]
|
|
238
246
|
*/
|
|
239
247
|
/**
|
|
240
|
-
* @typedef
|
|
248
|
+
* @typedef ThemeUpgradable
|
|
241
249
|
* @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
|
|
242
250
|
* @property {ThemeVersions} [versions]
|
|
243
251
|
* @property {string} [message] - A message describing the theme upgrade status
|
|
@@ -500,7 +508,7 @@ export = ThemePlatformModel;
|
|
|
500
508
|
* @property {string} [applied_theme] - The version of the applied theme
|
|
501
509
|
*/
|
|
502
510
|
/**
|
|
503
|
-
* @typedef
|
|
511
|
+
* @typedef DummyTheme
|
|
504
512
|
* @property {string} [message]
|
|
505
513
|
*/
|
|
506
514
|
/**
|
|
@@ -581,7 +589,7 @@ export = ThemePlatformModel;
|
|
|
581
589
|
declare class ThemePlatformModel {
|
|
582
590
|
}
|
|
583
591
|
declare namespace ThemePlatformModel {
|
|
584
|
-
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema,
|
|
592
|
+
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
|
|
585
593
|
}
|
|
586
594
|
/** @returns {GetExtensionSectionRes} */
|
|
587
595
|
declare function GetExtensionSectionRes(): GetExtensionSectionRes;
|
|
@@ -798,7 +806,25 @@ type AvailablePageSchemaSections = {
|
|
|
798
806
|
blocks?: any[];
|
|
799
807
|
preset?: any;
|
|
800
808
|
predicate?: AvailablePagePredicate;
|
|
801
|
-
|
|
809
|
+
__source?: SectionSource;
|
|
810
|
+
};
|
|
811
|
+
/** @returns {SectionSource} */
|
|
812
|
+
declare function SectionSource(): SectionSource;
|
|
813
|
+
type SectionSource = {
|
|
814
|
+
/**
|
|
815
|
+
* - The source id specifying the source of the section.
|
|
816
|
+
*/
|
|
817
|
+
id?: string;
|
|
818
|
+
/**
|
|
819
|
+
* - This is the extension binding name
|
|
820
|
+
* containing this section.
|
|
821
|
+
*/
|
|
822
|
+
bundle_name?: string;
|
|
823
|
+
/**
|
|
824
|
+
* - This is source type. It will either be
|
|
825
|
+
* themeBundle or extension.
|
|
826
|
+
*/
|
|
827
|
+
type?: string;
|
|
802
828
|
};
|
|
803
829
|
/** @returns {AvailablePagePredicate} */
|
|
804
830
|
declare function AvailablePagePredicate(): AvailablePagePredicate;
|
|
@@ -967,9 +993,9 @@ type ThemesSchema = {
|
|
|
967
993
|
company_id?: number;
|
|
968
994
|
src?: string;
|
|
969
995
|
};
|
|
970
|
-
/** @returns {
|
|
971
|
-
declare function
|
|
972
|
-
type
|
|
996
|
+
/** @returns {ThemeUpgradable} */
|
|
997
|
+
declare function ThemeUpgradable(): ThemeUpgradable;
|
|
998
|
+
type ThemeUpgradable = {
|
|
973
999
|
/**
|
|
974
1000
|
* - Indicates if the theme is upgradable or not
|
|
975
1001
|
*/
|
|
@@ -1500,9 +1526,9 @@ type ThemeVersions = {
|
|
|
1500
1526
|
*/
|
|
1501
1527
|
applied_theme?: string;
|
|
1502
1528
|
};
|
|
1503
|
-
/** @returns {
|
|
1504
|
-
declare function
|
|
1505
|
-
type
|
|
1529
|
+
/** @returns {DummyTheme} */
|
|
1530
|
+
declare function DummyTheme(): DummyTheme;
|
|
1531
|
+
type DummyTheme = {
|
|
1506
1532
|
message?: string;
|
|
1507
1533
|
};
|
|
1508
1534
|
/** @returns {AppliedThemes} */
|
|
@@ -154,7 +154,16 @@ const Joi = require("joi");
|
|
|
154
154
|
* @property {Object[]} [blocks]
|
|
155
155
|
* @property {Object} [preset]
|
|
156
156
|
* @property {AvailablePagePredicate} [predicate]
|
|
157
|
-
* @property {
|
|
157
|
+
* @property {SectionSource} [__source]
|
|
158
|
+
*/
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* @typedef SectionSource
|
|
162
|
+
* @property {string} [id] - The source id specifying the source of the section.
|
|
163
|
+
* @property {string} [bundle_name] - This is the extension binding name
|
|
164
|
+
* containing this section.
|
|
165
|
+
* @property {string} [type] - This is source type. It will either be
|
|
166
|
+
* themeBundle or extension.
|
|
158
167
|
*/
|
|
159
168
|
|
|
160
169
|
/**
|
|
@@ -271,7 +280,7 @@ const Joi = require("joi");
|
|
|
271
280
|
*/
|
|
272
281
|
|
|
273
282
|
/**
|
|
274
|
-
* @typedef
|
|
283
|
+
* @typedef ThemeUpgradable
|
|
275
284
|
* @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
|
|
276
285
|
* @property {ThemeVersions} [versions]
|
|
277
286
|
* @property {string} [message] - A message describing the theme upgrade status
|
|
@@ -576,7 +585,7 @@ const Joi = require("joi");
|
|
|
576
585
|
*/
|
|
577
586
|
|
|
578
587
|
/**
|
|
579
|
-
* @typedef
|
|
588
|
+
* @typedef DummyTheme
|
|
580
589
|
* @property {string} [message]
|
|
581
590
|
*/
|
|
582
591
|
|
|
@@ -787,7 +796,7 @@ class ThemePlatformModel {
|
|
|
787
796
|
/** @returns {AvailablePageSectionMetaAttributes} */
|
|
788
797
|
static AvailablePageSectionMetaAttributes() {
|
|
789
798
|
return Joi.object({
|
|
790
|
-
attributes: Joi.any(),
|
|
799
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
791
800
|
});
|
|
792
801
|
}
|
|
793
802
|
|
|
@@ -849,11 +858,20 @@ class ThemePlatformModel {
|
|
|
849
858
|
return Joi.object({
|
|
850
859
|
name: Joi.string().allow(""),
|
|
851
860
|
label: Joi.string().allow(""),
|
|
852
|
-
props: Joi.any(),
|
|
861
|
+
props: Joi.object().pattern(/\S/, Joi.any()),
|
|
853
862
|
blocks: Joi.array().items(Joi.any()),
|
|
854
|
-
preset: Joi.any(),
|
|
863
|
+
preset: Joi.object().pattern(/\S/, Joi.any()),
|
|
855
864
|
predicate: ThemePlatformModel.AvailablePagePredicate(),
|
|
856
|
-
|
|
865
|
+
__source: ThemePlatformModel.SectionSource(),
|
|
866
|
+
});
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
/** @returns {SectionSource} */
|
|
870
|
+
static SectionSource() {
|
|
871
|
+
return Joi.object({
|
|
872
|
+
id: Joi.string().allow(""),
|
|
873
|
+
bundle_name: Joi.string().allow(""),
|
|
874
|
+
type: Joi.string().allow(""),
|
|
857
875
|
});
|
|
858
876
|
}
|
|
859
877
|
|
|
@@ -891,7 +909,7 @@ class ThemePlatformModel {
|
|
|
891
909
|
return Joi.object({
|
|
892
910
|
selected: Joi.string().allow(""),
|
|
893
911
|
exact_url: Joi.string().allow(""),
|
|
894
|
-
query: Joi.any(),
|
|
912
|
+
query: Joi.object().pattern(/\S/, Joi.any()),
|
|
895
913
|
});
|
|
896
914
|
}
|
|
897
915
|
|
|
@@ -987,7 +1005,7 @@ class ThemePlatformModel {
|
|
|
987
1005
|
name: Joi.string().allow(""),
|
|
988
1006
|
template_theme_id: Joi.string().allow(""),
|
|
989
1007
|
version: Joi.string().allow(""),
|
|
990
|
-
styles: Joi.any(),
|
|
1008
|
+
styles: Joi.object().pattern(/\S/, Joi.any()),
|
|
991
1009
|
created_at: Joi.string().allow(""),
|
|
992
1010
|
updated_at: Joi.string().allow(""),
|
|
993
1011
|
assets: ThemePlatformModel.Assets(),
|
|
@@ -998,8 +1016,8 @@ class ThemePlatformModel {
|
|
|
998
1016
|
});
|
|
999
1017
|
}
|
|
1000
1018
|
|
|
1001
|
-
/** @returns {
|
|
1002
|
-
static
|
|
1019
|
+
/** @returns {ThemeUpgradable} */
|
|
1020
|
+
static ThemeUpgradable() {
|
|
1003
1021
|
return Joi.object({
|
|
1004
1022
|
upgrade: Joi.boolean(),
|
|
1005
1023
|
versions: ThemePlatformModel.ThemeVersions(),
|
|
@@ -1065,7 +1083,7 @@ class ThemePlatformModel {
|
|
|
1065
1083
|
static ThemeConfiguration() {
|
|
1066
1084
|
return Joi.object({
|
|
1067
1085
|
name: Joi.string().allow(""),
|
|
1068
|
-
global_config: Joi.any(),
|
|
1086
|
+
global_config: Joi.object().pattern(/\S/, Joi.any()),
|
|
1069
1087
|
page: Joi.array().items(ThemePlatformModel.ThemeConfigListPage()),
|
|
1070
1088
|
});
|
|
1071
1089
|
}
|
|
@@ -1117,7 +1135,7 @@ class ThemePlatformModel {
|
|
|
1117
1135
|
/** @returns {ThemeConfigListPageSettingsProps} */
|
|
1118
1136
|
static ThemeConfigListPageSettingsProps() {
|
|
1119
1137
|
return Joi.object({
|
|
1120
|
-
props: Joi.any(),
|
|
1138
|
+
props: Joi.object().pattern(/\S/, Joi.any()),
|
|
1121
1139
|
});
|
|
1122
1140
|
}
|
|
1123
1141
|
|
|
@@ -1384,8 +1402,8 @@ class ThemePlatformModel {
|
|
|
1384
1402
|
});
|
|
1385
1403
|
}
|
|
1386
1404
|
|
|
1387
|
-
/** @returns {
|
|
1388
|
-
static
|
|
1405
|
+
/** @returns {DummyTheme} */
|
|
1406
|
+
static DummyTheme() {
|
|
1389
1407
|
return Joi.object({
|
|
1390
1408
|
message: Joi.string().allow(""),
|
|
1391
1409
|
});
|
|
@@ -39,13 +39,13 @@ declare class User {
|
|
|
39
39
|
*
|
|
40
40
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
41
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
|
-
* @returns {Promise<UserPlatformModel.
|
|
42
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionDetails>} -
|
|
43
43
|
* Success response
|
|
44
44
|
* @name createUserAttributeDefinition
|
|
45
45
|
* @summary: Create a User Attribute Definition
|
|
46
46
|
* @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
|
|
47
47
|
*/
|
|
48
|
-
createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
48
|
+
createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionDetails>;
|
|
49
49
|
/**
|
|
50
50
|
* @param {UserPlatformApplicationValidator.CreateUserGroupParam} arg - Arg object
|
|
51
51
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -95,24 +95,24 @@ declare class User {
|
|
|
95
95
|
* @param {UserPlatformApplicationValidator.DeleteUserAttributeParam} arg - Arg object
|
|
96
96
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
97
97
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
98
|
-
* @returns {Promise<UserPlatformModel.
|
|
98
|
+
* @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
|
|
99
99
|
* @name deleteUserAttribute
|
|
100
100
|
* @summary: Delete User Attribute
|
|
101
101
|
* @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
|
|
102
102
|
*/
|
|
103
|
-
deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
103
|
+
deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
|
|
104
104
|
/**
|
|
105
105
|
* @param {UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam} arg
|
|
106
106
|
* - Arg object
|
|
107
107
|
*
|
|
108
108
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
|
-
* @returns {Promise<UserPlatformModel.
|
|
110
|
+
* @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
|
|
111
111
|
* @name deleteUserAttributeDefinitionById
|
|
112
112
|
* @summary: Delete User Attribute Definition
|
|
113
113
|
* @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttributeDefinitionById/).
|
|
114
114
|
*/
|
|
115
|
-
deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
115
|
+
deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
|
|
116
116
|
/**
|
|
117
117
|
* @param {UserPlatformApplicationValidator.GetActiveSessionsParam} arg - Arg object
|
|
118
118
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -147,24 +147,24 @@ declare class User {
|
|
|
147
147
|
* @param {UserPlatformApplicationValidator.GetUserAttributeParam} arg - Arg object
|
|
148
148
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
149
149
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
|
-
* @returns {Promise<UserPlatformModel.
|
|
150
|
+
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
151
151
|
* @name getUserAttribute
|
|
152
152
|
* @summary: Get User Attribute
|
|
153
153
|
* @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
|
|
154
154
|
*/
|
|
155
|
-
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
155
|
+
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
156
156
|
/**
|
|
157
157
|
* @param {UserPlatformApplicationValidator.GetUserAttributeByIdParam} arg
|
|
158
158
|
* - Arg object
|
|
159
159
|
*
|
|
160
160
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
161
161
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
162
|
-
* @returns {Promise<UserPlatformModel.
|
|
162
|
+
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
163
163
|
* @name getUserAttributeById
|
|
164
164
|
* @summary: Get User Attribute
|
|
165
165
|
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
|
|
166
166
|
*/
|
|
167
|
-
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
167
|
+
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
168
168
|
/**
|
|
169
169
|
* @param {UserPlatformApplicationValidator.GetUserAttributeDefinitionByIdParam} arg
|
|
170
170
|
* - Arg object
|
|
@@ -268,12 +268,12 @@ declare class User {
|
|
|
268
268
|
* @param {UserPlatformApplicationValidator.UpdateUserAttributeParam} arg - Arg object
|
|
269
269
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
270
270
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
271
|
-
* @returns {Promise<UserPlatformModel.
|
|
271
|
+
* @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
|
|
272
272
|
* @name updateUserAttribute
|
|
273
273
|
* @summary: Update Or Create User Attribute
|
|
274
274
|
* @description: Update Or Create User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttribute/).
|
|
275
275
|
*/
|
|
276
|
-
updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.
|
|
276
|
+
updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
|
|
277
277
|
/**
|
|
278
278
|
* @param {UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam} arg
|
|
279
279
|
* - Arg object
|