@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-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 +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +304 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +437 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +22 -1
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +157 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +297 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +50 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +74 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +159 -87
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +195 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +473 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +75 -7
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +66 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +418 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +16 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- 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 +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
- package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- 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 +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
- package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
- 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 +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +21 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +20 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -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/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -105
|
@@ -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.ThemeUpgradableResponse>} - 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.ThemeUpgradableResponse().validate(responseData, {
|
|
1318
1318
|
abortEarly: false,
|
|
1319
1319
|
allowUnknown: true,
|
|
1320
1320
|
});
|
|
@@ -1426,16 +1426,13 @@ 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,
|
|
1430
|
-
requestHeaders: {},
|
|
1431
|
-
},
|
|
1429
|
+
{ themeId, pageValue, body, requestHeaders } = { requestHeaders: {} },
|
|
1432
1430
|
{ responseHeaders } = { responseHeaders: false }
|
|
1433
1431
|
) {
|
|
1434
1432
|
const { error } = ThemePlatformApplicationValidator.updatePage().validate(
|
|
1435
1433
|
{
|
|
1436
1434
|
themeId,
|
|
1437
1435
|
pageValue,
|
|
1438
|
-
socketId,
|
|
1439
1436
|
body,
|
|
1440
1437
|
},
|
|
1441
1438
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -1451,7 +1448,6 @@ class Theme {
|
|
|
1451
1448
|
{
|
|
1452
1449
|
themeId,
|
|
1453
1450
|
pageValue,
|
|
1454
|
-
socketId,
|
|
1455
1451
|
body,
|
|
1456
1452
|
},
|
|
1457
1453
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -1468,7 +1464,7 @@ class Theme {
|
|
|
1468
1464
|
const response = await PlatformAPIClient.execute(
|
|
1469
1465
|
this.config,
|
|
1470
1466
|
"put",
|
|
1471
|
-
`/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/${themeId}/${pageValue}
|
|
1467
|
+
`/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/${themeId}/${pageValue}`,
|
|
1472
1468
|
query_params,
|
|
1473
1469
|
body,
|
|
1474
1470
|
requestHeaders,
|
|
@@ -68,7 +68,6 @@ 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
|
|
72
71
|
* @property {ThemePlatformModel.AvailablePageSchema} body
|
|
73
72
|
*/
|
|
74
73
|
/**
|
|
@@ -238,10 +237,6 @@ type UpdatePageParam = {
|
|
|
238
237
|
* - Value of the page to be updated
|
|
239
238
|
*/
|
|
240
239
|
pageValue: string;
|
|
241
|
-
/**
|
|
242
|
-
* - Unique socket id for websocket
|
|
243
|
-
*/
|
|
244
|
-
socketId: string;
|
|
245
240
|
body: ThemePlatformModel.AvailablePageSchema;
|
|
246
241
|
};
|
|
247
242
|
type UpdateThemeParam = {
|
|
@@ -89,7 +89,6 @@ 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
|
|
93
92
|
* @property {ThemePlatformModel.AvailablePageSchema} body
|
|
94
93
|
*/
|
|
95
94
|
|
|
@@ -239,7 +238,6 @@ class ThemePlatformApplicationValidator {
|
|
|
239
238
|
return Joi.object({
|
|
240
239
|
themeId: Joi.string().allow("").required(),
|
|
241
240
|
pageValue: Joi.string().allow("").required(),
|
|
242
|
-
socketId: Joi.string().allow("").required(),
|
|
243
241
|
body: ThemePlatformModel.AvailablePageSchema().required(),
|
|
244
242
|
}).required();
|
|
245
243
|
}
|
|
@@ -135,15 +135,7 @@ export = ThemePlatformModel;
|
|
|
135
135
|
* @property {Object[]} [blocks]
|
|
136
136
|
* @property {Object} [preset]
|
|
137
137
|
* @property {AvailablePagePredicate} [predicate]
|
|
138
|
-
* @property {
|
|
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.
|
|
138
|
+
* @property {string} [source]
|
|
147
139
|
*/
|
|
148
140
|
/**
|
|
149
141
|
* @typedef AvailablePagePredicate
|
|
@@ -245,7 +237,7 @@ export = ThemePlatformModel;
|
|
|
245
237
|
* @property {string} [src]
|
|
246
238
|
*/
|
|
247
239
|
/**
|
|
248
|
-
* @typedef
|
|
240
|
+
* @typedef ThemeUpgradableResponse
|
|
249
241
|
* @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
|
|
250
242
|
* @property {ThemeVersions} [versions]
|
|
251
243
|
* @property {string} [message] - A message describing the theme upgrade status
|
|
@@ -387,16 +379,7 @@ export = ThemePlatformModel;
|
|
|
387
379
|
*/
|
|
388
380
|
/**
|
|
389
381
|
* @typedef GlobalSchema
|
|
390
|
-
* @property {
|
|
391
|
-
*/
|
|
392
|
-
/**
|
|
393
|
-
* @typedef Prop
|
|
394
|
-
* @property {string} [type] - The type of the property
|
|
395
|
-
* @property {string} [category] - The category of the property
|
|
396
|
-
* @property {string} [value] - The value of the property
|
|
397
|
-
* @property {string} [id] - The ID of the property
|
|
398
|
-
* @property {string} [label] - The label of the property
|
|
399
|
-
* @property {string} [info] - Additional information about the property
|
|
382
|
+
* @property {Object[]} [props]
|
|
400
383
|
*/
|
|
401
384
|
/**
|
|
402
385
|
* @typedef Assets
|
|
@@ -517,7 +500,7 @@ export = ThemePlatformModel;
|
|
|
517
500
|
* @property {string} [applied_theme] - The version of the applied theme
|
|
518
501
|
*/
|
|
519
502
|
/**
|
|
520
|
-
* @typedef
|
|
503
|
+
* @typedef DummyResponse
|
|
521
504
|
* @property {string} [message]
|
|
522
505
|
*/
|
|
523
506
|
/**
|
|
@@ -598,7 +581,7 @@ export = ThemePlatformModel;
|
|
|
598
581
|
declare class ThemePlatformModel {
|
|
599
582
|
}
|
|
600
583
|
declare namespace ThemePlatformModel {
|
|
601
|
-
export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections,
|
|
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, ThemeUpgradableResponse, 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, DummyResponse, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
|
|
602
585
|
}
|
|
603
586
|
/** @returns {GetExtensionSectionRes} */
|
|
604
587
|
declare function GetExtensionSectionRes(): GetExtensionSectionRes;
|
|
@@ -815,25 +798,7 @@ type AvailablePageSchemaSections = {
|
|
|
815
798
|
blocks?: any[];
|
|
816
799
|
preset?: any;
|
|
817
800
|
predicate?: AvailablePagePredicate;
|
|
818
|
-
|
|
819
|
-
};
|
|
820
|
-
/** @returns {SectionSource} */
|
|
821
|
-
declare function SectionSource(): SectionSource;
|
|
822
|
-
type SectionSource = {
|
|
823
|
-
/**
|
|
824
|
-
* - The source id specifying the source of the section.
|
|
825
|
-
*/
|
|
826
|
-
id?: string;
|
|
827
|
-
/**
|
|
828
|
-
* - This is the extension binding name
|
|
829
|
-
* containing this section.
|
|
830
|
-
*/
|
|
831
|
-
bundle_name?: string;
|
|
832
|
-
/**
|
|
833
|
-
* - This is source type. It will either be
|
|
834
|
-
* themeBundle or extension.
|
|
835
|
-
*/
|
|
836
|
-
type?: string;
|
|
801
|
+
source?: string;
|
|
837
802
|
};
|
|
838
803
|
/** @returns {AvailablePagePredicate} */
|
|
839
804
|
declare function AvailablePagePredicate(): AvailablePagePredicate;
|
|
@@ -1002,9 +967,9 @@ type ThemesSchema = {
|
|
|
1002
967
|
company_id?: number;
|
|
1003
968
|
src?: string;
|
|
1004
969
|
};
|
|
1005
|
-
/** @returns {
|
|
1006
|
-
declare function
|
|
1007
|
-
type
|
|
970
|
+
/** @returns {ThemeUpgradableResponse} */
|
|
971
|
+
declare function ThemeUpgradableResponse(): ThemeUpgradableResponse;
|
|
972
|
+
type ThemeUpgradableResponse = {
|
|
1008
973
|
/**
|
|
1009
974
|
* - Indicates if the theme is upgradable or not
|
|
1010
975
|
*/
|
|
@@ -1312,35 +1277,7 @@ type CustomProps = {
|
|
|
1312
1277
|
/** @returns {GlobalSchema} */
|
|
1313
1278
|
declare function GlobalSchema(): GlobalSchema;
|
|
1314
1279
|
type GlobalSchema = {
|
|
1315
|
-
props?:
|
|
1316
|
-
};
|
|
1317
|
-
/** @returns {Prop} */
|
|
1318
|
-
declare function Prop(): Prop;
|
|
1319
|
-
type Prop = {
|
|
1320
|
-
/**
|
|
1321
|
-
* - The type of the property
|
|
1322
|
-
*/
|
|
1323
|
-
type?: string;
|
|
1324
|
-
/**
|
|
1325
|
-
* - The category of the property
|
|
1326
|
-
*/
|
|
1327
|
-
category?: string;
|
|
1328
|
-
/**
|
|
1329
|
-
* - The value of the property
|
|
1330
|
-
*/
|
|
1331
|
-
value?: string;
|
|
1332
|
-
/**
|
|
1333
|
-
* - The ID of the property
|
|
1334
|
-
*/
|
|
1335
|
-
id?: string;
|
|
1336
|
-
/**
|
|
1337
|
-
* - The label of the property
|
|
1338
|
-
*/
|
|
1339
|
-
label?: string;
|
|
1340
|
-
/**
|
|
1341
|
-
* - Additional information about the property
|
|
1342
|
-
*/
|
|
1343
|
-
info?: string;
|
|
1280
|
+
props?: any[];
|
|
1344
1281
|
};
|
|
1345
1282
|
/** @returns {Assets} */
|
|
1346
1283
|
declare function Assets(): Assets;
|
|
@@ -1563,9 +1500,9 @@ type ThemeVersions = {
|
|
|
1563
1500
|
*/
|
|
1564
1501
|
applied_theme?: string;
|
|
1565
1502
|
};
|
|
1566
|
-
/** @returns {
|
|
1567
|
-
declare function
|
|
1568
|
-
type
|
|
1503
|
+
/** @returns {DummyResponse} */
|
|
1504
|
+
declare function DummyResponse(): DummyResponse;
|
|
1505
|
+
type DummyResponse = {
|
|
1569
1506
|
message?: string;
|
|
1570
1507
|
};
|
|
1571
1508
|
/** @returns {AppliedThemes} */
|
|
@@ -154,16 +154,7 @@ const Joi = require("joi");
|
|
|
154
154
|
* @property {Object[]} [blocks]
|
|
155
155
|
* @property {Object} [preset]
|
|
156
156
|
* @property {AvailablePagePredicate} [predicate]
|
|
157
|
-
* @property {
|
|
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.
|
|
157
|
+
* @property {string} [source]
|
|
167
158
|
*/
|
|
168
159
|
|
|
169
160
|
/**
|
|
@@ -280,7 +271,7 @@ const Joi = require("joi");
|
|
|
280
271
|
*/
|
|
281
272
|
|
|
282
273
|
/**
|
|
283
|
-
* @typedef
|
|
274
|
+
* @typedef ThemeUpgradableResponse
|
|
284
275
|
* @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
|
|
285
276
|
* @property {ThemeVersions} [versions]
|
|
286
277
|
* @property {string} [message] - A message describing the theme upgrade status
|
|
@@ -441,17 +432,7 @@ const Joi = require("joi");
|
|
|
441
432
|
|
|
442
433
|
/**
|
|
443
434
|
* @typedef GlobalSchema
|
|
444
|
-
* @property {
|
|
445
|
-
*/
|
|
446
|
-
|
|
447
|
-
/**
|
|
448
|
-
* @typedef Prop
|
|
449
|
-
* @property {string} [type] - The type of the property
|
|
450
|
-
* @property {string} [category] - The category of the property
|
|
451
|
-
* @property {string} [value] - The value of the property
|
|
452
|
-
* @property {string} [id] - The ID of the property
|
|
453
|
-
* @property {string} [label] - The label of the property
|
|
454
|
-
* @property {string} [info] - Additional information about the property
|
|
435
|
+
* @property {Object[]} [props]
|
|
455
436
|
*/
|
|
456
437
|
|
|
457
438
|
/**
|
|
@@ -595,7 +576,7 @@ const Joi = require("joi");
|
|
|
595
576
|
*/
|
|
596
577
|
|
|
597
578
|
/**
|
|
598
|
-
* @typedef
|
|
579
|
+
* @typedef DummyResponse
|
|
599
580
|
* @property {string} [message]
|
|
600
581
|
*/
|
|
601
582
|
|
|
@@ -806,7 +787,7 @@ class ThemePlatformModel {
|
|
|
806
787
|
/** @returns {AvailablePageSectionMetaAttributes} */
|
|
807
788
|
static AvailablePageSectionMetaAttributes() {
|
|
808
789
|
return Joi.object({
|
|
809
|
-
attributes: Joi.
|
|
790
|
+
attributes: Joi.any(),
|
|
810
791
|
});
|
|
811
792
|
}
|
|
812
793
|
|
|
@@ -868,20 +849,11 @@ class ThemePlatformModel {
|
|
|
868
849
|
return Joi.object({
|
|
869
850
|
name: Joi.string().allow(""),
|
|
870
851
|
label: Joi.string().allow(""),
|
|
871
|
-
props: Joi.
|
|
852
|
+
props: Joi.any(),
|
|
872
853
|
blocks: Joi.array().items(Joi.any()),
|
|
873
|
-
preset: Joi.
|
|
854
|
+
preset: Joi.any(),
|
|
874
855
|
predicate: ThemePlatformModel.AvailablePagePredicate(),
|
|
875
|
-
|
|
876
|
-
});
|
|
877
|
-
}
|
|
878
|
-
|
|
879
|
-
/** @returns {SectionSource} */
|
|
880
|
-
static SectionSource() {
|
|
881
|
-
return Joi.object({
|
|
882
|
-
id: Joi.string().allow(""),
|
|
883
|
-
bundle_name: Joi.string().allow(""),
|
|
884
|
-
type: Joi.string().allow(""),
|
|
856
|
+
source: Joi.string().allow(""),
|
|
885
857
|
});
|
|
886
858
|
}
|
|
887
859
|
|
|
@@ -919,7 +891,7 @@ class ThemePlatformModel {
|
|
|
919
891
|
return Joi.object({
|
|
920
892
|
selected: Joi.string().allow(""),
|
|
921
893
|
exact_url: Joi.string().allow(""),
|
|
922
|
-
query: Joi.
|
|
894
|
+
query: Joi.any(),
|
|
923
895
|
});
|
|
924
896
|
}
|
|
925
897
|
|
|
@@ -1015,7 +987,7 @@ class ThemePlatformModel {
|
|
|
1015
987
|
name: Joi.string().allow(""),
|
|
1016
988
|
template_theme_id: Joi.string().allow(""),
|
|
1017
989
|
version: Joi.string().allow(""),
|
|
1018
|
-
styles: Joi.
|
|
990
|
+
styles: Joi.any(),
|
|
1019
991
|
created_at: Joi.string().allow(""),
|
|
1020
992
|
updated_at: Joi.string().allow(""),
|
|
1021
993
|
assets: ThemePlatformModel.Assets(),
|
|
@@ -1026,8 +998,8 @@ class ThemePlatformModel {
|
|
|
1026
998
|
});
|
|
1027
999
|
}
|
|
1028
1000
|
|
|
1029
|
-
/** @returns {
|
|
1030
|
-
static
|
|
1001
|
+
/** @returns {ThemeUpgradableResponse} */
|
|
1002
|
+
static ThemeUpgradableResponse() {
|
|
1031
1003
|
return Joi.object({
|
|
1032
1004
|
upgrade: Joi.boolean(),
|
|
1033
1005
|
versions: ThemePlatformModel.ThemeVersions(),
|
|
@@ -1093,7 +1065,7 @@ class ThemePlatformModel {
|
|
|
1093
1065
|
static ThemeConfiguration() {
|
|
1094
1066
|
return Joi.object({
|
|
1095
1067
|
name: Joi.string().allow(""),
|
|
1096
|
-
global_config: Joi.
|
|
1068
|
+
global_config: Joi.any(),
|
|
1097
1069
|
page: Joi.array().items(ThemePlatformModel.ThemeConfigListPage()),
|
|
1098
1070
|
});
|
|
1099
1071
|
}
|
|
@@ -1145,7 +1117,7 @@ class ThemePlatformModel {
|
|
|
1145
1117
|
/** @returns {ThemeConfigListPageSettingsProps} */
|
|
1146
1118
|
static ThemeConfigListPageSettingsProps() {
|
|
1147
1119
|
return Joi.object({
|
|
1148
|
-
props: Joi.
|
|
1120
|
+
props: Joi.any(),
|
|
1149
1121
|
});
|
|
1150
1122
|
}
|
|
1151
1123
|
|
|
@@ -1224,19 +1196,7 @@ class ThemePlatformModel {
|
|
|
1224
1196
|
/** @returns {GlobalSchema} */
|
|
1225
1197
|
static GlobalSchema() {
|
|
1226
1198
|
return Joi.object({
|
|
1227
|
-
props: Joi.array().items(
|
|
1228
|
-
});
|
|
1229
|
-
}
|
|
1230
|
-
|
|
1231
|
-
/** @returns {Prop} */
|
|
1232
|
-
static Prop() {
|
|
1233
|
-
return Joi.object({
|
|
1234
|
-
type: Joi.string().allow(""),
|
|
1235
|
-
category: Joi.string().allow(""),
|
|
1236
|
-
value: Joi.string().allow(""),
|
|
1237
|
-
id: Joi.string().allow(""),
|
|
1238
|
-
label: Joi.string().allow(""),
|
|
1239
|
-
info: Joi.string().allow(""),
|
|
1199
|
+
props: Joi.array().items(Joi.any()),
|
|
1240
1200
|
});
|
|
1241
1201
|
}
|
|
1242
1202
|
|
|
@@ -1424,8 +1384,8 @@ class ThemePlatformModel {
|
|
|
1424
1384
|
});
|
|
1425
1385
|
}
|
|
1426
1386
|
|
|
1427
|
-
/** @returns {
|
|
1428
|
-
static
|
|
1387
|
+
/** @returns {DummyResponse} */
|
|
1388
|
+
static DummyResponse() {
|
|
1429
1389
|
return Joi.object({
|
|
1430
1390
|
message: Joi.string().allow(""),
|
|
1431
1391
|
});
|
|
@@ -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.UserAttributeDefinitionResponse>} -
|
|
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.UserAttributeDefinitionResponse>;
|
|
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.SuccessMessageResponse>} - 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.SuccessMessageResponse>;
|
|
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.SuccessMessageResponse>} - 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.SuccessMessageResponse>;
|
|
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.UserAttributeResponse>} - 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.UserAttributeResponse>;
|
|
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.UserAttributeResponse>} - 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.UserAttributeResponse>;
|
|
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.UserAttributeResponse>} - 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.UserAttributeResponse>;
|
|
277
277
|
/**
|
|
278
278
|
* @param {UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam} arg
|
|
279
279
|
* - Arg object
|
|
@@ -254,7 +254,7 @@ class User {
|
|
|
254
254
|
*
|
|
255
255
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
256
256
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
|
-
* @returns {Promise<UserPlatformModel.
|
|
257
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionResponse>} -
|
|
258
258
|
* Success response
|
|
259
259
|
* @name createUserAttributeDefinition
|
|
260
260
|
* @summary: Create a User Attribute Definition
|
|
@@ -311,7 +311,7 @@ class User {
|
|
|
311
311
|
|
|
312
312
|
const {
|
|
313
313
|
error: res_error,
|
|
314
|
-
} = UserPlatformModel.
|
|
314
|
+
} = UserPlatformModel.UserAttributeDefinitionResponse().validate(
|
|
315
315
|
responseData,
|
|
316
316
|
{ abortEarly: false, allowUnknown: true }
|
|
317
317
|
);
|
|
@@ -664,7 +664,7 @@ class User {
|
|
|
664
664
|
* @param {UserPlatformApplicationValidator.DeleteUserAttributeParam} arg - Arg object
|
|
665
665
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
666
666
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
667
|
-
* @returns {Promise<UserPlatformModel.
|
|
667
|
+
* @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
|
|
668
668
|
* @name deleteUserAttribute
|
|
669
669
|
* @summary: Delete User Attribute
|
|
670
670
|
* @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
|
|
@@ -716,7 +716,7 @@ class User {
|
|
|
716
716
|
|
|
717
717
|
const {
|
|
718
718
|
error: res_error,
|
|
719
|
-
} = UserPlatformModel.
|
|
719
|
+
} = UserPlatformModel.SuccessMessageResponse().validate(responseData, {
|
|
720
720
|
abortEarly: false,
|
|
721
721
|
allowUnknown: true,
|
|
722
722
|
});
|
|
@@ -741,7 +741,7 @@ class User {
|
|
|
741
741
|
*
|
|
742
742
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
743
743
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
744
|
-
* @returns {Promise<UserPlatformModel.
|
|
744
|
+
* @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
|
|
745
745
|
* @name deleteUserAttributeDefinitionById
|
|
746
746
|
* @summary: Delete User Attribute Definition
|
|
747
747
|
* @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttributeDefinitionById/).
|
|
@@ -793,7 +793,7 @@ class User {
|
|
|
793
793
|
|
|
794
794
|
const {
|
|
795
795
|
error: res_error,
|
|
796
|
-
} = UserPlatformModel.
|
|
796
|
+
} = UserPlatformModel.SuccessMessageResponse().validate(responseData, {
|
|
797
797
|
abortEarly: false,
|
|
798
798
|
allowUnknown: true,
|
|
799
799
|
});
|
|
@@ -1055,7 +1055,7 @@ class User {
|
|
|
1055
1055
|
* @param {UserPlatformApplicationValidator.GetUserAttributeParam} arg - Arg object
|
|
1056
1056
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1057
1057
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1058
|
-
* @returns {Promise<UserPlatformModel.
|
|
1058
|
+
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1059
1059
|
* @name getUserAttribute
|
|
1060
1060
|
* @summary: Get User Attribute
|
|
1061
1061
|
* @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
|
|
@@ -1107,7 +1107,7 @@ class User {
|
|
|
1107
1107
|
|
|
1108
1108
|
const {
|
|
1109
1109
|
error: res_error,
|
|
1110
|
-
} = UserPlatformModel.
|
|
1110
|
+
} = UserPlatformModel.UserAttributeResponse().validate(responseData, {
|
|
1111
1111
|
abortEarly: false,
|
|
1112
1112
|
allowUnknown: true,
|
|
1113
1113
|
});
|
|
@@ -1132,7 +1132,7 @@ class User {
|
|
|
1132
1132
|
*
|
|
1133
1133
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1134
1134
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1135
|
-
* @returns {Promise<UserPlatformModel.
|
|
1135
|
+
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1136
1136
|
* @name getUserAttributeById
|
|
1137
1137
|
* @summary: Get User Attribute
|
|
1138
1138
|
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
|
|
@@ -1184,7 +1184,7 @@ class User {
|
|
|
1184
1184
|
|
|
1185
1185
|
const {
|
|
1186
1186
|
error: res_error,
|
|
1187
|
-
} = UserPlatformModel.
|
|
1187
|
+
} = UserPlatformModel.UserAttributeResponse().validate(responseData, {
|
|
1188
1188
|
abortEarly: false,
|
|
1189
1189
|
allowUnknown: true,
|
|
1190
1190
|
});
|
|
@@ -1987,7 +1987,7 @@ class User {
|
|
|
1987
1987
|
* @param {UserPlatformApplicationValidator.UpdateUserAttributeParam} arg - Arg object
|
|
1988
1988
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1989
1989
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1990
|
-
* @returns {Promise<UserPlatformModel.
|
|
1990
|
+
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1991
1991
|
* @name updateUserAttribute
|
|
1992
1992
|
* @summary: Update Or Create User Attribute
|
|
1993
1993
|
* @description: Update Or Create User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttribute/).
|
|
@@ -2049,7 +2049,7 @@ class User {
|
|
|
2049
2049
|
|
|
2050
2050
|
const {
|
|
2051
2051
|
error: res_error,
|
|
2052
|
-
} = UserPlatformModel.
|
|
2052
|
+
} = UserPlatformModel.UserAttributeResponse().validate(responseData, {
|
|
2053
2053
|
abortEarly: false,
|
|
2054
2054
|
allowUnknown: true,
|
|
2055
2055
|
});
|
|
@@ -133,7 +133,7 @@ export = UserPlatformApplicationValidator;
|
|
|
133
133
|
* @property {string} attributeDefId - The unique identifier of the attribute
|
|
134
134
|
* definition to update.
|
|
135
135
|
* @property {string} userId - The unique identifier of the user to update.
|
|
136
|
-
* @property {UserPlatformModel.
|
|
136
|
+
* @property {UserPlatformModel.CreateUserAttributeRequest} body
|
|
137
137
|
*/
|
|
138
138
|
/**
|
|
139
139
|
* @typedef UpdateUserAttributeDefinitionParam
|
|
@@ -447,7 +447,7 @@ type UpdateUserAttributeParam = {
|
|
|
447
447
|
* - The unique identifier of the user to update.
|
|
448
448
|
*/
|
|
449
449
|
userId: string;
|
|
450
|
-
body: UserPlatformModel.
|
|
450
|
+
body: UserPlatformModel.CreateUserAttributeRequest;
|
|
451
451
|
};
|
|
452
452
|
type UpdateUserAttributeDefinitionParam = {
|
|
453
453
|
/**
|
|
@@ -160,7 +160,7 @@ const UserPlatformModel = require("./UserPlatformModel");
|
|
|
160
160
|
* @property {string} attributeDefId - The unique identifier of the attribute
|
|
161
161
|
* definition to update.
|
|
162
162
|
* @property {string} userId - The unique identifier of the user to update.
|
|
163
|
-
* @property {UserPlatformModel.
|
|
163
|
+
* @property {UserPlatformModel.CreateUserAttributeRequest} body
|
|
164
164
|
*/
|
|
165
165
|
|
|
166
166
|
/**
|
|
@@ -383,7 +383,7 @@ class UserPlatformApplicationValidator {
|
|
|
383
383
|
attributeDefId: Joi.string().allow("").required(),
|
|
384
384
|
userId: Joi.string().allow("").required(),
|
|
385
385
|
|
|
386
|
-
body: UserPlatformModel.
|
|
386
|
+
body: UserPlatformModel.CreateUserAttributeRequest().required(),
|
|
387
387
|
}).required();
|
|
388
388
|
}
|
|
389
389
|
|