@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
|
@@ -8,8 +8,8 @@ declare class Theme {
|
|
|
8
8
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<ThemePartnerModel.AllAvailablePageSchema>} - Success response
|
|
10
10
|
* @name getAllPages
|
|
11
|
-
* @summary: Get all pages
|
|
12
|
-
* @description:
|
|
11
|
+
* @summary: Get all pages.
|
|
12
|
+
* @description: Retrieve a list of all pages available in the partner server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getAllPages/).
|
|
13
13
|
*/
|
|
14
14
|
getAllPages({ companyId, applicationId, themeId, requestHeaders }?: ThemePartnerValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemePartnerModel.AllAvailablePageSchema>;
|
|
15
15
|
/**
|
|
@@ -18,8 +18,8 @@ declare class Theme {
|
|
|
18
18
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
20
20
|
* @name createPage
|
|
21
|
-
* @summary: Create
|
|
22
|
-
* @description:
|
|
21
|
+
* @summary: Create page.
|
|
22
|
+
* @description: Add a new page to the partner server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/createPage/).
|
|
23
23
|
*/
|
|
24
24
|
createPage({ companyId, applicationId, themeId, body, requestHeaders }?: ThemePartnerValidator.CreatePageParam, { responseHeaders }?: object): Promise<ThemePartnerModel.AvailablePageSchema>;
|
|
25
25
|
/**
|
|
@@ -28,8 +28,8 @@ declare class Theme {
|
|
|
28
28
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<ThemePartnerModel.AllAvailablePageSchema>} - Success response
|
|
30
30
|
* @name updateMultiplePages
|
|
31
|
-
* @summary: Update multiple pages
|
|
32
|
-
* @description:
|
|
31
|
+
* @summary: Update multiple pages.
|
|
32
|
+
* @description: Modify and update multiple pages in the partner server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updateMultiplePages/).
|
|
33
33
|
*/
|
|
34
34
|
updateMultiplePages({ companyId, applicationId, themeId, body, requestHeaders }?: ThemePartnerValidator.UpdateMultiplePagesParam, { responseHeaders }?: object): Promise<ThemePartnerModel.AllAvailablePageSchema>;
|
|
35
35
|
/**
|
|
@@ -38,8 +38,8 @@ declare class Theme {
|
|
|
38
38
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
40
40
|
* @name getPage
|
|
41
|
-
* @summary: Get page
|
|
42
|
-
* @description:
|
|
41
|
+
* @summary: Get page.
|
|
42
|
+
* @description: Obtain detailed information about a specific page in the partner server. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getPage/).
|
|
43
43
|
*/
|
|
44
44
|
getPage({ companyId, applicationId, themeId, pageValue, requestHeaders }?: ThemePartnerValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemePartnerModel.AvailablePageSchema>;
|
|
45
45
|
/**
|
|
@@ -48,8 +48,8 @@ declare class Theme {
|
|
|
48
48
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
50
50
|
* @name updatePage
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description:
|
|
51
|
+
* @summary: Update page.
|
|
52
|
+
* @description: Modify and update information related to a specific page in the partner server. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updatePage/).
|
|
53
53
|
*/
|
|
54
54
|
updatePage({ companyId, applicationId, themeId, pageValue, body, requestHeaders }?: ThemePartnerValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePartnerModel.AvailablePageSchema>;
|
|
55
55
|
/**
|
|
@@ -58,8 +58,8 @@ declare class Theme {
|
|
|
58
58
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
60
60
|
* @name deletePage
|
|
61
|
-
* @summary:
|
|
62
|
-
* @description:
|
|
61
|
+
* @summary: Delete page.
|
|
62
|
+
* @description: Remove a page from the partner server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/deletePage/).
|
|
63
63
|
*/
|
|
64
64
|
deletePage({ companyId, applicationId, themeId, pageValue, requestHeaders }?: ThemePartnerValidator.DeletePageParam, { responseHeaders }?: object): Promise<ThemePartnerModel.AvailablePageSchema>;
|
|
65
65
|
/**
|
|
@@ -68,8 +68,8 @@ declare class Theme {
|
|
|
68
68
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
69
69
|
* @returns {Promise<ThemePartnerModel.ThemesSchema[]>} - Success response
|
|
70
70
|
* @name getApplicationThemes
|
|
71
|
-
* @summary: Get
|
|
72
|
-
* @description:
|
|
71
|
+
* @summary: Get application themes.
|
|
72
|
+
* @description: Retrieve a list of themes available for the partner server application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getApplicationThemes/).
|
|
73
73
|
*/
|
|
74
74
|
getApplicationThemes({ companyId, applicationId, requestHeaders }?: ThemePartnerValidator.GetApplicationThemesParam, { responseHeaders }?: object): Promise<ThemePartnerModel.ThemesSchema[]>;
|
|
75
75
|
/**
|
|
@@ -78,8 +78,8 @@ declare class Theme {
|
|
|
78
78
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<ThemePartnerModel.ThemesSchema>} - Success response
|
|
80
80
|
* @name getThemeById
|
|
81
|
-
* @summary: Get
|
|
82
|
-
* @description:
|
|
81
|
+
* @summary: Get theme by ID.
|
|
82
|
+
* @description: Obtain detailed information about a theme using its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getThemeById/).
|
|
83
83
|
*/
|
|
84
84
|
getThemeById({ companyId, applicationId, themeId, requestHeaders }?: ThemePartnerValidator.GetThemeByIdParam, { responseHeaders }?: object): Promise<ThemePartnerModel.ThemesSchema>;
|
|
85
85
|
/**
|
|
@@ -88,8 +88,8 @@ declare class Theme {
|
|
|
88
88
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
89
89
|
* @returns {Promise<ThemePartnerModel.ThemesSchema>} - Success response
|
|
90
90
|
* @name updateTheme
|
|
91
|
-
* @summary: Update theme
|
|
92
|
-
* @description:
|
|
91
|
+
* @summary: Update theme.
|
|
92
|
+
* @description: Modify and update information related to a theme in the partner server. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updateTheme/).
|
|
93
93
|
*/
|
|
94
94
|
updateTheme({ companyId, applicationId, themeId, body, requestHeaders }?: ThemePartnerValidator.UpdateThemeParam, { responseHeaders }?: object): Promise<ThemePartnerModel.ThemesSchema>;
|
|
95
95
|
/**
|
|
@@ -98,8 +98,8 @@ declare class Theme {
|
|
|
98
98
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<ThemePartnerModel.ThemesSchema>} - Success response
|
|
100
100
|
* @name deleteTheme
|
|
101
|
-
* @summary: Delete
|
|
102
|
-
* @description:
|
|
101
|
+
* @summary: Delete theme.
|
|
102
|
+
* @description: Remove a theme from the partner server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/deleteTheme/).
|
|
103
103
|
*/
|
|
104
104
|
deleteTheme({ companyId, applicationId, themeId, requestHeaders }?: ThemePartnerValidator.DeleteThemeParam, { responseHeaders }?: object): Promise<ThemePartnerModel.ThemesSchema>;
|
|
105
105
|
/**
|
|
@@ -108,8 +108,8 @@ declare class Theme {
|
|
|
108
108
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
109
109
|
* @returns {Promise<ThemePartnerModel.MarketplaceThemeSchema>} - Success response
|
|
110
110
|
* @name getOrganizationThemes
|
|
111
|
-
* @summary: Get organization
|
|
112
|
-
* @description:
|
|
111
|
+
* @summary: Get organization themes.
|
|
112
|
+
* @description: Retrieve a list of themes associated with partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getOrganizationThemes/).
|
|
113
113
|
*/
|
|
114
114
|
getOrganizationThemes({ status, pageSize, pageNo, requestHeaders }?: ThemePartnerValidator.GetOrganizationThemesParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceThemeSchema>;
|
|
115
115
|
/**
|
|
@@ -118,8 +118,8 @@ declare class Theme {
|
|
|
118
118
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
119
119
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
120
120
|
* @name getOrganizationThemeDetails
|
|
121
|
-
* @summary: Get theme details
|
|
122
|
-
* @description:
|
|
121
|
+
* @summary: Get organization theme details.
|
|
122
|
+
* @description: Obtain detailed information about a theme within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getOrganizationThemeDetails/).
|
|
123
123
|
*/
|
|
124
124
|
getOrganizationThemeDetails({ themeId, requestHeaders }?: ThemePartnerValidator.GetOrganizationThemeDetailsParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceTheme>;
|
|
125
125
|
/**
|
|
@@ -128,8 +128,8 @@ declare class Theme {
|
|
|
128
128
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
129
129
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
130
130
|
* @name updateDraftTheme
|
|
131
|
-
* @summary: Update theme
|
|
132
|
-
* @description:
|
|
131
|
+
* @summary: Update draft theme.
|
|
132
|
+
* @description: Modify and update a draft theme in partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updateDraftTheme/).
|
|
133
133
|
*/
|
|
134
134
|
updateDraftTheme({ themeId, body, requestHeaders }?: ThemePartnerValidator.UpdateDraftThemeParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceTheme>;
|
|
135
135
|
/**
|
|
@@ -138,8 +138,8 @@ declare class Theme {
|
|
|
138
138
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
139
139
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
140
140
|
* @name submitOrganizationTheme
|
|
141
|
-
* @summary: Submit
|
|
142
|
-
* @description:
|
|
141
|
+
* @summary: Submit organization theme.
|
|
142
|
+
* @description: Initiate the process of submitting a theme within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/submitOrganizationTheme/).
|
|
143
143
|
*/
|
|
144
144
|
submitOrganizationTheme({ themeId, body, requestHeaders }?: ThemePartnerValidator.SubmitOrganizationThemeParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceTheme>;
|
|
145
145
|
/**
|
|
@@ -148,8 +148,8 @@ declare class Theme {
|
|
|
148
148
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
149
149
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
150
150
|
* @name deleteOrganizationTheme
|
|
151
|
-
* @summary: Delete
|
|
152
|
-
* @description:
|
|
151
|
+
* @summary: Delete organization theme.
|
|
152
|
+
* @description: Remove a theme from partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/deleteOrganizationTheme/).
|
|
153
153
|
*/
|
|
154
154
|
deleteOrganizationTheme({ themeId, requestHeaders }?: ThemePartnerValidator.DeleteOrganizationThemeParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceTheme>;
|
|
155
155
|
/**
|
|
@@ -158,8 +158,8 @@ declare class Theme {
|
|
|
158
158
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
159
159
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme[]>} - Success response
|
|
160
160
|
* @name getLatestVersionOfThemeBySlug
|
|
161
|
-
* @summary: Get latest version of
|
|
162
|
-
* @description:
|
|
161
|
+
* @summary: Get latest version of theme by slug.
|
|
162
|
+
* @description: Retrieve the most recent version of a theme using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getLatestVersionOfThemeBySlug/).
|
|
163
163
|
*/
|
|
164
164
|
getLatestVersionOfThemeBySlug({ slugName, requestHeaders }?: ThemePartnerValidator.GetLatestVersionOfThemeBySlugParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceTheme[]>;
|
|
165
165
|
/**
|
|
@@ -168,8 +168,8 @@ declare class Theme {
|
|
|
168
168
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
169
169
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
170
170
|
* @name createNewThemeInOrganization
|
|
171
|
-
* @summary: Create
|
|
172
|
-
* @description:
|
|
171
|
+
* @summary: Create new theme in organization.
|
|
172
|
+
* @description: Add a new theme to partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/createNewThemeInOrganization/).
|
|
173
173
|
*/
|
|
174
174
|
createNewThemeInOrganization({ body, slug, requestHeaders }?: ThemePartnerValidator.CreateNewThemeInOrganizationParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceTheme>;
|
|
175
175
|
/**
|
|
@@ -178,8 +178,8 @@ declare class Theme {
|
|
|
178
178
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
179
179
|
* @returns {Promise<ThemePartnerModel.ThemeRejectionReasons>} - Success response
|
|
180
180
|
* @name getThemeRejectionReasons
|
|
181
|
-
* @summary: Get theme rejection reasons
|
|
182
|
-
* @description:
|
|
181
|
+
* @summary: Get theme rejection reasons.
|
|
182
|
+
* @description: Retrieve reasons for the rejection of themes within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getThemeRejectionReasons/).
|
|
183
183
|
*/
|
|
184
184
|
getThemeRejectionReasons({ themeId, requestHeaders }?: ThemePartnerValidator.GetThemeRejectionReasonsParam, { responseHeaders }?: object): Promise<ThemePartnerModel.ThemeRejectionReasons>;
|
|
185
185
|
/**
|
|
@@ -188,8 +188,8 @@ declare class Theme {
|
|
|
188
188
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
189
189
|
* @returns {Promise<ThemePartnerModel.MarketplaceThemeSchema>} - Success response
|
|
190
190
|
* @name getThemeVersions
|
|
191
|
-
* @summary: Get theme versions
|
|
192
|
-
* @description: Retrieve a list of
|
|
191
|
+
* @summary: Get theme versions.
|
|
192
|
+
* @description: Retrieve a list of versions available for a theme within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getThemeVersions/).
|
|
193
193
|
*/
|
|
194
194
|
getThemeVersions({ themeSlug, pageSize, pageNo, requestHeaders }?: ThemePartnerValidator.GetThemeVersionsParam, { responseHeaders }?: object): Promise<ThemePartnerModel.MarketplaceThemeSchema>;
|
|
195
195
|
/**
|
|
@@ -20,8 +20,8 @@ class Theme {
|
|
|
20
20
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ThemePartnerModel.AllAvailablePageSchema>} - Success response
|
|
22
22
|
* @name getAllPages
|
|
23
|
-
* @summary: Get all pages
|
|
24
|
-
* @description:
|
|
23
|
+
* @summary: Get all pages.
|
|
24
|
+
* @description: Retrieve a list of all pages available in the partner server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getAllPages/).
|
|
25
25
|
*/
|
|
26
26
|
async getAllPages(
|
|
27
27
|
{ companyId, applicationId, themeId, requestHeaders } = {
|
|
@@ -97,8 +97,8 @@ class Theme {
|
|
|
97
97
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
98
98
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
99
99
|
* @name createPage
|
|
100
|
-
* @summary: Create
|
|
101
|
-
* @description:
|
|
100
|
+
* @summary: Create page.
|
|
101
|
+
* @description: Add a new page to the partner server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/createPage/).
|
|
102
102
|
*/
|
|
103
103
|
async createPage(
|
|
104
104
|
{ companyId, applicationId, themeId, body, requestHeaders } = {
|
|
@@ -181,8 +181,8 @@ class Theme {
|
|
|
181
181
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
182
182
|
* @returns {Promise<ThemePartnerModel.AllAvailablePageSchema>} - Success response
|
|
183
183
|
* @name updateMultiplePages
|
|
184
|
-
* @summary: Update multiple pages
|
|
185
|
-
* @description:
|
|
184
|
+
* @summary: Update multiple pages.
|
|
185
|
+
* @description: Modify and update multiple pages in the partner server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updateMultiplePages/).
|
|
186
186
|
*/
|
|
187
187
|
async updateMultiplePages(
|
|
188
188
|
{ companyId, applicationId, themeId, body, requestHeaders } = {
|
|
@@ -267,8 +267,8 @@ class Theme {
|
|
|
267
267
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
268
268
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
269
269
|
* @name getPage
|
|
270
|
-
* @summary: Get page
|
|
271
|
-
* @description:
|
|
270
|
+
* @summary: Get page.
|
|
271
|
+
* @description: Obtain detailed information about a specific page in the partner server. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getPage/).
|
|
272
272
|
*/
|
|
273
273
|
async getPage(
|
|
274
274
|
{ companyId, applicationId, themeId, pageValue, requestHeaders } = {
|
|
@@ -345,8 +345,8 @@ class Theme {
|
|
|
345
345
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
346
346
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
347
347
|
* @name updatePage
|
|
348
|
-
* @summary:
|
|
349
|
-
* @description:
|
|
348
|
+
* @summary: Update page.
|
|
349
|
+
* @description: Modify and update information related to a specific page in the partner server. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updatePage/).
|
|
350
350
|
*/
|
|
351
351
|
async updatePage(
|
|
352
352
|
{ companyId, applicationId, themeId, pageValue, body, requestHeaders } = {
|
|
@@ -431,8 +431,8 @@ class Theme {
|
|
|
431
431
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
432
432
|
* @returns {Promise<ThemePartnerModel.AvailablePageSchema>} - Success response
|
|
433
433
|
* @name deletePage
|
|
434
|
-
* @summary:
|
|
435
|
-
* @description:
|
|
434
|
+
* @summary: Delete page.
|
|
435
|
+
* @description: Remove a page from the partner server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/deletePage/).
|
|
436
436
|
*/
|
|
437
437
|
async deletePage(
|
|
438
438
|
{ companyId, applicationId, themeId, pageValue, requestHeaders } = {
|
|
@@ -509,8 +509,8 @@ class Theme {
|
|
|
509
509
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
510
510
|
* @returns {Promise<ThemePartnerModel.ThemesSchema[]>} - Success response
|
|
511
511
|
* @name getApplicationThemes
|
|
512
|
-
* @summary: Get
|
|
513
|
-
* @description:
|
|
512
|
+
* @summary: Get application themes.
|
|
513
|
+
* @description: Retrieve a list of themes available for the partner server application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getApplicationThemes/).
|
|
514
514
|
*/
|
|
515
515
|
async getApplicationThemes(
|
|
516
516
|
{ companyId, applicationId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -582,8 +582,8 @@ class Theme {
|
|
|
582
582
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
583
583
|
* @returns {Promise<ThemePartnerModel.ThemesSchema>} - Success response
|
|
584
584
|
* @name getThemeById
|
|
585
|
-
* @summary: Get
|
|
586
|
-
* @description:
|
|
585
|
+
* @summary: Get theme by ID.
|
|
586
|
+
* @description: Obtain detailed information about a theme using its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getThemeById/).
|
|
587
587
|
*/
|
|
588
588
|
async getThemeById(
|
|
589
589
|
{ companyId, applicationId, themeId, requestHeaders } = {
|
|
@@ -659,8 +659,8 @@ class Theme {
|
|
|
659
659
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
660
660
|
* @returns {Promise<ThemePartnerModel.ThemesSchema>} - Success response
|
|
661
661
|
* @name updateTheme
|
|
662
|
-
* @summary: Update theme
|
|
663
|
-
* @description:
|
|
662
|
+
* @summary: Update theme.
|
|
663
|
+
* @description: Modify and update information related to a theme in the partner server. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updateTheme/).
|
|
664
664
|
*/
|
|
665
665
|
async updateTheme(
|
|
666
666
|
{ companyId, applicationId, themeId, body, requestHeaders } = {
|
|
@@ -743,8 +743,8 @@ class Theme {
|
|
|
743
743
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
744
744
|
* @returns {Promise<ThemePartnerModel.ThemesSchema>} - Success response
|
|
745
745
|
* @name deleteTheme
|
|
746
|
-
* @summary: Delete
|
|
747
|
-
* @description:
|
|
746
|
+
* @summary: Delete theme.
|
|
747
|
+
* @description: Remove a theme from the partner server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/deleteTheme/).
|
|
748
748
|
*/
|
|
749
749
|
async deleteTheme(
|
|
750
750
|
{ companyId, applicationId, themeId, requestHeaders } = {
|
|
@@ -820,8 +820,8 @@ class Theme {
|
|
|
820
820
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
821
821
|
* @returns {Promise<ThemePartnerModel.MarketplaceThemeSchema>} - Success response
|
|
822
822
|
* @name getOrganizationThemes
|
|
823
|
-
* @summary: Get organization
|
|
824
|
-
* @description:
|
|
823
|
+
* @summary: Get organization themes.
|
|
824
|
+
* @description: Retrieve a list of themes associated with partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getOrganizationThemes/).
|
|
825
825
|
*/
|
|
826
826
|
async getOrganizationThemes(
|
|
827
827
|
{ status, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -904,8 +904,8 @@ class Theme {
|
|
|
904
904
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
905
905
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
906
906
|
* @name getOrganizationThemeDetails
|
|
907
|
-
* @summary: Get theme details
|
|
908
|
-
* @description:
|
|
907
|
+
* @summary: Get organization theme details.
|
|
908
|
+
* @description: Obtain detailed information about a theme within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getOrganizationThemeDetails/).
|
|
909
909
|
*/
|
|
910
910
|
async getOrganizationThemeDetails(
|
|
911
911
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -983,8 +983,8 @@ class Theme {
|
|
|
983
983
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
984
984
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
985
985
|
* @name updateDraftTheme
|
|
986
|
-
* @summary: Update theme
|
|
987
|
-
* @description:
|
|
986
|
+
* @summary: Update draft theme.
|
|
987
|
+
* @description: Modify and update a draft theme in partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/updateDraftTheme/).
|
|
988
988
|
*/
|
|
989
989
|
async updateDraftTheme(
|
|
990
990
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1062,8 +1062,8 @@ class Theme {
|
|
|
1062
1062
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1063
1063
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
1064
1064
|
* @name submitOrganizationTheme
|
|
1065
|
-
* @summary: Submit
|
|
1066
|
-
* @description:
|
|
1065
|
+
* @summary: Submit organization theme.
|
|
1066
|
+
* @description: Initiate the process of submitting a theme within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/submitOrganizationTheme/).
|
|
1067
1067
|
*/
|
|
1068
1068
|
async submitOrganizationTheme(
|
|
1069
1069
|
{ themeId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1141,8 +1141,8 @@ class Theme {
|
|
|
1141
1141
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1142
1142
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
1143
1143
|
* @name deleteOrganizationTheme
|
|
1144
|
-
* @summary: Delete
|
|
1145
|
-
* @description:
|
|
1144
|
+
* @summary: Delete organization theme.
|
|
1145
|
+
* @description: Remove a theme from partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/deleteOrganizationTheme/).
|
|
1146
1146
|
*/
|
|
1147
1147
|
async deleteOrganizationTheme(
|
|
1148
1148
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1218,8 +1218,8 @@ class Theme {
|
|
|
1218
1218
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1219
1219
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme[]>} - Success response
|
|
1220
1220
|
* @name getLatestVersionOfThemeBySlug
|
|
1221
|
-
* @summary: Get latest version of
|
|
1222
|
-
* @description:
|
|
1221
|
+
* @summary: Get latest version of theme by slug.
|
|
1222
|
+
* @description: Retrieve the most recent version of a theme using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getLatestVersionOfThemeBySlug/).
|
|
1223
1223
|
*/
|
|
1224
1224
|
async getLatestVersionOfThemeBySlug(
|
|
1225
1225
|
{ slugName, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1294,8 +1294,8 @@ class Theme {
|
|
|
1294
1294
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1295
1295
|
* @returns {Promise<ThemePartnerModel.MarketplaceTheme>} - Success response
|
|
1296
1296
|
* @name createNewThemeInOrganization
|
|
1297
|
-
* @summary: Create
|
|
1298
|
-
* @description:
|
|
1297
|
+
* @summary: Create new theme in organization.
|
|
1298
|
+
* @description: Add a new theme to partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/createNewThemeInOrganization/).
|
|
1299
1299
|
*/
|
|
1300
1300
|
async createNewThemeInOrganization(
|
|
1301
1301
|
{ body, slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1376,8 +1376,8 @@ class Theme {
|
|
|
1376
1376
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1377
1377
|
* @returns {Promise<ThemePartnerModel.ThemeRejectionReasons>} - Success response
|
|
1378
1378
|
* @name getThemeRejectionReasons
|
|
1379
|
-
* @summary: Get theme rejection reasons
|
|
1380
|
-
* @description:
|
|
1379
|
+
* @summary: Get theme rejection reasons.
|
|
1380
|
+
* @description: Retrieve reasons for the rejection of themes within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getThemeRejectionReasons/).
|
|
1381
1381
|
*/
|
|
1382
1382
|
async getThemeRejectionReasons(
|
|
1383
1383
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1453,8 +1453,8 @@ class Theme {
|
|
|
1453
1453
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1454
1454
|
* @returns {Promise<ThemePartnerModel.MarketplaceThemeSchema>} - Success response
|
|
1455
1455
|
* @name getThemeVersions
|
|
1456
|
-
* @summary: Get theme versions
|
|
1457
|
-
* @description: Retrieve a list of
|
|
1456
|
+
* @summary: Get theme versions.
|
|
1457
|
+
* @description: Retrieve a list of versions available for a theme within partner server organizations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/theme/getThemeVersions/).
|
|
1458
1458
|
*/
|
|
1459
1459
|
async getThemeVersions(
|
|
1460
1460
|
{ themeSlug, pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -8,8 +8,8 @@ declare class AuditTrail {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
|
|
10
10
|
* @name createAuditLog
|
|
11
|
-
* @summary: Create
|
|
12
|
-
* @description:
|
|
11
|
+
* @summary: Create an audit log.
|
|
12
|
+
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
|
|
13
13
|
*/
|
|
14
14
|
createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResponse>;
|
|
15
15
|
/**
|
|
@@ -18,8 +18,8 @@ declare class AuditTrail {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
20
20
|
* @name getAuditLog
|
|
21
|
-
* @summary: Get audit log
|
|
22
|
-
* @description:
|
|
21
|
+
* @summary: Get an audit log entry.
|
|
22
|
+
* @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
|
|
23
23
|
*/
|
|
24
24
|
getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
|
|
25
25
|
/**
|
|
@@ -28,8 +28,8 @@ declare class AuditTrail {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
30
30
|
* @name getAuditLogs
|
|
31
|
-
* @summary:
|
|
32
|
-
* @description:
|
|
31
|
+
* @summary: Retrieve audit logs.
|
|
32
|
+
* @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
|
|
33
33
|
*/
|
|
34
34
|
getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
|
|
35
35
|
/**
|
|
@@ -38,8 +38,8 @@ declare class AuditTrail {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
|
|
40
40
|
* @name getEntityTypes
|
|
41
|
-
* @summary:
|
|
42
|
-
* @description:
|
|
41
|
+
* @summary: Obtain entity types for auditing.
|
|
42
|
+
* @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
|
|
43
43
|
*/
|
|
44
44
|
getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
|
|
45
45
|
}
|
|
@@ -20,8 +20,8 @@ class AuditTrail {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
|
|
22
22
|
* @name createAuditLog
|
|
23
|
-
* @summary: Create
|
|
24
|
-
* @description:
|
|
23
|
+
* @summary: Create an audit log.
|
|
24
|
+
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
|
|
25
25
|
*/
|
|
26
26
|
async createAuditLog(
|
|
27
27
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -99,8 +99,8 @@ class AuditTrail {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
101
101
|
* @name getAuditLog
|
|
102
|
-
* @summary: Get audit log
|
|
103
|
-
* @description:
|
|
102
|
+
* @summary: Get an audit log entry.
|
|
103
|
+
* @description: Retrieve a specific audit log entry - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
|
|
104
104
|
*/
|
|
105
105
|
async getAuditLog(
|
|
106
106
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -178,8 +178,8 @@ class AuditTrail {
|
|
|
178
178
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
179
|
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
180
180
|
* @name getAuditLogs
|
|
181
|
-
* @summary:
|
|
182
|
-
* @description:
|
|
181
|
+
* @summary: Retrieve audit logs.
|
|
182
|
+
* @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
|
|
183
183
|
*/
|
|
184
184
|
async getAuditLogs(
|
|
185
185
|
{ qs, limit, sort, requestHeaders } = { requestHeaders: {} },
|
|
@@ -264,8 +264,8 @@ class AuditTrail {
|
|
|
264
264
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
265
265
|
* @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
|
|
266
266
|
* @name getEntityTypes
|
|
267
|
-
* @summary:
|
|
268
|
-
* @description:
|
|
267
|
+
* @summary: Obtain entity types for auditing.
|
|
268
|
+
* @description: List of entity types that can be audited within the platform's - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
|
|
269
269
|
*/
|
|
270
270
|
async getEntityTypes(
|
|
271
271
|
{ requestHeaders } = { requestHeaders: {} },
|