@gofynd/fdk-client-javascript 1.4.3 → 1.4.4
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 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +1 -1
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -106
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -9,8 +9,8 @@ declare class User {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
|
|
11
11
|
* @name archiveUser
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Archive User
|
|
13
|
+
* @description: Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
|
|
14
14
|
*/
|
|
15
15
|
archiveUser({ body, requestHeaders }?: UserPlatformApplicationValidator.ArchiveUserParam, { responseHeaders }?: object): Promise<UserPlatformModel.ArchiveUserSuccess>;
|
|
16
16
|
/**
|
|
@@ -19,8 +19,8 @@ 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/
|
|
23
|
-
* @description:
|
|
22
|
+
* @summary: Block/Unblock Users
|
|
23
|
+
* @description: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked 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>;
|
|
26
26
|
/**
|
|
@@ -29,8 +29,8 @@ 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
|
|
33
|
-
* @description: Register and add a new user to the
|
|
32
|
+
* @summary: Create User
|
|
33
|
+
* @description: Register and add a new user to the sales channel. - 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>;
|
|
36
36
|
/**
|
|
@@ -43,7 +43,7 @@ declare class User {
|
|
|
43
43
|
* Success response
|
|
44
44
|
* @name createUserAttributeDefinition
|
|
45
45
|
* @summary: Create a User Attribute Definition
|
|
46
|
-
* @description:
|
|
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
48
|
createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionResponse>;
|
|
49
49
|
/**
|
|
@@ -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
|
|
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,8 +63,8 @@ declare class User {
|
|
|
63
63
|
* @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
|
|
64
64
|
* Success response
|
|
65
65
|
* @name createUserSession
|
|
66
|
-
* @summary: Create
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Create User Session
|
|
67
|
+
* @description: Create 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>;
|
|
70
70
|
/**
|
|
@@ -76,8 +76,8 @@ declare class User {
|
|
|
76
76
|
* @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
|
|
77
77
|
* Success response
|
|
78
78
|
* @name deleteActiveSessions
|
|
79
|
-
* @summary: Delete
|
|
80
|
-
* @description:
|
|
79
|
+
* @summary: Delete User Active Sessions
|
|
80
|
+
* @description: Terminate all 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>;
|
|
83
83
|
/**
|
|
@@ -87,7 +87,7 @@ declare class User {
|
|
|
87
87
|
* @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
|
|
88
88
|
* Success response
|
|
89
89
|
* @name deleteSession
|
|
90
|
-
* @summary: Delete
|
|
90
|
+
* @summary: Delete User 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>;
|
|
@@ -97,8 +97,8 @@ declare class User {
|
|
|
97
97
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
98
98
|
* @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
|
|
99
99
|
* @name deleteUserAttribute
|
|
100
|
-
* @summary:
|
|
101
|
-
* @description:
|
|
100
|
+
* @summary: Delete User Attribute
|
|
101
|
+
* @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
|
|
102
102
|
*/
|
|
103
103
|
deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessageResponse>;
|
|
104
104
|
/**
|
|
@@ -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
|
|
122
|
+
* @summary: Get User 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,8 +129,8 @@ 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
|
|
133
|
-
* @description: Retrieve
|
|
132
|
+
* @summary: Get a List of Users
|
|
133
|
+
* @description: Retrieve details of users registered in the sales channel - 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>;
|
|
136
136
|
/**
|
|
@@ -139,8 +139,8 @@ 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
|
|
143
|
-
* @description: Retrieve
|
|
142
|
+
* @summary: Get Platform Config
|
|
143
|
+
* @description: Retrieve platform sales channel authentication configuration. - 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>;
|
|
146
146
|
/**
|
|
@@ -149,8 +149,8 @@ declare class User {
|
|
|
149
149
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
150
|
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
151
151
|
* @name getUserAttribute
|
|
152
|
-
* @summary:
|
|
153
|
-
* @description:
|
|
152
|
+
* @summary: Get User Attribute
|
|
153
|
+
* @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
|
|
154
154
|
*/
|
|
155
155
|
getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
|
|
156
156
|
/**
|
|
@@ -162,7 +162,7 @@ declare class User {
|
|
|
162
162
|
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
163
163
|
* @name getUserAttributeById
|
|
164
164
|
* @summary: Get User Attribute
|
|
165
|
-
* @description:
|
|
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
167
|
getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
|
|
168
168
|
/**
|
|
@@ -197,8 +197,8 @@ declare class User {
|
|
|
197
197
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
198
|
* @returns {Promise<Object>} - Success response
|
|
199
199
|
* @name getUserAttributesForUser
|
|
200
|
-
* @summary: Get
|
|
201
|
-
* @description:
|
|
200
|
+
* @summary: Get All Customer Attributes
|
|
201
|
+
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
|
|
202
202
|
*/
|
|
203
203
|
getUserAttributesForUser({ userId, pageSize, pageNo, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributesForUserParam, { responseHeaders }?: object): Promise<any>;
|
|
204
204
|
/**
|
|
@@ -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
|
|
210
|
+
* @summary: Get User Group
|
|
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
|
|
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,8 +228,8 @@ 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
|
|
232
|
-
* @description: Search and filter
|
|
231
|
+
* @summary: Search an Existing Users
|
|
232
|
+
* @description: Search and filter users details registered in the sales channel - 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>;
|
|
235
235
|
/**
|
|
@@ -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:
|
|
241
|
+
* @summary: Restore Deleted 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,8 +250,8 @@ 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
|
|
254
|
-
* @description: Modify and update platform configuration
|
|
253
|
+
* @summary: Update Platform Config
|
|
254
|
+
* @description: Modify and update platform sales channel authentication configuration. - 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>;
|
|
257
257
|
/**
|
|
@@ -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
|
|
263
|
+
* @summary: Update User Details
|
|
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
|
|
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>;
|
|
@@ -304,10 +304,10 @@ declare class User {
|
|
|
304
304
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
305
305
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
306
306
|
* @name updateUserGroupPartially
|
|
307
|
-
* @summary:
|
|
307
|
+
* @summary: Modify User Group
|
|
308
308
|
* @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
|
|
309
309
|
*/
|
|
310
310
|
updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
|
|
311
311
|
}
|
|
312
|
-
import UserPlatformApplicationValidator = require("
|
|
313
|
-
import UserPlatformModel = require("
|
|
312
|
+
import UserPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/User/UserPlatformApplicationValidator");
|
|
313
|
+
import UserPlatformModel = require("sdk/output/javascript/code/sdk/platform/User/UserPlatformModel");
|
|
@@ -21,8 +21,8 @@ class User {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<UserPlatformModel.ArchiveUserSuccess>} - Success response
|
|
23
23
|
* @name archiveUser
|
|
24
|
-
* @summary:
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Archive User
|
|
25
|
+
* @description: Delete user from sales channel, allowing re-registration with the same mobile/email for a new user account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/archiveUser/).
|
|
26
26
|
*/
|
|
27
27
|
async archiveUser(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -98,8 +98,8 @@ class User {
|
|
|
98
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<UserPlatformModel.BlockUserSuccess>} - Success response
|
|
100
100
|
* @name blockOrUnblockUsers
|
|
101
|
-
* @summary: Block/
|
|
102
|
-
* @description:
|
|
101
|
+
* @summary: Block/Unblock Users
|
|
102
|
+
* @description: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
|
|
103
103
|
*/
|
|
104
104
|
async blockOrUnblockUsers(
|
|
105
105
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -177,8 +177,8 @@ class User {
|
|
|
177
177
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
178
178
|
* @returns {Promise<UserPlatformModel.CreateUserResponseSchema>} - Success response
|
|
179
179
|
* @name createUser
|
|
180
|
-
* @summary: Create
|
|
181
|
-
* @description: Register and add a new user to the
|
|
180
|
+
* @summary: Create User
|
|
181
|
+
* @description: Register and add a new user to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUser/).
|
|
182
182
|
*/
|
|
183
183
|
async createUser(
|
|
184
184
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -258,7 +258,7 @@ class User {
|
|
|
258
258
|
* Success response
|
|
259
259
|
* @name createUserAttributeDefinition
|
|
260
260
|
* @summary: Create a User Attribute Definition
|
|
261
|
-
* @description:
|
|
261
|
+
* @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
|
|
262
262
|
*/
|
|
263
263
|
async createUserAttributeDefinition(
|
|
264
264
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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
|
|
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,8 +416,8 @@ class User {
|
|
|
416
416
|
* @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
|
|
417
417
|
* Success response
|
|
418
418
|
* @name createUserSession
|
|
419
|
-
* @summary: Create
|
|
420
|
-
* @description:
|
|
419
|
+
* @summary: Create User Session
|
|
420
|
+
* @description: Create session for user interactions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserSession/).
|
|
421
421
|
*/
|
|
422
422
|
async createUserSession(
|
|
423
423
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -498,8 +498,8 @@ class User {
|
|
|
498
498
|
* @returns {Promise<UserPlatformModel.SessionsDeleteResponseSchema>} -
|
|
499
499
|
* Success response
|
|
500
500
|
* @name deleteActiveSessions
|
|
501
|
-
* @summary: Delete
|
|
502
|
-
* @description:
|
|
501
|
+
* @summary: Delete User Active Sessions
|
|
502
|
+
* @description: Terminate all active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteActiveSessions/).
|
|
503
503
|
*/
|
|
504
504
|
async deleteActiveSessions(
|
|
505
505
|
{ id, reason, requestHeaders } = { requestHeaders: {} },
|
|
@@ -582,7 +582,7 @@ class User {
|
|
|
582
582
|
* @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
|
|
583
583
|
* Success response
|
|
584
584
|
* @name deleteSession
|
|
585
|
-
* @summary: Delete
|
|
585
|
+
* @summary: Delete User 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(
|
|
@@ -666,8 +666,8 @@ class User {
|
|
|
666
666
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
667
667
|
* @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
|
|
668
668
|
* @name deleteUserAttribute
|
|
669
|
-
* @summary:
|
|
670
|
-
* @description:
|
|
669
|
+
* @summary: Delete User Attribute
|
|
670
|
+
* @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
|
|
671
671
|
*/
|
|
672
672
|
async deleteUserAttribute(
|
|
673
673
|
{ attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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
|
|
821
|
+
* @summary: Get User 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,8 +898,8 @@ class User {
|
|
|
898
898
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
899
899
|
* @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
|
|
900
900
|
* @name getCustomers
|
|
901
|
-
* @summary: Get
|
|
902
|
-
* @description: Retrieve
|
|
901
|
+
* @summary: Get a List of Users
|
|
902
|
+
* @description: Retrieve details of users registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getCustomers/).
|
|
903
903
|
*/
|
|
904
904
|
async getCustomers(
|
|
905
905
|
{ q, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -982,8 +982,8 @@ class User {
|
|
|
982
982
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
983
983
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
984
984
|
* @name getPlatformConfig
|
|
985
|
-
* @summary: Get
|
|
986
|
-
* @description: Retrieve
|
|
985
|
+
* @summary: Get Platform Config
|
|
986
|
+
* @description: Retrieve platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getPlatformConfig/).
|
|
987
987
|
*/
|
|
988
988
|
async getPlatformConfig(
|
|
989
989
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1057,8 +1057,8 @@ class User {
|
|
|
1057
1057
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1058
1058
|
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1059
1059
|
* @name getUserAttribute
|
|
1060
|
-
* @summary:
|
|
1061
|
-
* @description:
|
|
1060
|
+
* @summary: Get User Attribute
|
|
1061
|
+
* @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
|
|
1062
1062
|
*/
|
|
1063
1063
|
async getUserAttribute(
|
|
1064
1064
|
{ attributeDefId, userId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1135,7 +1135,7 @@ class User {
|
|
|
1135
1135
|
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1136
1136
|
* @name getUserAttributeById
|
|
1137
1137
|
* @summary: Get User Attribute
|
|
1138
|
-
* @description:
|
|
1138
|
+
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
|
|
1139
1139
|
*/
|
|
1140
1140
|
async getUserAttributeById(
|
|
1141
1141
|
{ attributeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1411,8 +1411,8 @@ class User {
|
|
|
1411
1411
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1412
1412
|
* @returns {Promise<Object>} - Success response
|
|
1413
1413
|
* @name getUserAttributesForUser
|
|
1414
|
-
* @summary: Get
|
|
1415
|
-
* @description:
|
|
1414
|
+
* @summary: Get All Customer Attributes
|
|
1415
|
+
* @description: Retrieve all user attributes for a specific user - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributesForUser/).
|
|
1416
1416
|
*/
|
|
1417
1417
|
async getUserAttributesForUser(
|
|
1418
1418
|
{ userId, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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
|
|
1499
|
+
* @summary: Get User Group
|
|
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
|
|
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,8 +1671,8 @@ class User {
|
|
|
1671
1671
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1672
1672
|
* @returns {Promise<UserPlatformModel.UserSearchResponseSchema>} - Success response
|
|
1673
1673
|
* @name searchUsers
|
|
1674
|
-
* @summary: Search
|
|
1675
|
-
* @description: Search and filter
|
|
1674
|
+
* @summary: Search an Existing Users
|
|
1675
|
+
* @description: Search and filter users details registered in the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/searchUsers/).
|
|
1676
1676
|
*/
|
|
1677
1677
|
async searchUsers(
|
|
1678
1678
|
{ q, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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:
|
|
1755
|
+
* @summary: Restore Deleted 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,8 +1831,8 @@ class User {
|
|
|
1831
1831
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1832
1832
|
* @returns {Promise<UserPlatformModel.PlatformSchema>} - Success response
|
|
1833
1833
|
* @name updatePlatformConfig
|
|
1834
|
-
* @summary: Update
|
|
1835
|
-
* @description: Modify and update platform configuration
|
|
1834
|
+
* @summary: Update Platform Config
|
|
1835
|
+
* @description: Modify and update platform sales channel authentication configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updatePlatformConfig/).
|
|
1836
1836
|
*/
|
|
1837
1837
|
async updatePlatformConfig(
|
|
1838
1838
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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
|
|
1913
|
+
* @summary: Update User Details
|
|
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
|
|
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(
|
|
@@ -2242,7 +2242,7 @@ class User {
|
|
|
2242
2242
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2243
2243
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
2244
2244
|
* @name updateUserGroupPartially
|
|
2245
|
-
* @summary:
|
|
2245
|
+
* @summary: Modify User Group
|
|
2246
2246
|
* @description: Update user group partially on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
|
|
2247
2247
|
*/
|
|
2248
2248
|
async updateUserGroupPartially(
|
|
@@ -472,4 +472,4 @@ type UpdateUserGroupPartiallyParam = {
|
|
|
472
472
|
body: UserPlatformModel.PartialUserGroupUpdateSchema;
|
|
473
473
|
};
|
|
474
474
|
type GetPlatformConfigParam = any;
|
|
475
|
-
import UserPlatformModel = require("
|
|
475
|
+
import UserPlatformModel = require("sdk/output/javascript/code/sdk/platform/User/UserPlatformModel");
|
|
@@ -9,7 +9,8 @@ declare class Webhook {
|
|
|
9
9
|
* @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
|
|
10
10
|
* @name cancelJobByName
|
|
11
11
|
* @summary: Cancel job by name
|
|
12
|
-
* @description:
|
|
12
|
+
* @description: It will cancel export job triggerd by user in order to fetch
|
|
13
|
+
* historical delivery summery - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
13
14
|
*/
|
|
14
15
|
cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
|
|
15
16
|
/**
|
|
@@ -28,7 +29,7 @@ declare class Webhook {
|
|
|
28
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
30
|
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
30
31
|
* @name fetchAllEventConfigurations
|
|
31
|
-
* @summary:
|
|
32
|
+
* @summary: List event configurations
|
|
32
33
|
* @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
33
34
|
*/
|
|
34
35
|
fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
|
|
@@ -88,7 +89,7 @@ declare class Webhook {
|
|
|
88
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
89
90
|
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
90
91
|
* @name getSubscriberById
|
|
91
|
-
* @summary: Get subscriber
|
|
92
|
+
* @summary: Get a subscriber
|
|
92
93
|
* @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
|
|
93
94
|
*/
|
|
94
95
|
getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
|
|
@@ -98,7 +99,7 @@ declare class Webhook {
|
|
|
98
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
100
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
100
101
|
* @name getSubscribersByCompany
|
|
101
|
-
* @summary:
|
|
102
|
+
* @summary: List subscribers by company
|
|
102
103
|
* @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
103
104
|
*/
|
|
104
105
|
getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
|
|
@@ -108,7 +109,7 @@ declare class Webhook {
|
|
|
108
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
110
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
110
111
|
* @name getSubscribersByExtensionId
|
|
111
|
-
* @summary:
|
|
112
|
+
* @summary: List subscribers by extension ID
|
|
112
113
|
* @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
|
|
113
114
|
*/
|
|
114
115
|
getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
|
|
@@ -160,10 +161,10 @@ declare class Webhook {
|
|
|
160
161
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
161
162
|
* Success response
|
|
162
163
|
* @name updateSubscriberConfig
|
|
163
|
-
* @summary: Update subscriber config
|
|
164
|
+
* @summary: Update a subscriber config
|
|
164
165
|
* @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
165
166
|
*/
|
|
166
167
|
updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
167
168
|
}
|
|
168
|
-
import WebhookPlatformValidator = require("
|
|
169
|
-
import WebhookPlatformModel = require("
|
|
169
|
+
import WebhookPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Webhook/WebhookPlatformValidator");
|
|
170
|
+
import WebhookPlatformModel = require("sdk/output/javascript/code/sdk/platform/Webhook/WebhookPlatformModel");
|
|
@@ -21,7 +21,8 @@ class Webhook {
|
|
|
21
21
|
* @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
|
|
22
22
|
* @name cancelJobByName
|
|
23
23
|
* @summary: Cancel job by name
|
|
24
|
-
* @description:
|
|
24
|
+
* @description: It will cancel export job triggerd by user in order to fetch
|
|
25
|
+
* historical delivery summery - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
25
26
|
*/
|
|
26
27
|
async cancelJobByName(
|
|
27
28
|
{ filename, requestHeaders } = { requestHeaders: {} },
|
|
@@ -180,7 +181,7 @@ class Webhook {
|
|
|
180
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
182
|
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
182
183
|
* @name fetchAllEventConfigurations
|
|
183
|
-
* @summary:
|
|
184
|
+
* @summary: List event configurations
|
|
184
185
|
* @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
185
186
|
*/
|
|
186
187
|
async fetchAllEventConfigurations(
|
|
@@ -645,7 +646,7 @@ class Webhook {
|
|
|
645
646
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
646
647
|
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
647
648
|
* @name getSubscriberById
|
|
648
|
-
* @summary: Get subscriber
|
|
649
|
+
* @summary: Get a subscriber
|
|
649
650
|
* @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
|
|
650
651
|
*/
|
|
651
652
|
async getSubscriberById(
|
|
@@ -724,7 +725,7 @@ class Webhook {
|
|
|
724
725
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
725
726
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
726
727
|
* @name getSubscribersByCompany
|
|
727
|
-
* @summary:
|
|
728
|
+
* @summary: List subscribers by company
|
|
728
729
|
* @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
729
730
|
*/
|
|
730
731
|
async getSubscribersByCompany(
|
|
@@ -812,7 +813,7 @@ class Webhook {
|
|
|
812
813
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
813
814
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
814
815
|
* @name getSubscribersByExtensionId
|
|
815
|
-
* @summary:
|
|
816
|
+
* @summary: List subscribers by extension ID
|
|
816
817
|
* @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
|
|
817
818
|
*/
|
|
818
819
|
async getSubscribersByExtensionId(
|
|
@@ -1212,7 +1213,7 @@ class Webhook {
|
|
|
1212
1213
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
1213
1214
|
* Success response
|
|
1214
1215
|
* @name updateSubscriberConfig
|
|
1215
|
-
* @summary: Update subscriber config
|
|
1216
|
+
* @summary: Update a subscriber config
|
|
1216
1217
|
* @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
1217
1218
|
*/
|
|
1218
1219
|
async updateSubscriberConfig(
|
|
@@ -162,4 +162,4 @@ type UpdateSubscriberConfigParam = {
|
|
|
162
162
|
type FetchAllEventConfigurationsParam = any;
|
|
163
163
|
type GetManualRetryStatusParam = any;
|
|
164
164
|
type ManualRetryCancelParam = any;
|
|
165
|
-
import WebhookPlatformModel = require("
|
|
165
|
+
import WebhookPlatformModel = require("sdk/output/javascript/code/sdk/platform/Webhook/WebhookPlatformModel");
|