@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
|
@@ -36,8 +36,8 @@ declare class Content {
|
|
|
36
36
|
* - Success response
|
|
37
37
|
*
|
|
38
38
|
* @name getAnnouncements
|
|
39
|
-
* @summary:
|
|
40
|
-
* @description:
|
|
39
|
+
* @summary: List announcements
|
|
40
|
+
* @description: List all current announcements in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getAnnouncements/).
|
|
41
41
|
*/
|
|
42
42
|
getAnnouncements({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.AnnouncementsResponseSchema>;
|
|
43
43
|
/**
|
|
@@ -46,8 +46,8 @@ declare class Content {
|
|
|
46
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
47
|
* @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
|
|
48
48
|
* @name getBlog
|
|
49
|
-
* @summary:
|
|
50
|
-
* @description:
|
|
49
|
+
* @summary: Get a blog
|
|
50
|
+
* @description: Get all information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
|
|
51
51
|
*/
|
|
52
52
|
getBlog({ slug, rootId, requestHeaders }?: ContentApplicationValidator.GetBlogParam, { responseHeaders }?: object): Promise<ContentApplicationModel.BlogSchema>;
|
|
53
53
|
/**
|
|
@@ -56,8 +56,8 @@ declare class Content {
|
|
|
56
56
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
57
57
|
* @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
|
|
58
58
|
* @name getBlogs
|
|
59
|
-
* @summary:
|
|
60
|
-
* @description:
|
|
59
|
+
* @summary: List blogs
|
|
60
|
+
* @description: List all the blogs against an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
|
|
61
61
|
*/
|
|
62
62
|
getBlogs({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.BlogGetResponse>;
|
|
63
63
|
/**
|
|
@@ -68,8 +68,8 @@ declare class Content {
|
|
|
68
68
|
* - Success response
|
|
69
69
|
*
|
|
70
70
|
* @name getCustomFields
|
|
71
|
-
* @summary: Get list of custom fields
|
|
72
|
-
* @description:
|
|
71
|
+
* @summary: Get list of custom fields
|
|
72
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
|
|
73
73
|
*/
|
|
74
74
|
getCustomFields({ resource, resourceId, requestHeaders }?: ContentApplicationValidator.GetCustomFieldsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.CustomFieldsResponseByResourceIdSchema>;
|
|
75
75
|
/**
|
|
@@ -79,8 +79,8 @@ declare class Content {
|
|
|
79
79
|
* @returns {Promise<ContentApplicationModel.CustomObjectByIdSchema>} -
|
|
80
80
|
* Success response
|
|
81
81
|
* @name getCustomObject
|
|
82
|
-
* @summary: Get custom object
|
|
83
|
-
* @description:
|
|
82
|
+
* @summary: Get custom object
|
|
83
|
+
* @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
|
|
84
84
|
*/
|
|
85
85
|
getCustomObject({ metaobjectId, requestHeaders }?: ContentApplicationValidator.GetCustomObjectParam, { responseHeaders }?: object): Promise<ContentApplicationModel.CustomObjectByIdSchema>;
|
|
86
86
|
/**
|
|
@@ -89,8 +89,8 @@ declare class Content {
|
|
|
89
89
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
90
90
|
* @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
|
|
91
91
|
* @name getDataLoaders
|
|
92
|
-
* @summary:
|
|
93
|
-
* @description:
|
|
92
|
+
* @summary: List Dataloaders
|
|
93
|
+
* @description: List all the data loaders that are enabled for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
|
|
94
94
|
*/
|
|
95
95
|
getDataLoaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.DataLoadersSchema>;
|
|
96
96
|
/**
|
|
@@ -99,8 +99,8 @@ declare class Content {
|
|
|
99
99
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<ContentApplicationModel.FaqSchema>} - Success response
|
|
101
101
|
* @name getFaqBySlug
|
|
102
|
-
* @summary:
|
|
103
|
-
* @description:
|
|
102
|
+
* @summary: Get FAQ
|
|
103
|
+
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqBySlug/).
|
|
104
104
|
*/
|
|
105
105
|
getFaqBySlug({ slug, requestHeaders }?: ContentApplicationValidator.GetFaqBySlugParam, { responseHeaders }?: object): Promise<ContentApplicationModel.FaqSchema>;
|
|
106
106
|
/**
|
|
@@ -110,8 +110,8 @@ declare class Content {
|
|
|
110
110
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoriesSchema>} -
|
|
111
111
|
* Success response
|
|
112
112
|
* @name getFaqCategories
|
|
113
|
-
* @summary:
|
|
114
|
-
* @description:
|
|
113
|
+
* @summary: List FAQ Categories
|
|
114
|
+
* @description: Lists categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
|
|
115
115
|
*/
|
|
116
116
|
getFaqCategories({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqCategoriesSchema>;
|
|
117
117
|
/**
|
|
@@ -121,8 +121,8 @@ declare class Content {
|
|
|
121
121
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>} -
|
|
122
122
|
* Success response
|
|
123
123
|
* @name getFaqCategoryBySlug
|
|
124
|
-
* @summary:
|
|
125
|
-
* @description:
|
|
124
|
+
* @summary: Get a FAQ category
|
|
125
|
+
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategoryBySlug/).
|
|
126
126
|
*/
|
|
127
127
|
getFaqCategoryBySlug({ slug, requestHeaders }?: ContentApplicationValidator.GetFaqCategoryBySlugParam, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>;
|
|
128
128
|
/**
|
|
@@ -131,8 +131,8 @@ declare class Content {
|
|
|
131
131
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
132
132
|
* @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
|
|
133
133
|
* @name getFaqs
|
|
134
|
-
* @summary:
|
|
135
|
-
* @description:
|
|
134
|
+
* @summary: List FAQs
|
|
135
|
+
* @description: List a list of frequently asked questions and ansers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
|
|
136
136
|
*/
|
|
137
137
|
getFaqs({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.FaqResponseSchema>;
|
|
138
138
|
/**
|
|
@@ -141,8 +141,8 @@ declare class Content {
|
|
|
141
141
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
142
142
|
* @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
|
|
143
143
|
* @name getFaqsByCategorySlug
|
|
144
|
-
* @summary:
|
|
145
|
-
* @description:
|
|
144
|
+
* @summary: List FAQs by category
|
|
145
|
+
* @description: Get FAQs belonging to a specific category slug - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
|
|
146
146
|
*/
|
|
147
147
|
getFaqsByCategorySlug({ slug, requestHeaders }?: ContentApplicationValidator.GetFaqsByCategorySlugParam, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqSchema>;
|
|
148
148
|
/**
|
|
@@ -151,7 +151,7 @@ declare class Content {
|
|
|
151
151
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
152
152
|
* @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
|
|
153
153
|
* @name getLandingPage
|
|
154
|
-
* @summary:
|
|
154
|
+
* @summary: Get a landing page
|
|
155
155
|
* @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
|
|
156
156
|
*/
|
|
157
157
|
getLandingPage({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.LandingPageSchema>;
|
|
@@ -161,8 +161,8 @@ declare class Content {
|
|
|
161
161
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
162
162
|
* @returns {Promise<ContentApplicationModel.ApplicationLegal>} - Success response
|
|
163
163
|
* @name getLegalInformation
|
|
164
|
-
* @summary:
|
|
165
|
-
* @description:
|
|
164
|
+
* @summary: Get legal information
|
|
165
|
+
* @description: Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLegalInformation/).
|
|
166
166
|
*/
|
|
167
167
|
getLegalInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.ApplicationLegal>;
|
|
168
168
|
/**
|
|
@@ -172,8 +172,8 @@ declare class Content {
|
|
|
172
172
|
* @returns {Promise<ContentApplicationModel.NavigationGetResponse>} -
|
|
173
173
|
* Success response
|
|
174
174
|
* @name getNavigations
|
|
175
|
-
* @summary:
|
|
176
|
-
* @description:
|
|
175
|
+
* @summary: List navigation items
|
|
176
|
+
* @description: Get the navigation link items which can be powered to genreate menus on application's website or equivalent mobile apps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
|
|
177
177
|
*/
|
|
178
178
|
getNavigations({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.NavigationGetResponse>;
|
|
179
179
|
/**
|
|
@@ -182,8 +182,8 @@ declare class Content {
|
|
|
182
182
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
183
183
|
* @returns {Promise<ContentApplicationModel.PageSchema>} - Success response
|
|
184
184
|
* @name getPage
|
|
185
|
-
* @summary:
|
|
186
|
-
* @description:
|
|
185
|
+
* @summary: Get a page
|
|
186
|
+
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
|
|
187
187
|
*/
|
|
188
188
|
getPage({ slug, rootId, requestHeaders }?: ContentApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ContentApplicationModel.PageSchema>;
|
|
189
189
|
/**
|
|
@@ -192,8 +192,8 @@ declare class Content {
|
|
|
192
192
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
193
193
|
* @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
|
|
194
194
|
* @name getPages
|
|
195
|
-
* @summary: Lists
|
|
196
|
-
* @description:
|
|
195
|
+
* @summary: Lists pages
|
|
196
|
+
* @description: Lists all Custom Pages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
197
197
|
*/
|
|
198
198
|
getPages({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentApplicationModel.PageGetResponse>;
|
|
199
199
|
/**
|
|
@@ -202,8 +202,8 @@ declare class Content {
|
|
|
202
202
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
|
|
204
204
|
* @name getSEOConfiguration
|
|
205
|
-
* @summary:
|
|
206
|
-
* @description:
|
|
205
|
+
* @summary: Get SEO settings
|
|
206
|
+
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
|
|
207
207
|
*/
|
|
208
208
|
getSEOConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.SeoComponent>;
|
|
209
209
|
/**
|
|
@@ -212,8 +212,8 @@ declare class Content {
|
|
|
212
212
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
213
213
|
* @returns {Promise<ContentApplicationModel.SeoSchemaComponent>} - Success response
|
|
214
214
|
* @name getSEOMarkupSchemas
|
|
215
|
-
* @summary:
|
|
216
|
-
* @description:
|
|
215
|
+
* @summary: List SEO Markup schemas
|
|
216
|
+
* @description: Get all SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
|
|
217
217
|
*/
|
|
218
218
|
getSEOMarkupSchemas({ pageType, active, requestHeaders }?: ContentApplicationValidator.GetSEOMarkupSchemasParam, { responseHeaders }?: object): Promise<ContentApplicationModel.SeoSchemaComponent>;
|
|
219
219
|
/**
|
|
@@ -222,8 +222,8 @@ declare class Content {
|
|
|
222
222
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
223
223
|
* @returns {Promise<ContentApplicationModel.SlideshowSchema>} - Success response
|
|
224
224
|
* @name getSlideshow
|
|
225
|
-
* @summary: Get a
|
|
226
|
-
* @description:
|
|
225
|
+
* @summary: Get a Slideshow
|
|
226
|
+
* @description: Get a slideshow using its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshow/).
|
|
227
227
|
*/
|
|
228
228
|
getSlideshow({ slug, requestHeaders }?: ContentApplicationValidator.GetSlideshowParam, { responseHeaders }?: object): Promise<ContentApplicationModel.SlideshowSchema>;
|
|
229
229
|
/**
|
|
@@ -232,16 +232,16 @@ declare class Content {
|
|
|
232
232
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
233
233
|
* @returns {Promise<ContentApplicationModel.SlideshowGetResponse>} - Success response
|
|
234
234
|
* @name getSlideshows
|
|
235
|
-
* @summary:
|
|
236
|
-
* @description:
|
|
235
|
+
* @summary: List Slideshows
|
|
236
|
+
* @description: Get a list of slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
|
|
237
237
|
*/
|
|
238
238
|
getSlideshows({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetSlideshowsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.SlideshowGetResponse>;
|
|
239
239
|
/**
|
|
240
240
|
* @param {Object} arg - Arg object.
|
|
241
241
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
242
242
|
* @returns {Paginator<ContentApplicationModel.SlideshowGetResponse>}
|
|
243
|
-
* @summary:
|
|
244
|
-
* @description:
|
|
243
|
+
* @summary: List Slideshows
|
|
244
|
+
* @description: Get a list of slideshows along with their details.
|
|
245
245
|
*/
|
|
246
246
|
getSlideshowsPaginator({ pageSize }?: {
|
|
247
247
|
pageSize?: number;
|
|
@@ -252,8 +252,8 @@ declare class Content {
|
|
|
252
252
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
253
253
|
* @returns {Promise<ContentApplicationModel.Support>} - Success response
|
|
254
254
|
* @name getSupportInformation
|
|
255
|
-
* @summary:
|
|
256
|
-
* @description:
|
|
255
|
+
* @summary: Get customer support information
|
|
256
|
+
* @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
|
|
257
257
|
*/
|
|
258
258
|
getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.Support>;
|
|
259
259
|
/**
|
|
@@ -262,11 +262,11 @@ declare class Content {
|
|
|
262
262
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
263
263
|
* @returns {Promise<ContentApplicationModel.TagsSchema>} - Success response
|
|
264
264
|
* @name getTags
|
|
265
|
-
* @summary:
|
|
266
|
-
* @description:
|
|
265
|
+
* @summary: Get HTML tags
|
|
266
|
+
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getTags/).
|
|
267
267
|
*/
|
|
268
268
|
getTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.TagsSchema>;
|
|
269
269
|
}
|
|
270
|
-
import ContentApplicationModel = require("
|
|
271
|
-
import ContentApplicationValidator = require("
|
|
272
|
-
import Paginator = require("
|
|
270
|
+
import ContentApplicationModel = require("sdk/output/javascript/code/sdk/application/Content/ContentApplicationModel");
|
|
271
|
+
import ContentApplicationValidator = require("sdk/output/javascript/code/sdk/application/Content/ContentApplicationValidator");
|
|
272
|
+
import Paginator = require("sdk/output/javascript/code/sdk/common/Paginator");
|
|
@@ -65,8 +65,8 @@ class Content {
|
|
|
65
65
|
* - Success response
|
|
66
66
|
*
|
|
67
67
|
* @name getAnnouncements
|
|
68
|
-
* @summary:
|
|
69
|
-
* @description:
|
|
68
|
+
* @summary: List announcements
|
|
69
|
+
* @description: List all current announcements in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getAnnouncements/).
|
|
70
70
|
*/
|
|
71
71
|
async getAnnouncements(
|
|
72
72
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -143,8 +143,8 @@ class Content {
|
|
|
143
143
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
144
144
|
* @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
|
|
145
145
|
* @name getBlog
|
|
146
|
-
* @summary:
|
|
147
|
-
* @description:
|
|
146
|
+
* @summary: Get a blog
|
|
147
|
+
* @description: Get all information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
|
|
148
148
|
*/
|
|
149
149
|
async getBlog(
|
|
150
150
|
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -220,8 +220,8 @@ class Content {
|
|
|
220
220
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
221
221
|
* @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
|
|
222
222
|
* @name getBlogs
|
|
223
|
-
* @summary:
|
|
224
|
-
* @description:
|
|
223
|
+
* @summary: List blogs
|
|
224
|
+
* @description: List all the blogs against an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
|
|
225
225
|
*/
|
|
226
226
|
async getBlogs(
|
|
227
227
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -300,8 +300,8 @@ class Content {
|
|
|
300
300
|
* - Success response
|
|
301
301
|
*
|
|
302
302
|
* @name getCustomFields
|
|
303
|
-
* @summary: Get list of custom fields
|
|
304
|
-
* @description:
|
|
303
|
+
* @summary: Get list of custom fields
|
|
304
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
|
|
305
305
|
*/
|
|
306
306
|
async getCustomFields(
|
|
307
307
|
{ resource, resourceId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -379,8 +379,8 @@ class Content {
|
|
|
379
379
|
* @returns {Promise<ContentApplicationModel.CustomObjectByIdSchema>} -
|
|
380
380
|
* Success response
|
|
381
381
|
* @name getCustomObject
|
|
382
|
-
* @summary: Get custom object
|
|
383
|
-
* @description:
|
|
382
|
+
* @summary: Get custom object
|
|
383
|
+
* @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
|
|
384
384
|
*/
|
|
385
385
|
async getCustomObject(
|
|
386
386
|
{ metaobjectId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -457,8 +457,8 @@ class Content {
|
|
|
457
457
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
458
458
|
* @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
|
|
459
459
|
* @name getDataLoaders
|
|
460
|
-
* @summary:
|
|
461
|
-
* @description:
|
|
460
|
+
* @summary: List Dataloaders
|
|
461
|
+
* @description: List all the data loaders that are enabled for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
|
|
462
462
|
*/
|
|
463
463
|
async getDataLoaders(
|
|
464
464
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -535,8 +535,8 @@ class Content {
|
|
|
535
535
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
536
536
|
* @returns {Promise<ContentApplicationModel.FaqSchema>} - Success response
|
|
537
537
|
* @name getFaqBySlug
|
|
538
|
-
* @summary:
|
|
539
|
-
* @description:
|
|
538
|
+
* @summary: Get FAQ
|
|
539
|
+
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqBySlug/).
|
|
540
540
|
*/
|
|
541
541
|
async getFaqBySlug(
|
|
542
542
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -614,8 +614,8 @@ class Content {
|
|
|
614
614
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoriesSchema>} -
|
|
615
615
|
* Success response
|
|
616
616
|
* @name getFaqCategories
|
|
617
|
-
* @summary:
|
|
618
|
-
* @description:
|
|
617
|
+
* @summary: List FAQ Categories
|
|
618
|
+
* @description: Lists categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
|
|
619
619
|
*/
|
|
620
620
|
async getFaqCategories(
|
|
621
621
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -693,8 +693,8 @@ class Content {
|
|
|
693
693
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>} -
|
|
694
694
|
* Success response
|
|
695
695
|
* @name getFaqCategoryBySlug
|
|
696
|
-
* @summary:
|
|
697
|
-
* @description:
|
|
696
|
+
* @summary: Get a FAQ category
|
|
697
|
+
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategoryBySlug/).
|
|
698
698
|
*/
|
|
699
699
|
async getFaqCategoryBySlug(
|
|
700
700
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -773,8 +773,8 @@ class Content {
|
|
|
773
773
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
774
774
|
* @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
|
|
775
775
|
* @name getFaqs
|
|
776
|
-
* @summary:
|
|
777
|
-
* @description:
|
|
776
|
+
* @summary: List FAQs
|
|
777
|
+
* @description: List a list of frequently asked questions and ansers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
|
|
778
778
|
*/
|
|
779
779
|
async getFaqs(
|
|
780
780
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -849,8 +849,8 @@ class Content {
|
|
|
849
849
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
850
850
|
* @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
|
|
851
851
|
* @name getFaqsByCategorySlug
|
|
852
|
-
* @summary:
|
|
853
|
-
* @description:
|
|
852
|
+
* @summary: List FAQs by category
|
|
853
|
+
* @description: Get FAQs belonging to a specific category slug - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
|
|
854
854
|
*/
|
|
855
855
|
async getFaqsByCategorySlug(
|
|
856
856
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -929,7 +929,7 @@ class Content {
|
|
|
929
929
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
930
930
|
* @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
|
|
931
931
|
* @name getLandingPage
|
|
932
|
-
* @summary:
|
|
932
|
+
* @summary: Get a landing page
|
|
933
933
|
* @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
|
|
934
934
|
*/
|
|
935
935
|
async getLandingPage(
|
|
@@ -1007,8 +1007,8 @@ class Content {
|
|
|
1007
1007
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1008
1008
|
* @returns {Promise<ContentApplicationModel.ApplicationLegal>} - Success response
|
|
1009
1009
|
* @name getLegalInformation
|
|
1010
|
-
* @summary:
|
|
1011
|
-
* @description:
|
|
1010
|
+
* @summary: Get legal information
|
|
1011
|
+
* @description: Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLegalInformation/).
|
|
1012
1012
|
*/
|
|
1013
1013
|
async getLegalInformation(
|
|
1014
1014
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1088,8 +1088,8 @@ class Content {
|
|
|
1088
1088
|
* @returns {Promise<ContentApplicationModel.NavigationGetResponse>} -
|
|
1089
1089
|
* Success response
|
|
1090
1090
|
* @name getNavigations
|
|
1091
|
-
* @summary:
|
|
1092
|
-
* @description:
|
|
1091
|
+
* @summary: List navigation items
|
|
1092
|
+
* @description: Get the navigation link items which can be powered to genreate menus on application's website or equivalent mobile apps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
|
|
1093
1093
|
*/
|
|
1094
1094
|
async getNavigations(
|
|
1095
1095
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1168,8 +1168,8 @@ class Content {
|
|
|
1168
1168
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1169
1169
|
* @returns {Promise<ContentApplicationModel.PageSchema>} - Success response
|
|
1170
1170
|
* @name getPage
|
|
1171
|
-
* @summary:
|
|
1172
|
-
* @description:
|
|
1171
|
+
* @summary: Get a page
|
|
1172
|
+
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
|
|
1173
1173
|
*/
|
|
1174
1174
|
async getPage(
|
|
1175
1175
|
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1245,8 +1245,8 @@ class Content {
|
|
|
1245
1245
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1246
1246
|
* @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
|
|
1247
1247
|
* @name getPages
|
|
1248
|
-
* @summary: Lists
|
|
1249
|
-
* @description:
|
|
1248
|
+
* @summary: Lists pages
|
|
1249
|
+
* @description: Lists all Custom Pages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
1250
1250
|
*/
|
|
1251
1251
|
async getPages(
|
|
1252
1252
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1323,8 +1323,8 @@ class Content {
|
|
|
1323
1323
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1324
1324
|
* @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
|
|
1325
1325
|
* @name getSEOConfiguration
|
|
1326
|
-
* @summary:
|
|
1327
|
-
* @description:
|
|
1326
|
+
* @summary: Get SEO settings
|
|
1327
|
+
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
|
|
1328
1328
|
*/
|
|
1329
1329
|
async getSEOConfiguration(
|
|
1330
1330
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1403,8 +1403,8 @@ class Content {
|
|
|
1403
1403
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1404
1404
|
* @returns {Promise<ContentApplicationModel.SeoSchemaComponent>} - Success response
|
|
1405
1405
|
* @name getSEOMarkupSchemas
|
|
1406
|
-
* @summary:
|
|
1407
|
-
* @description:
|
|
1406
|
+
* @summary: List SEO Markup schemas
|
|
1407
|
+
* @description: Get all SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
|
|
1408
1408
|
*/
|
|
1409
1409
|
async getSEOMarkupSchemas(
|
|
1410
1410
|
{ pageType, active, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1485,8 +1485,8 @@ class Content {
|
|
|
1485
1485
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1486
1486
|
* @returns {Promise<ContentApplicationModel.SlideshowSchema>} - Success response
|
|
1487
1487
|
* @name getSlideshow
|
|
1488
|
-
* @summary: Get a
|
|
1489
|
-
* @description:
|
|
1488
|
+
* @summary: Get a Slideshow
|
|
1489
|
+
* @description: Get a slideshow using its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshow/).
|
|
1490
1490
|
*/
|
|
1491
1491
|
async getSlideshow(
|
|
1492
1492
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1563,8 +1563,8 @@ class Content {
|
|
|
1563
1563
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1564
1564
|
* @returns {Promise<ContentApplicationModel.SlideshowGetResponse>} - Success response
|
|
1565
1565
|
* @name getSlideshows
|
|
1566
|
-
* @summary:
|
|
1567
|
-
* @description:
|
|
1566
|
+
* @summary: List Slideshows
|
|
1567
|
+
* @description: Get a list of slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
|
|
1568
1568
|
*/
|
|
1569
1569
|
async getSlideshows(
|
|
1570
1570
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1641,8 +1641,8 @@ class Content {
|
|
|
1641
1641
|
* @param {Object} arg - Arg object.
|
|
1642
1642
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1643
1643
|
* @returns {Paginator<ContentApplicationModel.SlideshowGetResponse>}
|
|
1644
|
-
* @summary:
|
|
1645
|
-
* @description:
|
|
1644
|
+
* @summary: List Slideshows
|
|
1645
|
+
* @description: Get a list of slideshows along with their details.
|
|
1646
1646
|
*/
|
|
1647
1647
|
getSlideshowsPaginator({ pageSize } = {}) {
|
|
1648
1648
|
const paginator = new Paginator();
|
|
@@ -1670,8 +1670,8 @@ class Content {
|
|
|
1670
1670
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1671
1671
|
* @returns {Promise<ContentApplicationModel.Support>} - Success response
|
|
1672
1672
|
* @name getSupportInformation
|
|
1673
|
-
* @summary:
|
|
1674
|
-
* @description:
|
|
1673
|
+
* @summary: Get customer support information
|
|
1674
|
+
* @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
|
|
1675
1675
|
*/
|
|
1676
1676
|
async getSupportInformation(
|
|
1677
1677
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1750,8 +1750,8 @@ class Content {
|
|
|
1750
1750
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1751
1751
|
* @returns {Promise<ContentApplicationModel.TagsSchema>} - Success response
|
|
1752
1752
|
* @name getTags
|
|
1753
|
-
* @summary:
|
|
1754
|
-
* @description:
|
|
1753
|
+
* @summary: Get HTML tags
|
|
1754
|
+
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getTags/).
|
|
1755
1755
|
*/
|
|
1756
1756
|
async getTags(
|
|
1757
1757
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -175,16 +175,9 @@ export = ContentApplicationModel;
|
|
|
175
175
|
*/
|
|
176
176
|
/**
|
|
177
177
|
* @typedef Action
|
|
178
|
+
* @property {string} [type]
|
|
178
179
|
* @property {ActionPage} [page]
|
|
179
180
|
* @property {ActionPage} [popup]
|
|
180
|
-
* @property {string} [type]
|
|
181
|
-
*/
|
|
182
|
-
/**
|
|
183
|
-
* @typedef ActionPage
|
|
184
|
-
* @property {Object} [params]
|
|
185
|
-
* @property {Object} [query]
|
|
186
|
-
* @property {string} [url]
|
|
187
|
-
* @property {PageType} type
|
|
188
181
|
*/
|
|
189
182
|
/**
|
|
190
183
|
* @typedef NavigationReference
|
|
@@ -537,6 +530,13 @@ export = ContentApplicationModel;
|
|
|
537
530
|
* @typedef CustomFieldsResponseByResourceIdSchema
|
|
538
531
|
* @property {CustomFieldSchema[]} [items]
|
|
539
532
|
*/
|
|
533
|
+
/**
|
|
534
|
+
* @typedef ActionPage
|
|
535
|
+
* @property {Object} [params]
|
|
536
|
+
* @property {Object} [query]
|
|
537
|
+
* @property {string} [url]
|
|
538
|
+
* @property {PageType} type
|
|
539
|
+
*/
|
|
540
540
|
/**
|
|
541
541
|
* @typedef {| "about-us"
|
|
542
542
|
* | "addresses"
|
|
@@ -588,7 +588,7 @@ export = ContentApplicationModel;
|
|
|
588
588
|
declare class ContentApplicationModel {
|
|
589
589
|
}
|
|
590
590
|
declare namespace ContentApplicationModel {
|
|
591
|
-
export { ApplicationLegal, ApplicationLegalFAQ, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, AnnouncementSchema, ScheduleStartSchema, BlogGetResponse, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, LocaleLanguage, Language, Action,
|
|
591
|
+
export { ApplicationLegal, ApplicationLegalFAQ, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, AnnouncementSchema, ScheduleStartSchema, BlogGetResponse, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, LocaleLanguage, Language, Action, NavigationReference, ConfigurationSchema, SlideshowMedia, AnnouncementsResponseSchema, FaqResponseSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, FAQCategorySchema, FaqSchema, GetFaqSchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageSchema, NavigationGetResponse, Orientation, NavigationSchema, PageGetResponse, PageSchema, CreatedBySchema, CronSchedule, SlideshowGetResponse, SlideshowSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, CustomObjectFieldValue, CustomObjectListItemDefinationSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseByResourceIdSchema, ActionPage, PageType };
|
|
592
592
|
}
|
|
593
593
|
/** @returns {ApplicationLegal} */
|
|
594
594
|
declare function ApplicationLegal(): ApplicationLegal;
|
|
@@ -793,17 +793,9 @@ type Language = {
|
|
|
793
793
|
/** @returns {Action} */
|
|
794
794
|
declare function Action(): Action;
|
|
795
795
|
type Action = {
|
|
796
|
+
type?: string;
|
|
796
797
|
page?: ActionPage;
|
|
797
798
|
popup?: ActionPage;
|
|
798
|
-
type?: string;
|
|
799
|
-
};
|
|
800
|
-
/** @returns {ActionPage} */
|
|
801
|
-
declare function ActionPage(): ActionPage;
|
|
802
|
-
type ActionPage = {
|
|
803
|
-
params?: any;
|
|
804
|
-
query?: any;
|
|
805
|
-
url?: string;
|
|
806
|
-
type: PageType;
|
|
807
799
|
};
|
|
808
800
|
/** @returns {NavigationReference} */
|
|
809
801
|
declare function NavigationReference(): NavigationReference;
|
|
@@ -1209,6 +1201,14 @@ declare function CustomFieldsResponseByResourceIdSchema(): CustomFieldsResponseB
|
|
|
1209
1201
|
type CustomFieldsResponseByResourceIdSchema = {
|
|
1210
1202
|
items?: CustomFieldSchema[];
|
|
1211
1203
|
};
|
|
1204
|
+
/** @returns {ActionPage} */
|
|
1205
|
+
declare function ActionPage(): ActionPage;
|
|
1206
|
+
type ActionPage = {
|
|
1207
|
+
params?: any;
|
|
1208
|
+
query?: any;
|
|
1209
|
+
url?: string;
|
|
1210
|
+
type: PageType;
|
|
1211
|
+
};
|
|
1212
1212
|
/**
|
|
1213
1213
|
* Enum: PageType Used By: Content
|
|
1214
1214
|
*
|