@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
- package/sdk/application/Order/OrderApplicationClient.js +16 -12
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
- package/sdk/application/Order/OrderApplicationValidator.js +3 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +33 -19
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
- package/sdk/platform/Order/OrderPlatformClient.js +55 -44
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -83,16 +83,9 @@ export = ThemePlatformModel;
|
|
|
83
83
|
*/
|
|
84
84
|
/**
|
|
85
85
|
* @typedef Action
|
|
86
|
+
* @property {string} [type]
|
|
86
87
|
* @property {ActionPage} [page]
|
|
87
88
|
* @property {ActionPage} [popup]
|
|
88
|
-
* @property {string} [type]
|
|
89
|
-
*/
|
|
90
|
-
/**
|
|
91
|
-
* @typedef ActionPage
|
|
92
|
-
* @property {Object} [params]
|
|
93
|
-
* @property {Object} [query]
|
|
94
|
-
* @property {string} [url]
|
|
95
|
-
* @property {PageType} type
|
|
96
89
|
*/
|
|
97
90
|
/**
|
|
98
91
|
* @typedef AvailablePageSeo
|
|
@@ -399,13 +392,8 @@ export = ThemePlatformModel;
|
|
|
399
392
|
*/
|
|
400
393
|
/**
|
|
401
394
|
* @typedef Page
|
|
402
|
-
* @property {
|
|
403
|
-
* @property {string} [
|
|
404
|
-
* @property {boolean} [has_previous]
|
|
405
|
-
* @property {boolean} [has_next]
|
|
406
|
-
* @property {number} [current]
|
|
407
|
-
* @property {string} type
|
|
408
|
-
* @property {number} [size]
|
|
395
|
+
* @property {Section[]} [sections]
|
|
396
|
+
* @property {string} [value] - The value of the page.
|
|
409
397
|
*/
|
|
410
398
|
/**
|
|
411
399
|
* @typedef Section
|
|
@@ -511,6 +499,13 @@ export = ThemePlatformModel;
|
|
|
511
499
|
* @property {boolean} [is_private] - Whether the theme is private or not
|
|
512
500
|
* @property {CompanyThemeMeta} [meta]
|
|
513
501
|
*/
|
|
502
|
+
/**
|
|
503
|
+
* @typedef ActionPage
|
|
504
|
+
* @property {Object} [params]
|
|
505
|
+
* @property {Object} [query]
|
|
506
|
+
* @property {string} [url]
|
|
507
|
+
* @property {PageType} type
|
|
508
|
+
*/
|
|
514
509
|
/**
|
|
515
510
|
* @typedef {| "about-us"
|
|
516
511
|
* | "addresses"
|
|
@@ -562,7 +557,7 @@ export = ThemePlatformModel;
|
|
|
562
557
|
declare class ThemePlatformModel {
|
|
563
558
|
}
|
|
564
559
|
declare namespace ThemePlatformModel {
|
|
565
|
-
export { ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action,
|
|
560
|
+
export { 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, Prop, 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 };
|
|
566
561
|
}
|
|
567
562
|
/** @returns {ThemeReq} */
|
|
568
563
|
declare function ThemeReq(): ThemeReq;
|
|
@@ -718,17 +713,9 @@ type SEObreadcrumb = {
|
|
|
718
713
|
/** @returns {Action} */
|
|
719
714
|
declare function Action(): Action;
|
|
720
715
|
type Action = {
|
|
716
|
+
type?: string;
|
|
721
717
|
page?: ActionPage;
|
|
722
718
|
popup?: ActionPage;
|
|
723
|
-
type?: string;
|
|
724
|
-
};
|
|
725
|
-
/** @returns {ActionPage} */
|
|
726
|
-
declare function ActionPage(): ActionPage;
|
|
727
|
-
type ActionPage = {
|
|
728
|
-
params?: any;
|
|
729
|
-
query?: any;
|
|
730
|
-
url?: string;
|
|
731
|
-
type: PageType;
|
|
732
719
|
};
|
|
733
720
|
/** @returns {AvailablePageSeo} */
|
|
734
721
|
declare function AvailablePageSeo(): AvailablePageSeo;
|
|
@@ -1310,13 +1297,11 @@ type Preset = {
|
|
|
1310
1297
|
/** @returns {Page} */
|
|
1311
1298
|
declare function Page(): Page;
|
|
1312
1299
|
type Page = {
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
type: string;
|
|
1319
|
-
size?: number;
|
|
1300
|
+
sections?: Section[];
|
|
1301
|
+
/**
|
|
1302
|
+
* - The value of the page.
|
|
1303
|
+
*/
|
|
1304
|
+
value?: string;
|
|
1320
1305
|
};
|
|
1321
1306
|
/** @returns {Section} */
|
|
1322
1307
|
declare function Section(): Section;
|
|
@@ -1539,6 +1524,14 @@ type CompanyPrivateTheme = {
|
|
|
1539
1524
|
is_private?: boolean;
|
|
1540
1525
|
meta?: CompanyThemeMeta;
|
|
1541
1526
|
};
|
|
1527
|
+
/** @returns {ActionPage} */
|
|
1528
|
+
declare function ActionPage(): ActionPage;
|
|
1529
|
+
type ActionPage = {
|
|
1530
|
+
params?: any;
|
|
1531
|
+
query?: any;
|
|
1532
|
+
url?: string;
|
|
1533
|
+
type: PageType;
|
|
1534
|
+
};
|
|
1542
1535
|
/**
|
|
1543
1536
|
* Enum: PageType Used By: Theme
|
|
1544
1537
|
*
|
|
@@ -96,17 +96,9 @@ const Joi = require("joi");
|
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
98
|
* @typedef Action
|
|
99
|
+
* @property {string} [type]
|
|
99
100
|
* @property {ActionPage} [page]
|
|
100
101
|
* @property {ActionPage} [popup]
|
|
101
|
-
* @property {string} [type]
|
|
102
|
-
*/
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* @typedef ActionPage
|
|
106
|
-
* @property {Object} [params]
|
|
107
|
-
* @property {Object} [query]
|
|
108
|
-
* @property {string} [url]
|
|
109
|
-
* @property {PageType} type
|
|
110
102
|
*/
|
|
111
103
|
|
|
112
104
|
/**
|
|
@@ -457,13 +449,8 @@ const Joi = require("joi");
|
|
|
457
449
|
|
|
458
450
|
/**
|
|
459
451
|
* @typedef Page
|
|
460
|
-
* @property {
|
|
461
|
-
* @property {string} [
|
|
462
|
-
* @property {boolean} [has_previous]
|
|
463
|
-
* @property {boolean} [has_next]
|
|
464
|
-
* @property {number} [current]
|
|
465
|
-
* @property {string} type
|
|
466
|
-
* @property {number} [size]
|
|
452
|
+
* @property {Section[]} [sections]
|
|
453
|
+
* @property {string} [value] - The value of the page.
|
|
467
454
|
*/
|
|
468
455
|
|
|
469
456
|
/**
|
|
@@ -588,6 +575,14 @@ const Joi = require("joi");
|
|
|
588
575
|
* @property {CompanyThemeMeta} [meta]
|
|
589
576
|
*/
|
|
590
577
|
|
|
578
|
+
/**
|
|
579
|
+
* @typedef ActionPage
|
|
580
|
+
* @property {Object} [params]
|
|
581
|
+
* @property {Object} [query]
|
|
582
|
+
* @property {string} [url]
|
|
583
|
+
* @property {PageType} type
|
|
584
|
+
*/
|
|
585
|
+
|
|
591
586
|
/**
|
|
592
587
|
* @typedef {| "about-us"
|
|
593
588
|
* | "addresses"
|
|
@@ -761,25 +756,9 @@ class ThemePlatformModel {
|
|
|
761
756
|
/** @returns {Action} */
|
|
762
757
|
static Action() {
|
|
763
758
|
return Joi.object({
|
|
759
|
+
type: Joi.string().allow(""),
|
|
764
760
|
page: ThemePlatformModel.ActionPage(),
|
|
765
761
|
popup: ThemePlatformModel.ActionPage(),
|
|
766
|
-
type: Joi.string().allow(""),
|
|
767
|
-
});
|
|
768
|
-
}
|
|
769
|
-
|
|
770
|
-
/** @returns {ActionPage} */
|
|
771
|
-
static ActionPage() {
|
|
772
|
-
return Joi.object({
|
|
773
|
-
params: Joi.object().pattern(
|
|
774
|
-
/\S/,
|
|
775
|
-
Joi.array().items(Joi.string().allow(""))
|
|
776
|
-
),
|
|
777
|
-
query: Joi.object().pattern(
|
|
778
|
-
/\S/,
|
|
779
|
-
Joi.array().items(Joi.string().allow(""))
|
|
780
|
-
),
|
|
781
|
-
url: Joi.string().allow(""),
|
|
782
|
-
type: ThemePlatformModel.PageType().required(),
|
|
783
762
|
});
|
|
784
763
|
}
|
|
785
764
|
|
|
@@ -1215,13 +1194,8 @@ class ThemePlatformModel {
|
|
|
1215
1194
|
/** @returns {Page} */
|
|
1216
1195
|
static Page() {
|
|
1217
1196
|
return Joi.object({
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
has_previous: Joi.boolean(),
|
|
1221
|
-
has_next: Joi.boolean(),
|
|
1222
|
-
current: Joi.number(),
|
|
1223
|
-
type: Joi.string().allow("").required(),
|
|
1224
|
-
size: Joi.number(),
|
|
1197
|
+
sections: Joi.array().items(ThemePlatformModel.Section()),
|
|
1198
|
+
value: Joi.string().allow(""),
|
|
1225
1199
|
});
|
|
1226
1200
|
}
|
|
1227
1201
|
|
|
@@ -1383,6 +1357,22 @@ class ThemePlatformModel {
|
|
|
1383
1357
|
});
|
|
1384
1358
|
}
|
|
1385
1359
|
|
|
1360
|
+
/** @returns {ActionPage} */
|
|
1361
|
+
static ActionPage() {
|
|
1362
|
+
return Joi.object({
|
|
1363
|
+
params: Joi.object().pattern(
|
|
1364
|
+
/\S/,
|
|
1365
|
+
Joi.array().items(Joi.string().allow(""))
|
|
1366
|
+
),
|
|
1367
|
+
query: Joi.object().pattern(
|
|
1368
|
+
/\S/,
|
|
1369
|
+
Joi.array().items(Joi.string().allow(""))
|
|
1370
|
+
),
|
|
1371
|
+
url: Joi.string().allow(""),
|
|
1372
|
+
type: ThemePlatformModel.PageType().required(),
|
|
1373
|
+
});
|
|
1374
|
+
}
|
|
1375
|
+
|
|
1386
1376
|
/**
|
|
1387
1377
|
* Enum: PageType Used By: Theme
|
|
1388
1378
|
*
|
|
@@ -19,7 +19,7 @@ declare class User {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
|
|
21
21
|
* @name blockOrUnblockUsers
|
|
22
|
-
* @summary: Block/unblock users
|
|
22
|
+
* @summary: Block/unblock users
|
|
23
23
|
* @description: Control user access by blocking or unblocking their accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
|
|
24
24
|
*/
|
|
25
25
|
blockOrUnblockUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BlockOrUnblockUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BlockUserSuccess>;
|
|
@@ -29,7 +29,7 @@ declare class User {
|
|
|
29
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
31
31
|
* @name createUser
|
|
32
|
-
* @summary: Create user
|
|
32
|
+
* @summary: Create user
|
|
33
33
|
* @description: Register and add a new user to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
|
|
34
34
|
*/
|
|
35
35
|
createUser({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
@@ -52,7 +52,7 @@ declare class User {
|
|
|
52
52
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
53
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
54
54
|
* @name createUserGroup
|
|
55
|
-
* @summary: Create user group
|
|
55
|
+
* @summary: Create user group
|
|
56
56
|
* @description: Form and add a new user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
|
|
57
57
|
*/
|
|
58
58
|
createUserGroup({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
@@ -63,7 +63,7 @@ declare class User {
|
|
|
63
63
|
* @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
|
|
64
64
|
* Success response
|
|
65
65
|
* @name createUserSession
|
|
66
|
-
* @summary: Create user session
|
|
66
|
+
* @summary: Create user session
|
|
67
67
|
* @description: Establish a session for user interactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
|
|
68
68
|
*/
|
|
69
69
|
createUserSession({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserSessionResponseSchema>;
|
|
@@ -76,7 +76,7 @@ declare class User {
|
|
|
76
76
|
* @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
|
|
77
77
|
* Success response
|
|
78
78
|
* @name deleteActiveSessions
|
|
79
|
-
* @summary: Delete active sessions
|
|
79
|
+
* @summary: Delete active sessions
|
|
80
80
|
* @description: End multiple active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
|
|
81
81
|
*/
|
|
82
82
|
deleteActiveSessions({ id, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionsDeleteResponseSchema>;
|
|
@@ -87,7 +87,7 @@ declare class User {
|
|
|
87
87
|
* @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
|
|
88
88
|
* Success response
|
|
89
89
|
* @name deleteSession
|
|
90
|
-
* @summary: Delete session
|
|
90
|
+
* @summary: Delete session
|
|
91
91
|
* @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
|
|
92
92
|
*/
|
|
93
93
|
deleteSession({ id, sessionId, reason, requestHeaders }?: UserPlatformApplicationValidator.DeleteSessionParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionDeleteResponseSchema>;
|
|
@@ -119,7 +119,7 @@ declare class User {
|
|
|
119
119
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
120
|
* @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
|
|
121
121
|
* @name getActiveSessions
|
|
122
|
-
* @summary: Get active sessions
|
|
122
|
+
* @summary: Get active sessions
|
|
123
123
|
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
|
|
124
124
|
*/
|
|
125
125
|
getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
|
|
@@ -129,7 +129,7 @@ declare class User {
|
|
|
129
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
130
130
|
* @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
|
|
131
131
|
* @name getCustomers
|
|
132
|
-
* @summary: Get customers
|
|
132
|
+
* @summary: Get customers
|
|
133
133
|
* @description: Retrieve a list of customer profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
|
|
134
134
|
*/
|
|
135
135
|
getCustomers({ q, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetCustomersParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
|
|
@@ -139,7 +139,7 @@ declare class User {
|
|
|
139
139
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
140
140
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
141
141
|
* @name getPlatformConfig
|
|
142
|
-
* @summary: Get platform config
|
|
142
|
+
* @summary: Get platform config
|
|
143
143
|
* @description: Retrieve configuration settings for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
|
|
144
144
|
*/
|
|
145
145
|
getPlatformConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
@@ -207,7 +207,7 @@ declare class User {
|
|
|
207
207
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
208
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
209
209
|
* @name getUserGroupById
|
|
210
|
-
* @summary: Get user group by ID
|
|
210
|
+
* @summary: Get user group by ID
|
|
211
211
|
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
|
|
212
212
|
*/
|
|
213
213
|
getUserGroupById({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
@@ -218,7 +218,7 @@ declare class User {
|
|
|
218
218
|
* @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
|
|
219
219
|
* Success response
|
|
220
220
|
* @name getUserGroups
|
|
221
|
-
* @summary: Get user groups
|
|
221
|
+
* @summary: Get user groups
|
|
222
222
|
* @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
|
|
223
223
|
*/
|
|
224
224
|
getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
|
|
@@ -228,7 +228,7 @@ declare class User {
|
|
|
228
228
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
229
229
|
* @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
|
|
230
230
|
* @name searchUsers
|
|
231
|
-
* @summary: Search users
|
|
231
|
+
* @summary: Search users
|
|
232
232
|
* @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
|
|
233
233
|
*/
|
|
234
234
|
searchUsers({ q, query, requestHeaders }?: UserPlatformApplicationValidator.SearchUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserSearchResponseSchema>;
|
|
@@ -238,7 +238,7 @@ declare class User {
|
|
|
238
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
239
239
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
240
240
|
* @name unDeleteUser
|
|
241
|
-
* @summary: Undelete user
|
|
241
|
+
* @summary: Undelete user
|
|
242
242
|
* @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
|
|
243
243
|
*/
|
|
244
244
|
unDeleteUser({ body, requestHeaders }?: UserPlatformApplicationValidator.UnDeleteUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.UnDeleteUserSuccess>;
|
|
@@ -250,7 +250,7 @@ declare class User {
|
|
|
250
250
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
251
251
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
252
252
|
* @name updatePlatformConfig
|
|
253
|
-
* @summary: Update platform config
|
|
253
|
+
* @summary: Update platform config
|
|
254
254
|
* @description: Modify and update platform configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
|
|
255
255
|
*/
|
|
256
256
|
updatePlatformConfig({ body, requestHeaders }?: UserPlatformApplicationValidator.UpdatePlatformConfigParam, { responseHeaders }?: object): Promise<UserPlatformModel.PlatformSchema>;
|
|
@@ -260,7 +260,7 @@ declare class User {
|
|
|
260
260
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
261
261
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
262
262
|
* @name updateUser
|
|
263
|
-
* @summary: Update user
|
|
263
|
+
* @summary: Update user
|
|
264
264
|
* @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
|
|
265
265
|
*/
|
|
266
266
|
updateUser({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.CreateUserResponseSchema>;
|
|
@@ -292,7 +292,7 @@ declare class User {
|
|
|
292
292
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
293
293
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
294
294
|
* @name updateUserGroup
|
|
295
|
-
* @summary: Update user group
|
|
295
|
+
* @summary: Update user group
|
|
296
296
|
* @description: Modify and update user group details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
|
|
297
297
|
*/
|
|
298
298
|
updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
@@ -98,7 +98,7 @@ class User {
|
|
|
98
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
|
|
100
100
|
* @name blockOrUnblockUsers
|
|
101
|
-
* @summary: Block/unblock users
|
|
101
|
+
* @summary: Block/unblock users
|
|
102
102
|
* @description: Control user access by blocking or unblocking their accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
|
|
103
103
|
*/
|
|
104
104
|
async blockOrUnblockUsers(
|
|
@@ -177,7 +177,7 @@ class User {
|
|
|
177
177
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
178
178
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
179
179
|
* @name createUser
|
|
180
|
-
* @summary: Create user
|
|
180
|
+
* @summary: Create user
|
|
181
181
|
* @description: Register and add a new user to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
|
|
182
182
|
*/
|
|
183
183
|
async createUser(
|
|
@@ -336,7 +336,7 @@ class User {
|
|
|
336
336
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
337
337
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
338
338
|
* @name createUserGroup
|
|
339
|
-
* @summary: Create user group
|
|
339
|
+
* @summary: Create user group
|
|
340
340
|
* @description: Form and add a new user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserGroup/).
|
|
341
341
|
*/
|
|
342
342
|
async createUserGroup(
|
|
@@ -416,7 +416,7 @@ class User {
|
|
|
416
416
|
* @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
|
|
417
417
|
* Success response
|
|
418
418
|
* @name createUserSession
|
|
419
|
-
* @summary: Create user session
|
|
419
|
+
* @summary: Create user session
|
|
420
420
|
* @description: Establish a session for user interactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
|
|
421
421
|
*/
|
|
422
422
|
async createUserSession(
|
|
@@ -498,7 +498,7 @@ class User {
|
|
|
498
498
|
* @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
|
|
499
499
|
* Success response
|
|
500
500
|
* @name deleteActiveSessions
|
|
501
|
-
* @summary: Delete active sessions
|
|
501
|
+
* @summary: Delete active sessions
|
|
502
502
|
* @description: End multiple active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
|
|
503
503
|
*/
|
|
504
504
|
async deleteActiveSessions(
|
|
@@ -582,7 +582,7 @@ class User {
|
|
|
582
582
|
* @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
|
|
583
583
|
* Success response
|
|
584
584
|
* @name deleteSession
|
|
585
|
-
* @summary: Delete session
|
|
585
|
+
* @summary: Delete session
|
|
586
586
|
* @description: Terminate an active user session. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteSession/).
|
|
587
587
|
*/
|
|
588
588
|
async deleteSession(
|
|
@@ -818,7 +818,7 @@ class User {
|
|
|
818
818
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
819
819
|
* @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
|
|
820
820
|
* @name getActiveSessions
|
|
821
|
-
* @summary: Get active sessions
|
|
821
|
+
* @summary: Get active sessions
|
|
822
822
|
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
|
|
823
823
|
*/
|
|
824
824
|
async getActiveSessions(
|
|
@@ -898,7 +898,7 @@ class User {
|
|
|
898
898
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
899
899
|
* @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
|
|
900
900
|
* @name getCustomers
|
|
901
|
-
* @summary: Get customers
|
|
901
|
+
* @summary: Get customers
|
|
902
902
|
* @description: Retrieve a list of customer profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
|
|
903
903
|
*/
|
|
904
904
|
async getCustomers(
|
|
@@ -982,7 +982,7 @@ class User {
|
|
|
982
982
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
983
983
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
984
984
|
* @name getPlatformConfig
|
|
985
|
-
* @summary: Get platform config
|
|
985
|
+
* @summary: Get platform config
|
|
986
986
|
* @description: Retrieve configuration settings for the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
|
|
987
987
|
*/
|
|
988
988
|
async getPlatformConfig(
|
|
@@ -1496,7 +1496,7 @@ class User {
|
|
|
1496
1496
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1497
1497
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
1498
1498
|
* @name getUserGroupById
|
|
1499
|
-
* @summary: Get user group by ID
|
|
1499
|
+
* @summary: Get user group by ID
|
|
1500
1500
|
* @description: Retrieve a user group by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroupById/).
|
|
1501
1501
|
*/
|
|
1502
1502
|
async getUserGroupById(
|
|
@@ -1576,7 +1576,7 @@ class User {
|
|
|
1576
1576
|
* @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
|
|
1577
1577
|
* Success response
|
|
1578
1578
|
* @name getUserGroups
|
|
1579
|
-
* @summary: Get user groups
|
|
1579
|
+
* @summary: Get user groups
|
|
1580
1580
|
* @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
|
|
1581
1581
|
*/
|
|
1582
1582
|
async getUserGroups(
|
|
@@ -1671,7 +1671,7 @@ class User {
|
|
|
1671
1671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1672
1672
|
* @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
|
|
1673
1673
|
* @name searchUsers
|
|
1674
|
-
* @summary: Search users
|
|
1674
|
+
* @summary: Search users
|
|
1675
1675
|
* @description: Search and filter user profiles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
|
|
1676
1676
|
*/
|
|
1677
1677
|
async searchUsers(
|
|
@@ -1752,7 +1752,7 @@ class User {
|
|
|
1752
1752
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1753
1753
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
1754
1754
|
* @name unDeleteUser
|
|
1755
|
-
* @summary: Undelete user
|
|
1755
|
+
* @summary: Undelete user
|
|
1756
1756
|
* @description: Restore a previously deleted user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/unDeleteUser/).
|
|
1757
1757
|
*/
|
|
1758
1758
|
async unDeleteUser(
|
|
@@ -1831,7 +1831,7 @@ class User {
|
|
|
1831
1831
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1832
1832
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
1833
1833
|
* @name updatePlatformConfig
|
|
1834
|
-
* @summary: Update platform config
|
|
1834
|
+
* @summary: Update platform config
|
|
1835
1835
|
* @description: Modify and update platform configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
|
|
1836
1836
|
*/
|
|
1837
1837
|
async updatePlatformConfig(
|
|
@@ -1910,7 +1910,7 @@ class User {
|
|
|
1910
1910
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1911
1911
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
1912
1912
|
* @name updateUser
|
|
1913
|
-
* @summary: Update user
|
|
1913
|
+
* @summary: Update user
|
|
1914
1914
|
* @description: Modify and update user profile information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUser/).
|
|
1915
1915
|
*/
|
|
1916
1916
|
async updateUser(
|
|
@@ -2159,7 +2159,7 @@ class User {
|
|
|
2159
2159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2160
2160
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
2161
2161
|
* @name updateUserGroup
|
|
2162
|
-
* @summary: Update user group
|
|
2162
|
+
* @summary: Update user group
|
|
2163
2163
|
* @description: Modify and update user group details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
|
|
2164
2164
|
*/
|
|
2165
2165
|
async updateUserGroup(
|
|
@@ -214,6 +214,7 @@ export = UserPlatformModel;
|
|
|
214
214
|
* @property {string} username
|
|
215
215
|
* @property {Object} [meta]
|
|
216
216
|
* @property {string} [external_id]
|
|
217
|
+
* @property {string} [rr_id]
|
|
217
218
|
*/
|
|
218
219
|
/**
|
|
219
220
|
* @typedef CreateUserResponseSchema
|
|
@@ -391,6 +392,7 @@ export = UserPlatformModel;
|
|
|
391
392
|
* @property {string} [last_name]
|
|
392
393
|
* @property {string} [gender]
|
|
393
394
|
* @property {string} [external_id]
|
|
395
|
+
* @property {string} [rr_id]
|
|
394
396
|
* @property {Object} [meta]
|
|
395
397
|
* @property {UserPhoneNumbers[]} [phone_numbers]
|
|
396
398
|
* @property {UserEmails[]} [emails]
|
|
@@ -429,6 +431,7 @@ export = UserPlatformModel;
|
|
|
429
431
|
* @property {string} [created_at]
|
|
430
432
|
* @property {string} [updated_at]
|
|
431
433
|
* @property {string} [external_id]
|
|
434
|
+
* @property {string} [rr_id]
|
|
432
435
|
*/
|
|
433
436
|
/**
|
|
434
437
|
* @typedef UserSearchSchema
|
|
@@ -449,23 +452,24 @@ export = UserPlatformModel;
|
|
|
449
452
|
* @property {string} [created_at]
|
|
450
453
|
* @property {string} [updated_at]
|
|
451
454
|
* @property {string} [external_id]
|
|
455
|
+
* @property {string} [rr_id]
|
|
452
456
|
* @property {boolean} [archive]
|
|
453
457
|
* @property {string} [status]
|
|
454
458
|
*/
|
|
455
459
|
/**
|
|
456
460
|
* @typedef PhoneNumber
|
|
457
|
-
* @property {
|
|
458
|
-
* @property {
|
|
459
|
-
* @property {boolean} [
|
|
460
|
-
* @property {
|
|
461
|
-
* @property {
|
|
461
|
+
* @property {string} [phone] - Phone number
|
|
462
|
+
* @property {number} [country_code] - Country code
|
|
463
|
+
* @property {boolean} [active] - Is the phone number active
|
|
464
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
465
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
462
466
|
*/
|
|
463
467
|
/**
|
|
464
468
|
* @typedef Email
|
|
465
|
-
* @property {
|
|
466
|
-
* @property {boolean} [
|
|
467
|
-
* @property {
|
|
468
|
-
* @property {boolean} [
|
|
469
|
+
* @property {string} [email] - Email address
|
|
470
|
+
* @property {boolean} [active] - Is the email active
|
|
471
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
472
|
+
* @property {boolean} [verified] - Is the email verified
|
|
469
473
|
*/
|
|
470
474
|
declare class UserPlatformModel {
|
|
471
475
|
}
|
|
@@ -835,6 +839,7 @@ type CreateUserRequestSchema = {
|
|
|
835
839
|
username: string;
|
|
836
840
|
meta?: any;
|
|
837
841
|
external_id?: string;
|
|
842
|
+
rr_id?: string;
|
|
838
843
|
};
|
|
839
844
|
/** @returns {CreateUserResponseSchema} */
|
|
840
845
|
declare function CreateUserResponseSchema(): CreateUserResponseSchema;
|
|
@@ -1056,6 +1061,7 @@ type UpdateUserRequestSchema = {
|
|
|
1056
1061
|
last_name?: string;
|
|
1057
1062
|
gender?: string;
|
|
1058
1063
|
external_id?: string;
|
|
1064
|
+
rr_id?: string;
|
|
1059
1065
|
meta?: any;
|
|
1060
1066
|
phone_numbers?: UserPhoneNumbers[];
|
|
1061
1067
|
emails?: UserEmails[];
|
|
@@ -1097,6 +1103,7 @@ type UserSchema = {
|
|
|
1097
1103
|
created_at?: string;
|
|
1098
1104
|
updated_at?: string;
|
|
1099
1105
|
external_id?: string;
|
|
1106
|
+
rr_id?: string;
|
|
1100
1107
|
};
|
|
1101
1108
|
/** @returns {UserSearchSchema} */
|
|
1102
1109
|
declare function UserSearchSchema(): UserSearchSchema;
|
|
@@ -1118,23 +1125,51 @@ type UserSearchSchema = {
|
|
|
1118
1125
|
created_at?: string;
|
|
1119
1126
|
updated_at?: string;
|
|
1120
1127
|
external_id?: string;
|
|
1128
|
+
rr_id?: string;
|
|
1121
1129
|
archive?: boolean;
|
|
1122
1130
|
status?: string;
|
|
1123
1131
|
};
|
|
1124
1132
|
/** @returns {PhoneNumber} */
|
|
1125
1133
|
declare function PhoneNumber(): PhoneNumber;
|
|
1126
1134
|
type PhoneNumber = {
|
|
1135
|
+
/**
|
|
1136
|
+
* - Phone number
|
|
1137
|
+
*/
|
|
1138
|
+
phone?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* - Country code
|
|
1141
|
+
*/
|
|
1142
|
+
country_code?: number;
|
|
1143
|
+
/**
|
|
1144
|
+
* - Is the phone number active
|
|
1145
|
+
*/
|
|
1127
1146
|
active?: boolean;
|
|
1147
|
+
/**
|
|
1148
|
+
* - Is it a primary phone number
|
|
1149
|
+
*/
|
|
1128
1150
|
primary?: boolean;
|
|
1151
|
+
/**
|
|
1152
|
+
* - Is the phone number verified
|
|
1153
|
+
*/
|
|
1129
1154
|
verified?: boolean;
|
|
1130
|
-
phone?: string;
|
|
1131
|
-
country_code?: number;
|
|
1132
1155
|
};
|
|
1133
1156
|
/** @returns {Email} */
|
|
1134
1157
|
declare function Email(): Email;
|
|
1135
1158
|
type Email = {
|
|
1136
|
-
|
|
1137
|
-
|
|
1159
|
+
/**
|
|
1160
|
+
* - Email address
|
|
1161
|
+
*/
|
|
1138
1162
|
email?: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* - Is the email active
|
|
1165
|
+
*/
|
|
1139
1166
|
active?: boolean;
|
|
1167
|
+
/**
|
|
1168
|
+
* - Is it a primary email
|
|
1169
|
+
*/
|
|
1170
|
+
primary?: boolean;
|
|
1171
|
+
/**
|
|
1172
|
+
* - Is the email verified
|
|
1173
|
+
*/
|
|
1174
|
+
verified?: boolean;
|
|
1140
1175
|
};
|