@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/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/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/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/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 +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- 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 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- 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/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/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/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 +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- 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
|
@@ -114,7 +114,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
114
114
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
115
115
|
* @property {string} [channelId] - Zones filtered by an application
|
|
116
116
|
* @property {string} [q] - Search with name as a free text
|
|
117
|
-
* @property {string} [
|
|
117
|
+
* @property {string} [country] - ISO2 code of the country
|
|
118
118
|
* @property {string} [state] - State name
|
|
119
119
|
* @property {string} [city] - City name
|
|
120
120
|
* @property {string} [pincode] - Pincode value to search zones
|
|
@@ -461,7 +461,7 @@ type GetZonesParam = {
|
|
|
461
461
|
/**
|
|
462
462
|
* - ISO2 code of the country
|
|
463
463
|
*/
|
|
464
|
-
|
|
464
|
+
country?: string;
|
|
465
465
|
/**
|
|
466
466
|
* - State name
|
|
467
467
|
*/
|
|
@@ -136,7 +136,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
136
136
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
137
137
|
* @property {string} [channelId] - Zones filtered by an application
|
|
138
138
|
* @property {string} [q] - Search with name as a free text
|
|
139
|
-
* @property {string} [
|
|
139
|
+
* @property {string} [country] - ISO2 code of the country
|
|
140
140
|
* @property {string} [state] - State name
|
|
141
141
|
* @property {string} [city] - City name
|
|
142
142
|
* @property {string} [pincode] - Pincode value to search zones
|
|
@@ -356,7 +356,7 @@ class ServiceabilityPlatformValidator {
|
|
|
356
356
|
isActive: Joi.boolean(),
|
|
357
357
|
channelId: Joi.string().allow(""),
|
|
358
358
|
q: Joi.string().allow(""),
|
|
359
|
-
|
|
359
|
+
country: Joi.string().allow(""),
|
|
360
360
|
state: Joi.string().allow(""),
|
|
361
361
|
city: Joi.string().allow(""),
|
|
362
362
|
pincode: Joi.string().allow(""),
|
|
@@ -9,8 +9,8 @@ declare class Share {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
11
11
|
* @name createShortLink
|
|
12
|
-
* @summary: Create short link
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Create short link.
|
|
13
|
+
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
|
|
14
14
|
*/
|
|
15
15
|
createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
16
16
|
/**
|
|
@@ -19,8 +19,8 @@ declare class Share {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
21
21
|
* @name getShortLinkByHash
|
|
22
|
-
* @summary: Get short link by hash
|
|
23
|
-
* @description:
|
|
22
|
+
* @summary: Get short link by hash.
|
|
23
|
+
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
|
|
24
24
|
*/
|
|
25
25
|
getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
26
26
|
/**
|
|
@@ -31,8 +31,8 @@ declare class Share {
|
|
|
31
31
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
32
|
* @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
|
|
33
33
|
* @name getShortLinkClickStats
|
|
34
|
-
* @summary: Get click statistics
|
|
35
|
-
* @description: Retrieve
|
|
34
|
+
* @summary: Get short link click statistics.
|
|
35
|
+
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
|
|
36
36
|
*/
|
|
37
37
|
getShortLinkClickStats({ surlId, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkClickStatsParam, { responseHeaders }?: object): Promise<SharePlatformModel.ClickStatsResponse>;
|
|
38
38
|
/**
|
|
@@ -41,8 +41,8 @@ declare class Share {
|
|
|
41
41
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
42
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
43
43
|
* @name getShortLinks
|
|
44
|
-
* @summary: Get short links
|
|
45
|
-
* @description:
|
|
44
|
+
* @summary: Get short links.
|
|
45
|
+
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
46
46
|
*/
|
|
47
47
|
getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
|
|
48
48
|
/**
|
|
@@ -53,8 +53,8 @@ declare class Share {
|
|
|
53
53
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
55
55
|
* @name updateShortLinkById
|
|
56
|
-
* @summary: Update short link by
|
|
57
|
-
* @description: Update short link by
|
|
56
|
+
* @summary: Update short link by ID.
|
|
57
|
+
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
|
|
58
58
|
*/
|
|
59
59
|
updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
|
|
60
60
|
}
|
|
@@ -21,8 +21,8 @@ class Share {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
23
23
|
* @name createShortLink
|
|
24
|
-
* @summary: Create short link
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Create short link.
|
|
25
|
+
* @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
|
|
26
26
|
*/
|
|
27
27
|
async createShortLink(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -100,8 +100,8 @@ class Share {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
102
102
|
* @name getShortLinkByHash
|
|
103
|
-
* @summary: Get short link by hash
|
|
104
|
-
* @description:
|
|
103
|
+
* @summary: Get short link by hash.
|
|
104
|
+
* @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
|
|
105
105
|
*/
|
|
106
106
|
async getShortLinkByHash(
|
|
107
107
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
@@ -181,8 +181,8 @@ class Share {
|
|
|
181
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
182
|
* @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
|
|
183
183
|
* @name getShortLinkClickStats
|
|
184
|
-
* @summary: Get click statistics
|
|
185
|
-
* @description: Retrieve
|
|
184
|
+
* @summary: Get short link click statistics.
|
|
185
|
+
* @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
|
|
186
186
|
*/
|
|
187
187
|
async getShortLinkClickStats(
|
|
188
188
|
{ surlId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -257,8 +257,8 @@ class Share {
|
|
|
257
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
|
|
259
259
|
* @name getShortLinks
|
|
260
|
-
* @summary: Get short links
|
|
261
|
-
* @description:
|
|
260
|
+
* @summary: Get short links.
|
|
261
|
+
* @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
262
262
|
*/
|
|
263
263
|
async getShortLinks(
|
|
264
264
|
{
|
|
@@ -366,8 +366,8 @@ class Share {
|
|
|
366
366
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
367
367
|
* @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
|
|
368
368
|
* @name updateShortLinkById
|
|
369
|
-
* @summary: Update short link by
|
|
370
|
-
* @description: Update short link by
|
|
369
|
+
* @summary: Update short link by ID.
|
|
370
|
+
* @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
|
|
371
371
|
*/
|
|
372
372
|
async updateShortLinkById(
|
|
373
373
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -11,8 +11,8 @@ declare class Theme {
|
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
12
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
13
13
|
* @name addThemeToApplication
|
|
14
|
-
* @summary: Add
|
|
15
|
-
* @description:
|
|
14
|
+
* @summary: Add theme to application.
|
|
15
|
+
* @description: Include a theme in an application's design. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addThemeToApplication/).
|
|
16
16
|
*/
|
|
17
17
|
addThemeToApplication({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddThemeToApplicationParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
18
18
|
/**
|
|
@@ -21,8 +21,8 @@ declare class Theme {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
23
23
|
* @name addToThemeLibrary
|
|
24
|
-
* @summary: Add
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Add to theme library.
|
|
25
|
+
* @description: Store and add a theme to the platform's library. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addToThemeLibrary/).
|
|
26
26
|
*/
|
|
27
27
|
addToThemeLibrary({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddToThemeLibraryParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
28
28
|
/**
|
|
@@ -31,8 +31,8 @@ declare class Theme {
|
|
|
31
31
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
32
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
33
33
|
* @name applyTheme
|
|
34
|
-
* @summary: Apply theme
|
|
35
|
-
* @description:
|
|
34
|
+
* @summary: Apply theme.
|
|
35
|
+
* @description: Set and apply a theme to an application or page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/applyTheme/).
|
|
36
36
|
*/
|
|
37
37
|
applyTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ApplyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
38
38
|
/**
|
|
@@ -41,8 +41,8 @@ declare class Theme {
|
|
|
41
41
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
42
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
43
43
|
* @name archiveTheme
|
|
44
|
-
* @summary: Archive
|
|
45
|
-
* @description:
|
|
44
|
+
* @summary: Archive theme.
|
|
45
|
+
* @description: Store a theme in an archive. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/archiveTheme/).
|
|
46
46
|
*/
|
|
47
47
|
archiveTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ArchiveThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
48
48
|
/**
|
|
@@ -51,8 +51,8 @@ declare class Theme {
|
|
|
51
51
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
52
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
53
53
|
* @name createPage
|
|
54
|
-
* @summary: Create
|
|
55
|
-
* @description:
|
|
54
|
+
* @summary: Create page.
|
|
55
|
+
* @description: Generate and add a new page to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/createPage/).
|
|
56
56
|
*/
|
|
57
57
|
createPage({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
58
58
|
/**
|
|
@@ -61,8 +61,8 @@ declare class Theme {
|
|
|
61
61
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
62
62
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
63
63
|
* @name deletePage
|
|
64
|
-
* @summary:
|
|
65
|
-
* @description:
|
|
64
|
+
* @summary: Delete page.
|
|
65
|
+
* @description: Remove a page from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deletePage/).
|
|
66
66
|
*/
|
|
67
67
|
deletePage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
68
68
|
/**
|
|
@@ -71,8 +71,8 @@ declare class Theme {
|
|
|
71
71
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
72
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
73
73
|
* @name deleteTheme
|
|
74
|
-
* @summary: Delete
|
|
75
|
-
* @description:
|
|
74
|
+
* @summary: Delete theme.
|
|
75
|
+
* @description: Remove a theme from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteTheme/).
|
|
76
76
|
*/
|
|
77
77
|
deleteTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DeleteThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
78
78
|
/**
|
|
@@ -81,8 +81,8 @@ declare class Theme {
|
|
|
81
81
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
82
82
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
83
83
|
* @name duplicateTheme
|
|
84
|
-
* @summary: Duplicate
|
|
85
|
-
* @description:
|
|
84
|
+
* @summary: Duplicate theme.
|
|
85
|
+
* @description: Create a copy of an existing theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/duplicateTheme/).
|
|
86
86
|
*/
|
|
87
87
|
duplicateTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DuplicateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
88
88
|
/**
|
|
@@ -91,8 +91,8 @@ declare class Theme {
|
|
|
91
91
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
92
92
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
93
93
|
* @name getAllPages
|
|
94
|
-
* @summary: Get all pages
|
|
95
|
-
* @description:
|
|
94
|
+
* @summary: Get all pages.
|
|
95
|
+
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAllPages/).
|
|
96
96
|
*/
|
|
97
97
|
getAllPages({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
98
98
|
/**
|
|
@@ -103,8 +103,8 @@ declare class Theme {
|
|
|
103
103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
104
|
* @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
|
|
105
105
|
* @name getApplicationThemes
|
|
106
|
-
* @summary: Get
|
|
107
|
-
* @description:
|
|
106
|
+
* @summary: Get application themes.
|
|
107
|
+
* @description: Retrieve themes available for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemes/).
|
|
108
108
|
*/
|
|
109
109
|
getApplicationThemes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema[]>;
|
|
110
110
|
/**
|
|
@@ -115,8 +115,8 @@ declare class Theme {
|
|
|
115
115
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
116
116
|
* @returns {Promise<Object>} - Success response
|
|
117
117
|
* @name getApplicationThemesCount
|
|
118
|
-
* @summary: Get
|
|
119
|
-
* @description:
|
|
118
|
+
* @summary: Get application themes count.
|
|
119
|
+
* @description: Count the number of themes available for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemesCount/).
|
|
120
120
|
*/
|
|
121
121
|
getApplicationThemesCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
122
122
|
/**
|
|
@@ -125,8 +125,8 @@ declare class Theme {
|
|
|
125
125
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
126
126
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
127
127
|
* @name getAppliedTheme
|
|
128
|
-
* @summary: Get
|
|
129
|
-
* @description:
|
|
128
|
+
* @summary: Get applied theme.
|
|
129
|
+
* @description: Retrieve the currently applied theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAppliedTheme/).
|
|
130
130
|
*/
|
|
131
131
|
getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
132
132
|
/**
|
|
@@ -135,8 +135,8 @@ declare class Theme {
|
|
|
135
135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
136
136
|
* @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
|
|
137
137
|
* @name getFonts
|
|
138
|
-
* @summary: Get
|
|
139
|
-
* @description:
|
|
138
|
+
* @summary: Get fonts.
|
|
139
|
+
* @description: Retrieve a list of available fonts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
|
|
140
140
|
*/
|
|
141
141
|
getFonts({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
|
|
142
142
|
/**
|
|
@@ -145,8 +145,8 @@ declare class Theme {
|
|
|
145
145
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
146
146
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
147
147
|
* @name getPage
|
|
148
|
-
* @summary: Get page
|
|
149
|
-
* @description:
|
|
148
|
+
* @summary: Get page.
|
|
149
|
+
* @description: Retrieve detailed information about a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPage/).
|
|
150
150
|
*/
|
|
151
151
|
getPage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
152
152
|
/**
|
|
@@ -155,8 +155,8 @@ declare class Theme {
|
|
|
155
155
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
156
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
157
157
|
* @name getPublicThemes
|
|
158
|
-
* @summary: Get
|
|
159
|
-
* @description:
|
|
158
|
+
* @summary: Get public themes.
|
|
159
|
+
* @description: Retrieve themes that are publicly accessible. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPublicThemes/).
|
|
160
160
|
*/
|
|
161
161
|
getPublicThemes({ pageSize, pageNo, requestHeaders }?: ThemePlatformApplicationValidator.GetPublicThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
162
162
|
/**
|
|
@@ -165,8 +165,8 @@ declare class Theme {
|
|
|
165
165
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
166
166
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
167
167
|
* @name getThemeById
|
|
168
|
-
* @summary: Get
|
|
169
|
-
* @description:
|
|
168
|
+
* @summary: Get theme by ID.
|
|
169
|
+
* @description: Retrieve a theme by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeById/).
|
|
170
170
|
*/
|
|
171
171
|
getThemeById({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeByIdParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
172
172
|
/**
|
|
@@ -175,8 +175,8 @@ declare class Theme {
|
|
|
175
175
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
176
176
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
177
177
|
* @name getThemeForPreview
|
|
178
|
-
* @summary: Get
|
|
179
|
-
* @description:
|
|
178
|
+
* @summary: Get theme for preview.
|
|
179
|
+
* @description: Retrieve a theme for previewing before application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeForPreview/).
|
|
180
180
|
*/
|
|
181
181
|
getThemeForPreview({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
182
182
|
/**
|
|
@@ -187,8 +187,8 @@ declare class Theme {
|
|
|
187
187
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
188
188
|
* @returns {Promise<any>} - Success response
|
|
189
189
|
* @name getThemeLastModified
|
|
190
|
-
* @summary:
|
|
191
|
-
* @description:
|
|
190
|
+
* @summary: Get theme last modified.
|
|
191
|
+
* @description: Retrieve the last modification of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLastModified/).
|
|
192
192
|
*/
|
|
193
193
|
getThemeLastModified({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLastModifiedParam, { responseHeaders }?: object): Promise<any>;
|
|
194
194
|
/**
|
|
@@ -197,8 +197,8 @@ declare class Theme {
|
|
|
197
197
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
198
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
199
199
|
* @name getThemeLibrary
|
|
200
|
-
* @summary: Get
|
|
201
|
-
* @description:
|
|
200
|
+
* @summary: Get theme library.
|
|
201
|
+
* @description: Retrieve themes available in the platform's library. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLibrary/).
|
|
202
202
|
*/
|
|
203
203
|
getThemeLibrary({ pageSize, pageNo, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLibraryParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
204
204
|
/**
|
|
@@ -207,8 +207,8 @@ declare class Theme {
|
|
|
207
207
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
208
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradableResponse>} - Success response
|
|
209
209
|
* @name isUpgradable
|
|
210
|
-
* @summary:
|
|
211
|
-
* @description:
|
|
210
|
+
* @summary: Is upgradable.
|
|
211
|
+
* @description: Determine if a theme is eligible for an upgrade. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
212
212
|
*/
|
|
213
213
|
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradableResponse>;
|
|
214
214
|
/**
|
|
@@ -217,8 +217,8 @@ declare class Theme {
|
|
|
217
217
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
218
218
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
219
219
|
* @name publishTheme
|
|
220
|
-
* @summary: Publish
|
|
221
|
-
* @description:
|
|
220
|
+
* @summary: Publish theme.
|
|
221
|
+
* @description: Make a theme accessible for use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/publishTheme/).
|
|
222
222
|
*/
|
|
223
223
|
publishTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.PublishThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
224
224
|
/**
|
|
@@ -227,8 +227,8 @@ declare class Theme {
|
|
|
227
227
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
228
228
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
229
229
|
* @name unarchiveTheme
|
|
230
|
-
* @summary: Unarchive
|
|
231
|
-
* @description:
|
|
230
|
+
* @summary: Unarchive theme.
|
|
231
|
+
* @description: Retrieve a theme from the archive. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/unarchiveTheme/).
|
|
232
232
|
*/
|
|
233
233
|
unarchiveTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UnarchiveThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
234
234
|
/**
|
|
@@ -237,8 +237,8 @@ declare class Theme {
|
|
|
237
237
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
238
238
|
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
239
239
|
* @name unpublishTheme
|
|
240
|
-
* @summary: Unpublish
|
|
241
|
-
* @description:
|
|
240
|
+
* @summary: Unpublish theme.
|
|
241
|
+
* @description: Remove a published theme from public access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/unpublishTheme/).
|
|
242
242
|
*/
|
|
243
243
|
unpublishTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UnpublishThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
244
244
|
/**
|
|
@@ -249,8 +249,8 @@ declare class Theme {
|
|
|
249
249
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
250
250
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
251
251
|
* @name updateMultiplePages
|
|
252
|
-
* @summary: Update multiple pages
|
|
253
|
-
* @description:
|
|
252
|
+
* @summary: Update multiple pages.
|
|
253
|
+
* @description: Modify multiple pages simultaneously. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateMultiplePages/).
|
|
254
254
|
*/
|
|
255
255
|
updateMultiplePages({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateMultiplePagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
256
256
|
/**
|
|
@@ -259,8 +259,8 @@ declare class Theme {
|
|
|
259
259
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
260
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
261
261
|
* @name updatePage
|
|
262
|
-
* @summary:
|
|
263
|
-
* @description:
|
|
262
|
+
* @summary: Update page.
|
|
263
|
+
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
264
264
|
*/
|
|
265
265
|
updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
266
266
|
/**
|
|
@@ -269,8 +269,8 @@ declare class Theme {
|
|
|
269
269
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
270
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
271
271
|
* @name updateTheme
|
|
272
|
-
* @summary: Update theme
|
|
273
|
-
* @description:
|
|
272
|
+
* @summary: Update theme.
|
|
273
|
+
* @description: Modify and update the content and settings of a theme - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateTheme/).
|
|
274
274
|
*/
|
|
275
275
|
updateTheme({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
276
276
|
/**
|
|
@@ -279,8 +279,8 @@ declare class Theme {
|
|
|
279
279
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
280
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
281
281
|
* @name updateThemeName
|
|
282
|
-
* @summary: Update
|
|
283
|
-
* @description:
|
|
282
|
+
* @summary: Update theme name.
|
|
283
|
+
* @description: Modify the name of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateThemeName/).
|
|
284
284
|
*/
|
|
285
285
|
updateThemeName({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeNameParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
286
286
|
/**
|
|
@@ -289,8 +289,8 @@ declare class Theme {
|
|
|
289
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
290
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
291
291
|
* @name upgradeTheme
|
|
292
|
-
* @summary: Upgrade
|
|
293
|
-
* @description:
|
|
292
|
+
* @summary: Upgrade theme.
|
|
293
|
+
* @description: Enhance and update a theme to a new version. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/upgradeTheme/).
|
|
294
294
|
*/
|
|
295
295
|
upgradeTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UpgradeThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
296
296
|
}
|