@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +5 -3
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
- package/sdk/application/Cart/CartApplicationClient.js +56 -56
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
- package/sdk/application/Lead/LeadApplicationClient.js +10 -10
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
- package/sdk/application/Order/OrderApplicationClient.js +17 -97
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
- package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
- package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
- package/sdk/platform/Content/ContentPlatformClient.js +37 -37
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
- package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
- package/sdk/platform/Order/OrderPlatformClient.js +109 -204
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
- package/sdk/platform/Order/OrderPlatformModel.js +12 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
- package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
- package/sdk/platform/Share/SharePlatformModel.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
- package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -1081,7 +1081,6 @@ const Joi = require("joi");
|
|
|
1081
1081
|
* @property {number[]} ignore_locations
|
|
1082
1082
|
* @property {number[]} assign_locations
|
|
1083
1083
|
* @property {number} [seller_id]
|
|
1084
|
-
* @property {number} [store_id]
|
|
1085
1084
|
*/
|
|
1086
1085
|
|
|
1087
1086
|
/**
|
|
@@ -1120,6 +1119,7 @@ const Joi = require("joi");
|
|
|
1120
1119
|
/**
|
|
1121
1120
|
* @typedef OptimalLocationsResponse
|
|
1122
1121
|
* @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
|
|
1122
|
+
* @property {ErrorResponse[]} [faulty_articles]
|
|
1123
1123
|
*/
|
|
1124
1124
|
|
|
1125
1125
|
class ServiceabilityPlatformModel {
|
|
@@ -2532,7 +2532,6 @@ class ServiceabilityPlatformModel {
|
|
|
2532
2532
|
ignore_locations: Joi.array().items(Joi.number()).required(),
|
|
2533
2533
|
assign_locations: Joi.array().items(Joi.number()).required(),
|
|
2534
2534
|
seller_id: Joi.number(),
|
|
2535
|
-
store_id: Joi.number(),
|
|
2536
2535
|
});
|
|
2537
2536
|
}
|
|
2538
2537
|
|
|
@@ -2585,6 +2584,9 @@ class ServiceabilityPlatformModel {
|
|
|
2585
2584
|
ServiceabilityPlatformModel.OptimalLocationAssignedStoresResponse()
|
|
2586
2585
|
)
|
|
2587
2586
|
.required(),
|
|
2587
|
+
faulty_articles: Joi.array().items(
|
|
2588
|
+
ServiceabilityPlatformModel.ErrorResponse()
|
|
2589
|
+
),
|
|
2588
2590
|
});
|
|
2589
2591
|
}
|
|
2590
2592
|
}
|
|
@@ -529,4 +529,4 @@ type UpdateZoneByIdParam = {
|
|
|
529
529
|
};
|
|
530
530
|
type GetAllStoresParam = any;
|
|
531
531
|
type GetCompanyConfigurationParam = any;
|
|
532
|
-
import ServiceabilityPlatformModel = require("
|
|
532
|
+
import ServiceabilityPlatformModel = require("sdk/output/javascript/code/sdk/platform/Serviceability/ServiceabilityPlatformModel");
|
|
@@ -9,7 +9,7 @@ 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
|
|
12
|
+
* @summary: Create short link
|
|
13
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>;
|
|
@@ -19,7 +19,7 @@ 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
|
|
22
|
+
* @summary: Get short link by hash
|
|
23
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>;
|
|
@@ -31,7 +31,7 @@ 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 short link click statistics
|
|
34
|
+
* @summary: Get short link click statistics
|
|
35
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>;
|
|
@@ -41,7 +41,7 @@ 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
|
|
44
|
+
* @summary: Get short links
|
|
45
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>;
|
|
@@ -53,10 +53,10 @@ 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
|
|
56
|
+
* @summary: Update short link
|
|
57
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
|
}
|
|
61
|
-
import SharePlatformApplicationValidator = require("
|
|
62
|
-
import SharePlatformModel = require("
|
|
61
|
+
import SharePlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Share/SharePlatformApplicationValidator");
|
|
62
|
+
import SharePlatformModel = require("sdk/output/javascript/code/sdk/platform/Share/SharePlatformModel");
|
|
@@ -21,7 +21,7 @@ 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
|
|
24
|
+
* @summary: Create short link
|
|
25
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(
|
|
@@ -100,7 +100,7 @@ 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
|
|
103
|
+
* @summary: Get short link by hash
|
|
104
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(
|
|
@@ -181,7 +181,7 @@ class Share {
|
|
|
181
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
182
|
* @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
|
|
183
183
|
* @name getShortLinkClickStats
|
|
184
|
-
* @summary: Get short link click statistics
|
|
184
|
+
* @summary: Get short link click statistics
|
|
185
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(
|
|
@@ -257,7 +257,7 @@ 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
|
|
260
|
+
* @summary: Get short links
|
|
261
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(
|
|
@@ -366,7 +366,7 @@ 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
|
|
369
|
+
* @summary: Update short link
|
|
370
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(
|
|
@@ -58,7 +58,9 @@ export = SharePlatformModel;
|
|
|
58
58
|
*/
|
|
59
59
|
/**
|
|
60
60
|
* @typedef UrlInfo
|
|
61
|
+
* @property {string} [original]
|
|
61
62
|
* @property {string} [hash]
|
|
63
|
+
* @property {string} [short_url]
|
|
62
64
|
*/
|
|
63
65
|
/**
|
|
64
66
|
* @typedef ShortLinkRes
|
|
@@ -194,7 +196,9 @@ type ShortLinkReq = {
|
|
|
194
196
|
/** @returns {UrlInfo} */
|
|
195
197
|
declare function UrlInfo(): UrlInfo;
|
|
196
198
|
type UrlInfo = {
|
|
199
|
+
original?: string;
|
|
197
200
|
hash?: string;
|
|
201
|
+
short_url?: string;
|
|
198
202
|
};
|
|
199
203
|
/** @returns {ShortLinkRes} */
|
|
200
204
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
@@ -68,7 +68,9 @@ const Joi = require("joi");
|
|
|
68
68
|
|
|
69
69
|
/**
|
|
70
70
|
* @typedef UrlInfo
|
|
71
|
+
* @property {string} [original]
|
|
71
72
|
* @property {string} [hash]
|
|
73
|
+
* @property {string} [short_url]
|
|
72
74
|
*/
|
|
73
75
|
|
|
74
76
|
/**
|
|
@@ -206,7 +208,9 @@ class SharePlatformModel {
|
|
|
206
208
|
/** @returns {UrlInfo} */
|
|
207
209
|
static UrlInfo() {
|
|
208
210
|
return Joi.object({
|
|
211
|
+
original: Joi.string().allow(""),
|
|
209
212
|
hash: Joi.string().allow(""),
|
|
213
|
+
short_url: Joi.string().allow(""),
|
|
210
214
|
});
|
|
211
215
|
}
|
|
212
216
|
|
|
@@ -11,48 +11,28 @@ declare class Theme {
|
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
12
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
13
13
|
* @name addThemeToApplication
|
|
14
|
-
* @summary:
|
|
15
|
-
* @description: Include a theme in an application
|
|
14
|
+
* @summary: Create theme in sales channel
|
|
15
|
+
* @description: Include a theme in an application drafts from theme collection. - 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
|
-
/**
|
|
19
|
-
* @param {ThemePlatformApplicationValidator.AddToThemeLibraryParam} arg - Arg object
|
|
20
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
21
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
-
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
23
|
-
* @name addToThemeLibrary
|
|
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
|
-
*/
|
|
27
|
-
addToThemeLibrary({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddToThemeLibraryParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
28
18
|
/**
|
|
29
19
|
* @param {ThemePlatformApplicationValidator.ApplyThemeParam} arg - Arg object
|
|
30
20
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
22
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
33
23
|
* @name applyTheme
|
|
34
|
-
* @summary: Apply theme
|
|
35
|
-
* @description:
|
|
24
|
+
* @summary: Apply a theme
|
|
25
|
+
* @description: Change current applied theme with new draft theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/applyTheme/).
|
|
36
26
|
*/
|
|
37
27
|
applyTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ApplyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
38
|
-
/**
|
|
39
|
-
* @param {ThemePlatformApplicationValidator.ArchiveThemeParam} arg - Arg object
|
|
40
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
41
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
|
-
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
43
|
-
* @name archiveTheme
|
|
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
|
-
*/
|
|
47
|
-
archiveTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ArchiveThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
48
28
|
/**
|
|
49
29
|
* @param {ThemePlatformApplicationValidator.CreatePageParam} arg - Arg object
|
|
50
30
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
31
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
32
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
53
33
|
* @name createPage
|
|
54
|
-
* @summary: Create page
|
|
55
|
-
* @description: Generate and add a new page to the
|
|
34
|
+
* @summary: Create theme page
|
|
35
|
+
* @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/createPage/).
|
|
56
36
|
*/
|
|
57
37
|
createPage({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
58
38
|
/**
|
|
@@ -61,8 +41,8 @@ declare class Theme {
|
|
|
61
41
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
62
42
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
63
43
|
* @name deletePage
|
|
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/).
|
|
44
|
+
* @summary: Delete a page
|
|
45
|
+
* @description: Remove a page from a theme of the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deletePage/).
|
|
66
46
|
*/
|
|
67
47
|
deletePage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
68
48
|
/**
|
|
@@ -71,8 +51,8 @@ declare class Theme {
|
|
|
71
51
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
72
52
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
73
53
|
* @name deleteTheme
|
|
74
|
-
* @summary: Delete theme
|
|
75
|
-
* @description: Remove a theme from
|
|
54
|
+
* @summary: Delete theme
|
|
55
|
+
* @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteTheme/).
|
|
76
56
|
*/
|
|
77
57
|
deleteTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DeleteThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
78
58
|
/**
|
|
@@ -81,8 +61,8 @@ declare class Theme {
|
|
|
81
61
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
82
62
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
83
63
|
* @name duplicateTheme
|
|
84
|
-
* @summary: Duplicate theme
|
|
85
|
-
* @description: Create a copy of an existing theme
|
|
64
|
+
* @summary: Duplicate a theme
|
|
65
|
+
* @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/duplicateTheme/).
|
|
86
66
|
*/
|
|
87
67
|
duplicateTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DuplicateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
88
68
|
/**
|
|
@@ -91,7 +71,7 @@ declare class Theme {
|
|
|
91
71
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
92
72
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
93
73
|
* @name getAllPages
|
|
94
|
-
* @summary:
|
|
74
|
+
* @summary: List pages of a theme
|
|
95
75
|
* @description: Retrieve a list of all available pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAllPages/).
|
|
96
76
|
*/
|
|
97
77
|
getAllPages({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
@@ -103,8 +83,8 @@ declare class Theme {
|
|
|
103
83
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
84
|
* @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
|
|
105
85
|
* @name getApplicationThemes
|
|
106
|
-
* @summary:
|
|
107
|
-
* @description: Retrieve themes
|
|
86
|
+
* @summary: List sales channel themes
|
|
87
|
+
* @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemes/).
|
|
108
88
|
*/
|
|
109
89
|
getApplicationThemes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema[]>;
|
|
110
90
|
/**
|
|
@@ -115,8 +95,8 @@ declare class Theme {
|
|
|
115
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
116
96
|
* @returns {Promise<Object>} - Success response
|
|
117
97
|
* @name getApplicationThemesCount
|
|
118
|
-
* @summary: Get
|
|
119
|
-
* @description:
|
|
98
|
+
* @summary: Get sales channel themes count
|
|
99
|
+
* @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemesCount/).
|
|
120
100
|
*/
|
|
121
101
|
getApplicationThemesCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
122
102
|
/**
|
|
@@ -125,8 +105,8 @@ declare class Theme {
|
|
|
125
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
126
106
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
127
107
|
* @name getAppliedTheme
|
|
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/).
|
|
108
|
+
* @summary: Get applied theme
|
|
109
|
+
* @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAppliedTheme/).
|
|
130
110
|
*/
|
|
131
111
|
getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
132
112
|
/**
|
|
@@ -135,8 +115,8 @@ declare class Theme {
|
|
|
135
115
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
136
116
|
* @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
|
|
137
117
|
* @name getFonts
|
|
138
|
-
* @summary:
|
|
139
|
-
* @description: Retrieve a list of available fonts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
|
|
118
|
+
* @summary: List theme fonts
|
|
119
|
+
* @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
|
|
140
120
|
*/
|
|
141
121
|
getFonts({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
|
|
142
122
|
/**
|
|
@@ -145,28 +125,18 @@ declare class Theme {
|
|
|
145
125
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
146
126
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
147
127
|
* @name getPage
|
|
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/).
|
|
128
|
+
* @summary: Get a page
|
|
129
|
+
* @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPage/).
|
|
150
130
|
*/
|
|
151
131
|
getPage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
152
|
-
/**
|
|
153
|
-
* @param {ThemePlatformApplicationValidator.GetPublicThemesParam} arg - Arg object
|
|
154
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
-
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
157
|
-
* @name getPublicThemes
|
|
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
|
-
*/
|
|
161
|
-
getPublicThemes({ pageSize, pageNo, requestHeaders }?: ThemePlatformApplicationValidator.GetPublicThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
162
132
|
/**
|
|
163
133
|
* @param {ThemePlatformApplicationValidator.GetThemeByIdParam} arg - Arg object
|
|
164
134
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
165
135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
166
136
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
167
137
|
* @name getThemeById
|
|
168
|
-
* @summary: Get theme
|
|
169
|
-
* @description: Retrieve a theme by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeById/).
|
|
138
|
+
* @summary: Get theme
|
|
139
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeById/).
|
|
170
140
|
*/
|
|
171
141
|
getThemeById({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeByIdParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
172
142
|
/**
|
|
@@ -175,8 +145,8 @@ declare class Theme {
|
|
|
175
145
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
176
146
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
177
147
|
* @name getThemeForPreview
|
|
178
|
-
* @summary: Get theme for preview
|
|
179
|
-
* @description: Retrieve a theme
|
|
148
|
+
* @summary: Get theme for preview
|
|
149
|
+
* @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeForPreview/).
|
|
180
150
|
*/
|
|
181
151
|
getThemeForPreview({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
182
152
|
/**
|
|
@@ -187,60 +157,20 @@ declare class Theme {
|
|
|
187
157
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
188
158
|
* @returns {Promise<any>} - Success response
|
|
189
159
|
* @name getThemeLastModified
|
|
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/).
|
|
160
|
+
* @summary: Get theme last modified date
|
|
161
|
+
* @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLastModified/).
|
|
192
162
|
*/
|
|
193
163
|
getThemeLastModified({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLastModifiedParam, { responseHeaders }?: object): Promise<any>;
|
|
194
|
-
/**
|
|
195
|
-
* @param {ThemePlatformApplicationValidator.GetThemeLibraryParam} arg - Arg object
|
|
196
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
197
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
|
-
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
199
|
-
* @name getThemeLibrary
|
|
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
|
-
*/
|
|
203
|
-
getThemeLibrary({ pageSize, pageNo, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLibraryParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
204
164
|
/**
|
|
205
165
|
* @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
|
|
206
166
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
167
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
168
|
* @returns {Promise<ThemePlatformModel.ThemeUpgradableResponse>} - Success response
|
|
209
169
|
* @name isUpgradable
|
|
210
|
-
* @summary:
|
|
211
|
-
* @description: Determine if a theme is eligible for an upgrade.
|
|
170
|
+
* @summary: Check theme is upgradable
|
|
171
|
+
* @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
|
|
212
172
|
*/
|
|
213
173
|
isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradableResponse>;
|
|
214
|
-
/**
|
|
215
|
-
* @param {ThemePlatformApplicationValidator.PublishThemeParam} arg - Arg object
|
|
216
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
217
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
218
|
-
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
219
|
-
* @name publishTheme
|
|
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
|
-
*/
|
|
223
|
-
publishTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.PublishThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
224
|
-
/**
|
|
225
|
-
* @param {ThemePlatformApplicationValidator.UnarchiveThemeParam} arg - Arg object
|
|
226
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
227
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
228
|
-
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
229
|
-
* @name unarchiveTheme
|
|
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
|
-
*/
|
|
233
|
-
unarchiveTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UnarchiveThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
234
|
-
/**
|
|
235
|
-
* @param {ThemePlatformApplicationValidator.UnpublishThemeParam} arg - Arg object
|
|
236
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
237
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
238
|
-
* @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
|
|
239
|
-
* @name unpublishTheme
|
|
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
|
-
*/
|
|
243
|
-
unpublishTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UnpublishThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
|
|
244
174
|
/**
|
|
245
175
|
* @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
|
|
246
176
|
* - Arg object
|
|
@@ -249,8 +179,8 @@ declare class Theme {
|
|
|
249
179
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
250
180
|
* @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
|
|
251
181
|
* @name updateMultiplePages
|
|
252
|
-
* @summary: Update
|
|
253
|
-
* @description: Modify multiple pages simultaneously. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateMultiplePages/).
|
|
182
|
+
* @summary: Update theme pages
|
|
183
|
+
* @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateMultiplePages/).
|
|
254
184
|
*/
|
|
255
185
|
updateMultiplePages({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateMultiplePagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
|
|
256
186
|
/**
|
|
@@ -259,7 +189,7 @@ declare class Theme {
|
|
|
259
189
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
190
|
* @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
|
|
261
191
|
* @name updatePage
|
|
262
|
-
* @summary: Update page
|
|
192
|
+
* @summary: Update a page
|
|
263
193
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
|
|
264
194
|
*/
|
|
265
195
|
updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
|
|
@@ -269,8 +199,8 @@ declare class Theme {
|
|
|
269
199
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
200
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
271
201
|
* @name updateTheme
|
|
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/).
|
|
202
|
+
* @summary: Update theme
|
|
203
|
+
* @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
204
|
*/
|
|
275
205
|
updateTheme({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
276
206
|
/**
|
|
@@ -279,8 +209,8 @@ declare class Theme {
|
|
|
279
209
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
210
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
281
211
|
* @name updateThemeName
|
|
282
|
-
* @summary: Update theme name
|
|
283
|
-
* @description: Modify the name of
|
|
212
|
+
* @summary: Update theme name
|
|
213
|
+
* @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateThemeName/).
|
|
284
214
|
*/
|
|
285
215
|
updateThemeName({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeNameParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
286
216
|
/**
|
|
@@ -289,10 +219,10 @@ declare class Theme {
|
|
|
289
219
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
220
|
* @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
|
|
291
221
|
* @name upgradeTheme
|
|
292
|
-
* @summary: Upgrade theme
|
|
293
|
-
* @description:
|
|
222
|
+
* @summary: Upgrade theme
|
|
223
|
+
* @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/upgradeTheme/).
|
|
294
224
|
*/
|
|
295
225
|
upgradeTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UpgradeThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
|
|
296
226
|
}
|
|
297
|
-
import ThemePlatformApplicationValidator = require("
|
|
298
|
-
import ThemePlatformModel = require("
|
|
227
|
+
import ThemePlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Theme/ThemePlatformApplicationValidator");
|
|
228
|
+
import ThemePlatformModel = require("sdk/output/javascript/code/sdk/platform/Theme/ThemePlatformModel");
|