@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -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 +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -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: 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(
|
|
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 user
|
|
181
|
-
* @description:
|
|
180
|
+
* @summary: Create user.
|
|
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(
|
|
184
184
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -336,8 +336,8 @@ class User {
|
|
|
336
336
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
337
337
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
338
338
|
* @name createUserGroup
|
|
339
|
-
* @summary: Create
|
|
340
|
-
* @description:
|
|
339
|
+
* @summary: Create user group.
|
|
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(
|
|
343
343
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -416,8 +416,8 @@ class User {
|
|
|
416
416
|
* @returns {Promise<UserPlatformModel.CreateUserSessionResponseSchema>} -
|
|
417
417
|
* Success response
|
|
418
418
|
* @name createUserSession
|
|
419
|
-
* @summary: Create user session
|
|
420
|
-
* @description:
|
|
419
|
+
* @summary: Create user session.
|
|
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(
|
|
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 active sessions.
|
|
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(
|
|
505
505
|
{ id, reason, requestHeaders } = { requestHeaders: {} },
|
|
@@ -582,8 +582,8 @@ class User {
|
|
|
582
582
|
* @returns {Promise<UserPlatformModel.SessionDeleteResponseSchema>} -
|
|
583
583
|
* Success response
|
|
584
584
|
* @name deleteSession
|
|
585
|
-
* @summary: Delete
|
|
586
|
-
* @description:
|
|
585
|
+
* @summary: Delete session.
|
|
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(
|
|
589
589
|
{ id, sessionId, reason, requestHeaders } = { requestHeaders: {} },
|
|
@@ -818,8 +818,8 @@ class User {
|
|
|
818
818
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
819
819
|
* @returns {Promise<UserPlatformModel.SessionListResponseSchema>} - Success response
|
|
820
820
|
* @name getActiveSessions
|
|
821
|
-
* @summary: Get
|
|
822
|
-
* @description:
|
|
821
|
+
* @summary: Get active sessions.
|
|
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(
|
|
825
825
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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:
|
|
901
|
+
* @summary: Get customers.
|
|
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(
|
|
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 platform
|
|
986
|
-
* @description:
|
|
985
|
+
* @summary: Get platform config.
|
|
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(
|
|
989
989
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1496,8 +1496,8 @@ class User {
|
|
|
1496
1496
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1497
1497
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
1498
1498
|
* @name getUserGroupById
|
|
1499
|
-
* @summary: Get
|
|
1500
|
-
* @description:
|
|
1499
|
+
* @summary: Get user group by ID.
|
|
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(
|
|
1503
1503
|
{ groupId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1576,8 +1576,8 @@ class User {
|
|
|
1576
1576
|
* @returns {Promise<UserPlatformModel.UserGroupListResponseSchema>} -
|
|
1577
1577
|
* Success response
|
|
1578
1578
|
* @name getUserGroups
|
|
1579
|
-
* @summary: Get
|
|
1580
|
-
* @description:
|
|
1579
|
+
* @summary: Get user groups.
|
|
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(
|
|
1583
1583
|
{ pageNo, pageSize, name, type, status, groupUid, requestHeaders } = {
|
|
@@ -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:
|
|
1674
|
+
* @summary: Search users.
|
|
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(
|
|
1678
1678
|
{ q, query, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1752,8 +1752,8 @@ class User {
|
|
|
1752
1752
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1753
1753
|
* @returns {Promise<UserPlatformModel.UnDeleteUserSuccess>} - Success response
|
|
1754
1754
|
* @name unDeleteUser
|
|
1755
|
-
* @summary:
|
|
1756
|
-
* @description:
|
|
1755
|
+
* @summary: Undelete user.
|
|
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(
|
|
1759
1759
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -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 platform
|
|
1835
|
-
* @description:
|
|
1834
|
+
* @summary: Update platform config.
|
|
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(
|
|
1838
1838
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1910,8 +1910,8 @@ 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
|
|
1914
|
-
* @description:
|
|
1913
|
+
* @summary: Update user.
|
|
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(
|
|
1917
1917
|
{ userId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2159,8 +2159,8 @@ class User {
|
|
|
2159
2159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2160
2160
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
2161
2161
|
* @name updateUserGroup
|
|
2162
|
-
* @summary: Update
|
|
2163
|
-
* @description:
|
|
2162
|
+
* @summary: Update user group.
|
|
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(
|
|
2166
2166
|
{ groupId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2243,7 +2243,7 @@ class User {
|
|
|
2243
2243
|
* @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
|
|
2244
2244
|
* @name updateUserGroupPartially
|
|
2245
2245
|
* @summary: Add or Remove an user from particular user group and update user group details
|
|
2246
|
-
* @description:
|
|
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(
|
|
2249
2249
|
{ groupId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -112,7 +112,7 @@ export = UserPlatformModel;
|
|
|
112
112
|
*/
|
|
113
113
|
/**
|
|
114
114
|
* @typedef CustomerListResponseSchema
|
|
115
|
-
* @property {
|
|
115
|
+
* @property {UserSearchSchema[]} [items]
|
|
116
116
|
* @property {PaginationSchema} [page]
|
|
117
117
|
*/
|
|
118
118
|
/**
|
|
@@ -322,7 +322,7 @@ export = UserPlatformModel;
|
|
|
322
322
|
/**
|
|
323
323
|
* @typedef SocialTokens
|
|
324
324
|
* @property {Facebook} [facebook]
|
|
325
|
-
* @property {Accountkit} [
|
|
325
|
+
* @property {Accountkit} [account_kit]
|
|
326
326
|
* @property {Google} [google]
|
|
327
327
|
*/
|
|
328
328
|
/**
|
|
@@ -717,7 +717,7 @@ type UserSearchResponseSchema = {
|
|
|
717
717
|
/** @returns {CustomerListResponseSchema} */
|
|
718
718
|
declare function CustomerListResponseSchema(): CustomerListResponseSchema;
|
|
719
719
|
type CustomerListResponseSchema = {
|
|
720
|
-
items?:
|
|
720
|
+
items?: UserSearchSchema[];
|
|
721
721
|
page?: PaginationSchema;
|
|
722
722
|
};
|
|
723
723
|
/** @returns {PaginationSchema} */
|
|
@@ -959,7 +959,7 @@ type FlashCard = {
|
|
|
959
959
|
declare function SocialTokens(): SocialTokens;
|
|
960
960
|
type SocialTokens = {
|
|
961
961
|
facebook?: Facebook;
|
|
962
|
-
|
|
962
|
+
account_kit?: Accountkit;
|
|
963
963
|
google?: Google;
|
|
964
964
|
};
|
|
965
965
|
/** @returns {DeleteAccountReasons} */
|
|
@@ -127,7 +127,7 @@ const Joi = require("joi");
|
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
129
|
* @typedef CustomerListResponseSchema
|
|
130
|
-
* @property {
|
|
130
|
+
* @property {UserSearchSchema[]} [items]
|
|
131
131
|
* @property {PaginationSchema} [page]
|
|
132
132
|
*/
|
|
133
133
|
|
|
@@ -366,7 +366,7 @@ const Joi = require("joi");
|
|
|
366
366
|
/**
|
|
367
367
|
* @typedef SocialTokens
|
|
368
368
|
* @property {Facebook} [facebook]
|
|
369
|
-
* @property {Accountkit} [
|
|
369
|
+
* @property {Accountkit} [account_kit]
|
|
370
370
|
* @property {Google} [google]
|
|
371
371
|
*/
|
|
372
372
|
|
|
@@ -686,7 +686,7 @@ class UserPlatformModel {
|
|
|
686
686
|
/** @returns {CustomerListResponseSchema} */
|
|
687
687
|
static CustomerListResponseSchema() {
|
|
688
688
|
return Joi.object({
|
|
689
|
-
items: Joi.array().items(UserPlatformModel.
|
|
689
|
+
items: Joi.array().items(UserPlatformModel.UserSearchSchema()),
|
|
690
690
|
page: UserPlatformModel.PaginationSchema(),
|
|
691
691
|
});
|
|
692
692
|
}
|
|
@@ -985,7 +985,7 @@ class UserPlatformModel {
|
|
|
985
985
|
static SocialTokens() {
|
|
986
986
|
return Joi.object({
|
|
987
987
|
facebook: UserPlatformModel.Facebook(),
|
|
988
|
-
|
|
988
|
+
account_kit: UserPlatformModel.Accountkit(),
|
|
989
989
|
google: UserPlatformModel.Google(),
|
|
990
990
|
});
|
|
991
991
|
}
|
|
@@ -8,9 +8,8 @@ declare class Webhook {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
|
|
10
10
|
* @name cancelJobByName
|
|
11
|
-
* @summary: Cancel
|
|
12
|
-
* @description: Cancel
|
|
13
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
11
|
+
* @summary: Cancel job by name.
|
|
12
|
+
* @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
14
13
|
*/
|
|
15
14
|
cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
|
|
16
15
|
/**
|
|
@@ -19,9 +18,8 @@ declare class Webhook {
|
|
|
19
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
19
|
* @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
|
|
21
20
|
* @name downloadDeliveryReport
|
|
22
|
-
* @summary: Download
|
|
23
|
-
* @description: Download reports for
|
|
24
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
|
|
21
|
+
* @summary: Download delivery report.
|
|
22
|
+
* @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
|
|
25
23
|
*/
|
|
26
24
|
downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.DownloadReportResponse>;
|
|
27
25
|
/**
|
|
@@ -30,9 +28,8 @@ declare class Webhook {
|
|
|
30
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
31
29
|
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
32
30
|
* @name fetchAllEventConfigurations
|
|
33
|
-
* @summary:
|
|
34
|
-
* @description:
|
|
35
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
31
|
+
* @summary: Fetch all event configurations.
|
|
32
|
+
* @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
36
33
|
*/
|
|
37
34
|
fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
|
|
38
35
|
/**
|
|
@@ -41,9 +38,8 @@ declare class Webhook {
|
|
|
41
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
39
|
* @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
|
|
43
40
|
* @name getDeliveryReports
|
|
44
|
-
* @summary: Get
|
|
45
|
-
* @description: Retrieve
|
|
46
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
|
|
41
|
+
* @summary: Get delivery reports.
|
|
42
|
+
* @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
|
|
47
43
|
*/
|
|
48
44
|
getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
|
|
49
45
|
/**
|
|
@@ -52,9 +48,8 @@ declare class Webhook {
|
|
|
52
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
49
|
* @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
|
|
54
50
|
* @name getEventCounts
|
|
55
|
-
* @summary: Get
|
|
56
|
-
* @description:
|
|
57
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
|
|
51
|
+
* @summary: Get event counts.
|
|
52
|
+
* @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
|
|
58
53
|
*/
|
|
59
54
|
getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryCountResponse>;
|
|
60
55
|
/**
|
|
@@ -63,9 +58,8 @@ declare class Webhook {
|
|
|
63
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
59
|
* @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
|
|
65
60
|
* @name getHistoricalReports
|
|
66
|
-
* @summary: Get
|
|
67
|
-
* @description: Retrieve
|
|
68
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
|
|
61
|
+
* @summary: Get historical reports.
|
|
62
|
+
* @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
|
|
69
63
|
*/
|
|
70
64
|
getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
|
|
71
65
|
/**
|
|
@@ -74,9 +68,8 @@ declare class Webhook {
|
|
|
74
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
75
69
|
* @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
|
|
76
70
|
* @name getManualRetryStatus
|
|
77
|
-
* @summary: Get
|
|
78
|
-
* @description:
|
|
79
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
|
|
71
|
+
* @summary: Get manual retry status.
|
|
72
|
+
* @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
|
|
80
73
|
*/
|
|
81
74
|
getManualRetryStatus({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryStatusResponse>;
|
|
82
75
|
/**
|
|
@@ -85,9 +78,8 @@ declare class Webhook {
|
|
|
85
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
79
|
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse[]>} - Success response
|
|
87
80
|
* @name getReportFilters
|
|
88
|
-
* @summary: Get filters
|
|
89
|
-
* @description: Retrieve filters for
|
|
90
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
|
|
81
|
+
* @summary: Get report filters.
|
|
82
|
+
* @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
|
|
91
83
|
*/
|
|
92
84
|
getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse[]>;
|
|
93
85
|
/**
|
|
@@ -96,8 +88,8 @@ declare class Webhook {
|
|
|
96
88
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
97
89
|
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
98
90
|
* @name getSubscriberById
|
|
99
|
-
* @summary: Get
|
|
100
|
-
* @description:
|
|
91
|
+
* @summary: Get subscriber by ID.
|
|
92
|
+
* @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
|
|
101
93
|
*/
|
|
102
94
|
getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
|
|
103
95
|
/**
|
|
@@ -106,9 +98,8 @@ declare class Webhook {
|
|
|
106
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
107
99
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
108
100
|
* @name getSubscribersByCompany
|
|
109
|
-
* @summary: Get
|
|
110
|
-
* @description:
|
|
111
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
101
|
+
* @summary: Get subscribers by company.
|
|
102
|
+
* @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
112
103
|
*/
|
|
113
104
|
getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
|
|
114
105
|
/**
|
|
@@ -117,8 +108,8 @@ declare class Webhook {
|
|
|
117
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
118
109
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
119
110
|
* @name getSubscribersByExtensionId
|
|
120
|
-
* @summary: Get
|
|
121
|
-
* @description:
|
|
111
|
+
* @summary: Get subscribers by extension ID.
|
|
112
|
+
* @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
|
|
122
113
|
*/
|
|
123
114
|
getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
|
|
124
115
|
/**
|
|
@@ -127,9 +118,8 @@ declare class Webhook {
|
|
|
127
118
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
128
119
|
* @returns {Promise<string>} - Success response
|
|
129
120
|
* @name manualRetryCancel
|
|
130
|
-
* @summary:
|
|
131
|
-
* @description:
|
|
132
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
|
|
121
|
+
* @summary: Manual retry cancellation.
|
|
122
|
+
* @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
|
|
133
123
|
*/
|
|
134
124
|
manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
|
|
135
125
|
/**
|
|
@@ -138,9 +128,8 @@ declare class Webhook {
|
|
|
138
128
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
139
129
|
* @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
|
|
140
130
|
* @name manualRetryOfFailedEvent
|
|
141
|
-
* @summary:
|
|
142
|
-
* @description:
|
|
143
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
|
|
131
|
+
* @summary: Manual retry of failed event.
|
|
132
|
+
* @description: Trigger a manual retry for an event that failed to deliver. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
|
|
144
133
|
*/
|
|
145
134
|
manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetrySuccessResponse>;
|
|
146
135
|
/**
|
|
@@ -149,9 +138,8 @@ declare class Webhook {
|
|
|
149
138
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
139
|
* @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
|
|
151
140
|
* @name pingWebhook
|
|
152
|
-
* @summary: Ping
|
|
153
|
-
* @description:
|
|
154
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
141
|
+
* @summary: Ping webhook.
|
|
142
|
+
* @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
155
143
|
*/
|
|
156
144
|
pingWebhook({ body, requestHeaders }?: WebhookPlatformValidator.PingWebhookParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.PingWebhookResponse>;
|
|
157
145
|
/**
|
|
@@ -161,9 +149,8 @@ declare class Webhook {
|
|
|
161
149
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
162
150
|
* Success response
|
|
163
151
|
* @name registerSubscriberToEvent
|
|
164
|
-
* @summary: Register
|
|
165
|
-
* @description:
|
|
166
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
|
|
152
|
+
* @summary: Register subscriber to event.
|
|
153
|
+
* @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
|
|
167
154
|
*/
|
|
168
155
|
registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
169
156
|
/**
|
|
@@ -173,8 +160,8 @@ declare class Webhook {
|
|
|
173
160
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
174
161
|
* Success response
|
|
175
162
|
* @name updateSubscriberConfig
|
|
176
|
-
* @summary: Update
|
|
177
|
-
* @description:
|
|
163
|
+
* @summary: Update subscriber config.
|
|
164
|
+
* @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
178
165
|
*/
|
|
179
166
|
updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
180
167
|
}
|