@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -55,7 +55,7 @@ class Configuration {
|
|
|
55
55
|
* @returns {Promise<AppCurrencyResponseSchema>} - Success response
|
|
56
56
|
* @name getAppCurrencies
|
|
57
57
|
* @summary: Get currency configuration
|
|
58
|
-
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://
|
|
58
|
+
* @description: Get currency configuration of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppCurrencies/).
|
|
59
59
|
*/
|
|
60
60
|
async getAppCurrencies(
|
|
61
61
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -92,7 +92,7 @@ class Configuration {
|
|
|
92
92
|
* @returns {Promise<AppStaffListResponseSchema>} - Success response
|
|
93
93
|
* @name getAppStaffList
|
|
94
94
|
* @summary: List staff members
|
|
95
|
-
* @description: List all staff members of the sales channel. - Check out [method documentation](https://
|
|
95
|
+
* @description: List all staff members of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppStaffList/).
|
|
96
96
|
*/
|
|
97
97
|
async getAppStaffList(
|
|
98
98
|
{
|
|
@@ -187,7 +187,7 @@ class Configuration {
|
|
|
187
187
|
* @returns {Promise<AppStaffResponseSchema>} - Success response
|
|
188
188
|
* @name getAppStaffs
|
|
189
189
|
* @summary: Get staff member
|
|
190
|
-
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://
|
|
190
|
+
* @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getAppStaffs/).
|
|
191
191
|
*/
|
|
192
192
|
async getAppStaffs(
|
|
193
193
|
{ orderIncent, orderingStore, user, requestHeaders } = {
|
|
@@ -229,7 +229,7 @@ class Configuration {
|
|
|
229
229
|
* @returns {Promise<Application>} - Success response
|
|
230
230
|
* @name getApplication
|
|
231
231
|
* @summary: Get sales channel
|
|
232
|
-
* @description: Get details of the current sales channel. - Check out [method documentation](https://
|
|
232
|
+
* @description: Get details of the current sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getApplication/).
|
|
233
233
|
*/
|
|
234
234
|
async getApplication(
|
|
235
235
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -266,7 +266,7 @@ class Configuration {
|
|
|
266
266
|
* @returns {Promise<ApplicationDetail>} - Success response
|
|
267
267
|
* @name getBasicDetails
|
|
268
268
|
* @summary: Get Sales channel
|
|
269
|
-
* @description: Get basic details of the sales channel. - Check out [method documentation](https://
|
|
269
|
+
* @description: Get basic details of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getBasicDetails/).
|
|
270
270
|
*/
|
|
271
271
|
async getBasicDetails(
|
|
272
272
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -303,7 +303,7 @@ class Configuration {
|
|
|
303
303
|
* @returns {Promise<ApplicationInformation>} - Success response
|
|
304
304
|
* @name getContactInfo
|
|
305
305
|
* @summary: Get sales channel contact
|
|
306
|
-
* @description: Get contact details of the sales channel. - Check out [method documentation](https://
|
|
306
|
+
* @description: Get contact details of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getContactInfo/).
|
|
307
307
|
*/
|
|
308
308
|
async getContactInfo(
|
|
309
309
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -340,7 +340,7 @@ class Configuration {
|
|
|
340
340
|
* @returns {Promise<CurrenciesResponseSchema>} - Success response
|
|
341
341
|
* @name getCurrencies
|
|
342
342
|
* @summary: List currencies
|
|
343
|
-
* @description: List available currencies. - Check out [method documentation](https://
|
|
343
|
+
* @description: List available currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getCurrencies/).
|
|
344
344
|
*/
|
|
345
345
|
async getCurrencies(
|
|
346
346
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -377,7 +377,7 @@ class Configuration {
|
|
|
377
377
|
* @returns {Promise<Currency>} - Success response
|
|
378
378
|
* @name getCurrencyById
|
|
379
379
|
* @summary: Get a currency
|
|
380
|
-
* @description: Get details of the currency. - Check out [method documentation](https://
|
|
380
|
+
* @description: Get details of the currency. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getCurrencyById/).
|
|
381
381
|
*/
|
|
382
382
|
async getCurrencyById(
|
|
383
383
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -423,7 +423,7 @@ class Configuration {
|
|
|
423
423
|
* @returns {Promise<AppFeatureResponseSchema>} - Success response
|
|
424
424
|
* @name getFeatures
|
|
425
425
|
* @summary: Get sales channel features
|
|
426
|
-
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://
|
|
426
|
+
* @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getFeatures/).
|
|
427
427
|
*/
|
|
428
428
|
async getFeatures(
|
|
429
429
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -460,7 +460,7 @@ class Configuration {
|
|
|
460
460
|
* @returns {Promise<AppTokenResponseSchema>} - Success response
|
|
461
461
|
* @name getIntegrationTokens
|
|
462
462
|
* @summary: Get API tokens
|
|
463
|
-
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://
|
|
463
|
+
* @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getIntegrationTokens/).
|
|
464
464
|
*/
|
|
465
465
|
async getIntegrationTokens(
|
|
466
466
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -497,7 +497,7 @@ class Configuration {
|
|
|
497
497
|
* @returns {Promise<LanguageResponseSchema>} - Success response
|
|
498
498
|
* @name getLanguages
|
|
499
499
|
* @summary: List languages
|
|
500
|
-
* @description: List available languages. - Check out [method documentation](https://
|
|
500
|
+
* @description: List available languages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getLanguages/).
|
|
501
501
|
*/
|
|
502
502
|
async getLanguages(
|
|
503
503
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -534,7 +534,7 @@ class Configuration {
|
|
|
534
534
|
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
535
535
|
* @name getOrderingStoreCookie
|
|
536
536
|
* @summary: Create cookies
|
|
537
|
-
* @description: Reset cookie of ordering store. - Check out [method documentation](https://
|
|
537
|
+
* @description: Reset cookie of ordering store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOrderingStoreCookie/).
|
|
538
538
|
*/
|
|
539
539
|
async getOrderingStoreCookie(
|
|
540
540
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -571,7 +571,7 @@ class Configuration {
|
|
|
571
571
|
* @returns {Promise<OrderingStores>} - Success response
|
|
572
572
|
* @name getOrderingStores
|
|
573
573
|
* @summary: List order-enabled selling locations
|
|
574
|
-
* @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://
|
|
574
|
+
* @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOrderingStores/).
|
|
575
575
|
*/
|
|
576
576
|
async getOrderingStores(
|
|
577
577
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -611,7 +611,7 @@ class Configuration {
|
|
|
611
611
|
* @returns {Promise<ApplicationAboutResponseSchema>} - Success response
|
|
612
612
|
* @name getOwnerInfo
|
|
613
613
|
* @summary: Get sales channel owner
|
|
614
|
-
* @description: Get details of the sales channel owner. - Check out [method documentation](https://
|
|
614
|
+
* @description: Get details of the sales channel owner. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getOwnerInfo/).
|
|
615
615
|
*/
|
|
616
616
|
async getOwnerInfo(
|
|
617
617
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -648,7 +648,7 @@ class Configuration {
|
|
|
648
648
|
* @returns {Promise<OrderingStore>} - Success response
|
|
649
649
|
* @name getStoreDetailById
|
|
650
650
|
* @summary: Get a selling location
|
|
651
|
-
* @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://
|
|
651
|
+
* @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/getStoreDetailById/).
|
|
652
652
|
*/
|
|
653
653
|
async getStoreDetailById(
|
|
654
654
|
{ storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -694,7 +694,7 @@ class Configuration {
|
|
|
694
694
|
* @returns {Promise<SuccessMessageResponseSchema>} - Success response
|
|
695
695
|
* @name removeOrderingStoreCookie
|
|
696
696
|
* @summary: Delete store cookie
|
|
697
|
-
* @description: Delete store cookie. - Check out [method documentation](https://
|
|
697
|
+
* @description: Delete store cookie. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/configuration/removeOrderingStoreCookie/).
|
|
698
698
|
*/
|
|
699
699
|
async removeOrderingStoreCookie(
|
|
700
700
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -36,7 +36,7 @@ declare class Content {
|
|
|
36
36
|
* @returns {Promise<ResourceTranslations>} - Success response
|
|
37
37
|
* @name fetchResourceTranslations
|
|
38
38
|
* @summary: Get Resource Translations
|
|
39
|
-
* @description: Fetch translations for specific resource IDs based on type and locale settings. - Check out [method documentation](https://
|
|
39
|
+
* @description: Fetch translations for specific resource IDs based on type and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/fetchResourceTranslations/).
|
|
40
40
|
*/
|
|
41
41
|
fetchResourceTranslations({ type, locale, resourceId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ResourceTranslations>;
|
|
42
42
|
/**
|
|
@@ -45,7 +45,7 @@ declare class Content {
|
|
|
45
45
|
* @returns {Promise<ResourceTranslations>} - Success response
|
|
46
46
|
* @name fetchResourceTranslationsWithPayload
|
|
47
47
|
* @summary: Post Resource Translations
|
|
48
|
-
* @description: Submit and retrieve translations for resources using payload data and locale settings. - Check out [method documentation](https://
|
|
48
|
+
* @description: Submit and retrieve translations for resources using payload data and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/fetchResourceTranslationsWithPayload/).
|
|
49
49
|
*/
|
|
50
50
|
fetchResourceTranslationsWithPayload({ type, locale, resourceId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ResourceTranslations>;
|
|
51
51
|
/**
|
|
@@ -54,7 +54,7 @@ declare class Content {
|
|
|
54
54
|
* @returns {Promise<AnnouncementsResponseSchema>} - Success response
|
|
55
55
|
* @name getAnnouncements
|
|
56
56
|
* @summary: List announcements
|
|
57
|
-
* @description: List all current announcements in the application. - Check out [method documentation](https://
|
|
57
|
+
* @description: List all current announcements in the application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getAnnouncements/).
|
|
58
58
|
*/
|
|
59
59
|
getAnnouncements({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AnnouncementsResponseSchema>;
|
|
60
60
|
/**
|
|
@@ -63,7 +63,7 @@ declare class Content {
|
|
|
63
63
|
* @returns {Promise<BlogSchema>} - Success response
|
|
64
64
|
* @name getBlog
|
|
65
65
|
* @summary: Get a blog
|
|
66
|
-
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://
|
|
66
|
+
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBlog/).
|
|
67
67
|
*/
|
|
68
68
|
getBlog({ slug, rootId, preview, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BlogSchema>;
|
|
69
69
|
/**
|
|
@@ -72,7 +72,7 @@ declare class Content {
|
|
|
72
72
|
* @returns {Promise<BlogGetDetails>} - Success response
|
|
73
73
|
* @name getBlogs
|
|
74
74
|
* @summary: List blogs
|
|
75
|
-
* @description: List all the blogs against an application. - Check out [method documentation](https://
|
|
75
|
+
* @description: List all the blogs against an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBlogs/).
|
|
76
76
|
*/
|
|
77
77
|
getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogGetDetails>;
|
|
78
78
|
/**
|
|
@@ -81,7 +81,7 @@ declare class Content {
|
|
|
81
81
|
* @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
|
|
82
82
|
* @name getCustomFieldsByResourceId
|
|
83
83
|
* @summary: Get list of custom fields of given resource and resource slug
|
|
84
|
-
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://
|
|
84
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getCustomFieldsByResourceId/).
|
|
85
85
|
*/
|
|
86
86
|
getCustomFieldsByResourceId({ resource, resourceSlug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomFieldsResponseByResourceIdSchema>;
|
|
87
87
|
/**
|
|
@@ -90,7 +90,7 @@ declare class Content {
|
|
|
90
90
|
* @returns {Promise<CustomObjectByIdSchema>} - Success response
|
|
91
91
|
* @name getCustomObjectBySlug
|
|
92
92
|
* @summary: Get custom object details
|
|
93
|
-
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://
|
|
93
|
+
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getCustomObjectBySlug/).
|
|
94
94
|
*/
|
|
95
95
|
getCustomObjectBySlug({ definitionSlug, slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomObjectByIdSchema>;
|
|
96
96
|
/**
|
|
@@ -99,7 +99,7 @@ declare class Content {
|
|
|
99
99
|
* @returns {Promise<DataLoadersSchema>} - Success response
|
|
100
100
|
* @name getDataLoaders
|
|
101
101
|
* @summary: List Dataloaders
|
|
102
|
-
* @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://
|
|
102
|
+
* @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getDataLoaders/).
|
|
103
103
|
*/
|
|
104
104
|
getDataLoaders({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DataLoadersSchema>;
|
|
105
105
|
/**
|
|
@@ -108,7 +108,7 @@ declare class Content {
|
|
|
108
108
|
* @returns {Promise<FaqSchema>} - Success response
|
|
109
109
|
* @name getFaqBySlug
|
|
110
110
|
* @summary: Get FAQ
|
|
111
|
-
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://
|
|
111
|
+
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqBySlug/).
|
|
112
112
|
*/
|
|
113
113
|
getFaqBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FaqSchema>;
|
|
114
114
|
/**
|
|
@@ -117,7 +117,7 @@ declare class Content {
|
|
|
117
117
|
* @returns {Promise<GetFaqCategoriesSchema>} - Success response
|
|
118
118
|
* @name getFaqCategories
|
|
119
119
|
* @summary: List FAQ Categories
|
|
120
|
-
* @description: List categories for organizing FAQs. - Check out [method documentation](https://
|
|
120
|
+
* @description: List categories for organizing FAQs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqCategories/).
|
|
121
121
|
*/
|
|
122
122
|
getFaqCategories({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetFaqCategoriesSchema>;
|
|
123
123
|
/**
|
|
@@ -126,7 +126,7 @@ declare class Content {
|
|
|
126
126
|
* @returns {Promise<GetFaqCategoryBySlugSchema>} - Success response
|
|
127
127
|
* @name getFaqCategoryBySlug
|
|
128
128
|
* @summary: Get a FAQ category
|
|
129
|
-
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://
|
|
129
|
+
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqCategoryBySlug/).
|
|
130
130
|
*/
|
|
131
131
|
getFaqCategoryBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFaqCategoryBySlugSchema>;
|
|
132
132
|
/**
|
|
@@ -135,7 +135,7 @@ declare class Content {
|
|
|
135
135
|
* @returns {Promise<FaqResponseSchema>} - Success response
|
|
136
136
|
* @name getFaqs
|
|
137
137
|
* @summary: List FAQs
|
|
138
|
-
* @description: List frequently asked questions and answers. - Check out [method documentation](https://
|
|
138
|
+
* @description: List frequently asked questions and answers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqs/).
|
|
139
139
|
*/
|
|
140
140
|
getFaqs({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FaqResponseSchema>;
|
|
141
141
|
/**
|
|
@@ -144,7 +144,7 @@ declare class Content {
|
|
|
144
144
|
* @returns {Promise<GetFaqSchema>} - Success response
|
|
145
145
|
* @name getFaqsByCategorySlug
|
|
146
146
|
* @summary: List FAQs by category
|
|
147
|
-
* @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://
|
|
147
|
+
* @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqsByCategorySlug/).
|
|
148
148
|
*/
|
|
149
149
|
getFaqsByCategorySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFaqSchema>;
|
|
150
150
|
/**
|
|
@@ -153,7 +153,7 @@ declare class Content {
|
|
|
153
153
|
* @returns {Promise<LandingPageSchema>} - Success response
|
|
154
154
|
* @name getLandingPage
|
|
155
155
|
* @summary: Get a landing page
|
|
156
|
-
* @description: Get content of the application's landing page. - Check out [method documentation](https://
|
|
156
|
+
* @description: Get content of the application's landing page. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getLandingPage/).
|
|
157
157
|
*/
|
|
158
158
|
getLandingPage({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LandingPageSchema>;
|
|
159
159
|
/**
|
|
@@ -162,7 +162,7 @@ declare class Content {
|
|
|
162
162
|
* @returns {Promise<ApplicationLegal>} - Success response
|
|
163
163
|
* @name getLegalInformation
|
|
164
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/application/content/getLegalInformation/).
|
|
166
166
|
*/
|
|
167
167
|
getLegalInformation({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationLegal>;
|
|
168
168
|
/**
|
|
@@ -171,7 +171,7 @@ declare class Content {
|
|
|
171
171
|
* @returns {Promise<NavigationGetDetails>} - Success response
|
|
172
172
|
* @name getNavigations
|
|
173
173
|
* @summary: List navigation items
|
|
174
|
-
* @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://
|
|
174
|
+
* @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getNavigations/).
|
|
175
175
|
*/
|
|
176
176
|
getNavigations({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<NavigationGetDetails>;
|
|
177
177
|
/**
|
|
@@ -180,7 +180,7 @@ declare class Content {
|
|
|
180
180
|
* @returns {Promise<PageSchema>} - Success response
|
|
181
181
|
* @name getPage
|
|
182
182
|
* @summary: Get a page
|
|
183
|
-
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://
|
|
183
|
+
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getPage/).
|
|
184
184
|
*/
|
|
185
185
|
getPage({ slug, rootId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<PageSchema>;
|
|
186
186
|
/**
|
|
@@ -189,7 +189,7 @@ declare class Content {
|
|
|
189
189
|
* @returns {Promise<PageGetDetails>} - Success response
|
|
190
190
|
* @name getPages
|
|
191
191
|
* @summary: Lists pages
|
|
192
|
-
* @description: Lists all Custom Pages. - Check out [method documentation](https://
|
|
192
|
+
* @description: Lists all Custom Pages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getPages/).
|
|
193
193
|
*/
|
|
194
194
|
getPages({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PageGetDetails>;
|
|
195
195
|
/**
|
|
@@ -198,7 +198,7 @@ declare class Content {
|
|
|
198
198
|
* @returns {Promise<SeoComponent>} - Success response
|
|
199
199
|
* @name getSEOConfiguration
|
|
200
200
|
* @summary: Get SEO settings
|
|
201
|
-
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://
|
|
201
|
+
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSEOConfiguration/).
|
|
202
202
|
*/
|
|
203
203
|
getSEOConfiguration({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SeoComponent>;
|
|
204
204
|
/**
|
|
@@ -207,7 +207,7 @@ declare class Content {
|
|
|
207
207
|
* @returns {Promise<SeoSchemaComponent>} - Success response
|
|
208
208
|
* @name getSEOMarkupSchemas
|
|
209
209
|
* @summary: List SEO Markup schemas
|
|
210
|
-
* @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://
|
|
210
|
+
* @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSEOMarkupSchemas/).
|
|
211
211
|
*/
|
|
212
212
|
getSEOMarkupSchemas({ pageType, active, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SeoSchemaComponent>;
|
|
213
213
|
/**
|
|
@@ -216,7 +216,7 @@ declare class Content {
|
|
|
216
216
|
* @returns {Promise<Support>} - Success response
|
|
217
217
|
* @name getSupportInformation
|
|
218
218
|
* @summary: Get customer support information
|
|
219
|
-
* @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://
|
|
219
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/content/getSupportInformation/).
|
|
220
220
|
*/
|
|
221
221
|
getSupportInformation({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Support>;
|
|
222
222
|
/**
|
|
@@ -225,7 +225,7 @@ declare class Content {
|
|
|
225
225
|
* @returns {Promise<Object>} - Success response
|
|
226
226
|
* @name getSupportedLanguages
|
|
227
227
|
* @summary: List App Languages
|
|
228
|
-
* @description: Retrieve available languages and their configurations for the specified application. - Check out [method documentation](https://
|
|
228
|
+
* @description: Retrieve available languages and their configurations for the specified application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSupportedLanguages/).
|
|
229
229
|
*/
|
|
230
230
|
getSupportedLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<any>;
|
|
231
231
|
/**
|
|
@@ -234,7 +234,7 @@ declare class Content {
|
|
|
234
234
|
* @returns {Promise<TagsSchema>} - Success response
|
|
235
235
|
* @name getTags
|
|
236
236
|
* @summary: Get HTML tags
|
|
237
|
-
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://
|
|
237
|
+
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getTags/).
|
|
238
238
|
*/
|
|
239
239
|
getTags({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TagsSchema>;
|
|
240
240
|
/**
|
|
@@ -243,7 +243,7 @@ declare class Content {
|
|
|
243
243
|
* @returns {Promise<TranslateUiLabelsPage>} - Success response
|
|
244
244
|
* @name getTranslateUILabels
|
|
245
245
|
* @summary: Get Translate Ui Labels
|
|
246
|
-
* @description: Retrieve Translate Ui Labels with filtering options for type, template, and locale settings. - Check out [method documentation](https://
|
|
246
|
+
* @description: Retrieve Translate Ui Labels with filtering options for type, template, and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getTranslateUILabels/).
|
|
247
247
|
*/
|
|
248
248
|
getTranslateUILabels({ template, templateThemeId, themeId, locale, type, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TranslateUiLabelsPage>;
|
|
249
249
|
}
|
|
@@ -66,7 +66,7 @@ class Content {
|
|
|
66
66
|
* @returns {Promise<ResourceTranslations>} - Success response
|
|
67
67
|
* @name fetchResourceTranslations
|
|
68
68
|
* @summary: Get Resource Translations
|
|
69
|
-
* @description: Fetch translations for specific resource IDs based on type and locale settings. - Check out [method documentation](https://
|
|
69
|
+
* @description: Fetch translations for specific resource IDs based on type and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/fetchResourceTranslations/).
|
|
70
70
|
*/
|
|
71
71
|
async fetchResourceTranslations(
|
|
72
72
|
{ type, locale, resourceId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -113,7 +113,7 @@ class Content {
|
|
|
113
113
|
* @returns {Promise<ResourceTranslations>} - Success response
|
|
114
114
|
* @name fetchResourceTranslationsWithPayload
|
|
115
115
|
* @summary: Post Resource Translations
|
|
116
|
-
* @description: Submit and retrieve translations for resources using payload data and locale settings. - Check out [method documentation](https://
|
|
116
|
+
* @description: Submit and retrieve translations for resources using payload data and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/fetchResourceTranslationsWithPayload/).
|
|
117
117
|
*/
|
|
118
118
|
async fetchResourceTranslationsWithPayload(
|
|
119
119
|
{ type, locale, resourceId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -160,7 +160,7 @@ class Content {
|
|
|
160
160
|
* @returns {Promise<AnnouncementsResponseSchema>} - Success response
|
|
161
161
|
* @name getAnnouncements
|
|
162
162
|
* @summary: List announcements
|
|
163
|
-
* @description: List all current announcements in the application. - Check out [method documentation](https://
|
|
163
|
+
* @description: List all current announcements in the application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getAnnouncements/).
|
|
164
164
|
*/
|
|
165
165
|
async getAnnouncements(
|
|
166
166
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -197,7 +197,7 @@ class Content {
|
|
|
197
197
|
* @returns {Promise<BlogSchema>} - Success response
|
|
198
198
|
* @name getBlog
|
|
199
199
|
* @summary: Get a blog
|
|
200
|
-
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://
|
|
200
|
+
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBlog/).
|
|
201
201
|
*/
|
|
202
202
|
async getBlog(
|
|
203
203
|
{ slug, rootId, preview, requestHeaders } = { requestHeaders: {} },
|
|
@@ -245,7 +245,7 @@ class Content {
|
|
|
245
245
|
* @returns {Promise<BlogGetDetails>} - Success response
|
|
246
246
|
* @name getBlogs
|
|
247
247
|
* @summary: List blogs
|
|
248
|
-
* @description: List all the blogs against an application. - Check out [method documentation](https://
|
|
248
|
+
* @description: List all the blogs against an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getBlogs/).
|
|
249
249
|
*/
|
|
250
250
|
async getBlogs(
|
|
251
251
|
{ pageNo, pageSize, tags, search, requestHeaders } = { requestHeaders: {} },
|
|
@@ -286,7 +286,7 @@ class Content {
|
|
|
286
286
|
* @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
|
|
287
287
|
* @name getCustomFieldsByResourceId
|
|
288
288
|
* @summary: Get list of custom fields of given resource and resource slug
|
|
289
|
-
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://
|
|
289
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getCustomFieldsByResourceId/).
|
|
290
290
|
*/
|
|
291
291
|
async getCustomFieldsByResourceId(
|
|
292
292
|
{ resource, resourceSlug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -335,7 +335,7 @@ class Content {
|
|
|
335
335
|
* @returns {Promise<CustomObjectByIdSchema>} - Success response
|
|
336
336
|
* @name getCustomObjectBySlug
|
|
337
337
|
* @summary: Get custom object details
|
|
338
|
-
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://
|
|
338
|
+
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getCustomObjectBySlug/).
|
|
339
339
|
*/
|
|
340
340
|
async getCustomObjectBySlug(
|
|
341
341
|
{ definitionSlug, slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -384,7 +384,7 @@ class Content {
|
|
|
384
384
|
* @returns {Promise<DataLoadersSchema>} - Success response
|
|
385
385
|
* @name getDataLoaders
|
|
386
386
|
* @summary: List Dataloaders
|
|
387
|
-
* @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://
|
|
387
|
+
* @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getDataLoaders/).
|
|
388
388
|
*/
|
|
389
389
|
async getDataLoaders(
|
|
390
390
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -421,7 +421,7 @@ class Content {
|
|
|
421
421
|
* @returns {Promise<FaqSchema>} - Success response
|
|
422
422
|
* @name getFaqBySlug
|
|
423
423
|
* @summary: Get FAQ
|
|
424
|
-
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://
|
|
424
|
+
* @description: Get a specific FAQ using its slug identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqBySlug/).
|
|
425
425
|
*/
|
|
426
426
|
async getFaqBySlug(
|
|
427
427
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -467,7 +467,7 @@ class Content {
|
|
|
467
467
|
* @returns {Promise<GetFaqCategoriesSchema>} - Success response
|
|
468
468
|
* @name getFaqCategories
|
|
469
469
|
* @summary: List FAQ Categories
|
|
470
|
-
* @description: List categories for organizing FAQs. - Check out [method documentation](https://
|
|
470
|
+
* @description: List categories for organizing FAQs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqCategories/).
|
|
471
471
|
*/
|
|
472
472
|
async getFaqCategories(
|
|
473
473
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -504,7 +504,7 @@ class Content {
|
|
|
504
504
|
* @returns {Promise<GetFaqCategoryBySlugSchema>} - Success response
|
|
505
505
|
* @name getFaqCategoryBySlug
|
|
506
506
|
* @summary: Get a FAQ category
|
|
507
|
-
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://
|
|
507
|
+
* @description: Get a specific FAQ category using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqCategoryBySlug/).
|
|
508
508
|
*/
|
|
509
509
|
async getFaqCategoryBySlug(
|
|
510
510
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -550,7 +550,7 @@ class Content {
|
|
|
550
550
|
* @returns {Promise<FaqResponseSchema>} - Success response
|
|
551
551
|
* @name getFaqs
|
|
552
552
|
* @summary: List FAQs
|
|
553
|
-
* @description: List frequently asked questions and answers. - Check out [method documentation](https://
|
|
553
|
+
* @description: List frequently asked questions and answers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqs/).
|
|
554
554
|
*/
|
|
555
555
|
async getFaqs(
|
|
556
556
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -587,7 +587,7 @@ class Content {
|
|
|
587
587
|
* @returns {Promise<GetFaqSchema>} - Success response
|
|
588
588
|
* @name getFaqsByCategorySlug
|
|
589
589
|
* @summary: List FAQs by category
|
|
590
|
-
* @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://
|
|
590
|
+
* @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getFaqsByCategorySlug/).
|
|
591
591
|
*/
|
|
592
592
|
async getFaqsByCategorySlug(
|
|
593
593
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -633,7 +633,7 @@ class Content {
|
|
|
633
633
|
* @returns {Promise<LandingPageSchema>} - Success response
|
|
634
634
|
* @name getLandingPage
|
|
635
635
|
* @summary: Get a landing page
|
|
636
|
-
* @description: Get content of the application's landing page. - Check out [method documentation](https://
|
|
636
|
+
* @description: Get content of the application's landing page. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getLandingPage/).
|
|
637
637
|
*/
|
|
638
638
|
async getLandingPage(
|
|
639
639
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -670,7 +670,7 @@ class Content {
|
|
|
670
670
|
* @returns {Promise<ApplicationLegal>} - Success response
|
|
671
671
|
* @name getLegalInformation
|
|
672
672
|
* @summary: Get legal information
|
|
673
|
-
* @description: Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://
|
|
673
|
+
* @description: Get legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getLegalInformation/).
|
|
674
674
|
*/
|
|
675
675
|
async getLegalInformation(
|
|
676
676
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -707,7 +707,7 @@ class Content {
|
|
|
707
707
|
* @returns {Promise<NavigationGetDetails>} - Success response
|
|
708
708
|
* @name getNavigations
|
|
709
709
|
* @summary: List navigation items
|
|
710
|
-
* @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://
|
|
710
|
+
* @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getNavigations/).
|
|
711
711
|
*/
|
|
712
712
|
async getNavigations(
|
|
713
713
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -746,7 +746,7 @@ class Content {
|
|
|
746
746
|
* @returns {Promise<PageSchema>} - Success response
|
|
747
747
|
* @name getPage
|
|
748
748
|
* @summary: Get a page
|
|
749
|
-
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://
|
|
749
|
+
* @description: Get detailed information for a specific page within the theme. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getPage/).
|
|
750
750
|
*/
|
|
751
751
|
async getPage(
|
|
752
752
|
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -793,7 +793,7 @@ class Content {
|
|
|
793
793
|
* @returns {Promise<PageGetDetails>} - Success response
|
|
794
794
|
* @name getPages
|
|
795
795
|
* @summary: Lists pages
|
|
796
|
-
* @description: Lists all Custom Pages. - Check out [method documentation](https://
|
|
796
|
+
* @description: Lists all Custom Pages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getPages/).
|
|
797
797
|
*/
|
|
798
798
|
async getPages(
|
|
799
799
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -832,7 +832,7 @@ class Content {
|
|
|
832
832
|
* @returns {Promise<SeoComponent>} - Success response
|
|
833
833
|
* @name getSEOConfiguration
|
|
834
834
|
* @summary: Get SEO settings
|
|
835
|
-
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://
|
|
835
|
+
* @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSEOConfiguration/).
|
|
836
836
|
*/
|
|
837
837
|
async getSEOConfiguration(
|
|
838
838
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -869,7 +869,7 @@ class Content {
|
|
|
869
869
|
* @returns {Promise<SeoSchemaComponent>} - Success response
|
|
870
870
|
* @name getSEOMarkupSchemas
|
|
871
871
|
* @summary: List SEO Markup schemas
|
|
872
|
-
* @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://
|
|
872
|
+
* @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSEOMarkupSchemas/).
|
|
873
873
|
*/
|
|
874
874
|
async getSEOMarkupSchemas(
|
|
875
875
|
{ pageType, active, requestHeaders } = { requestHeaders: {} },
|
|
@@ -908,7 +908,7 @@ class Content {
|
|
|
908
908
|
* @returns {Promise<Support>} - Success response
|
|
909
909
|
* @name getSupportInformation
|
|
910
910
|
* @summary: Get customer support information
|
|
911
|
-
* @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://
|
|
911
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/content/getSupportInformation/).
|
|
912
912
|
*/
|
|
913
913
|
async getSupportInformation(
|
|
914
914
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -945,7 +945,7 @@ class Content {
|
|
|
945
945
|
* @returns {Promise<Object>} - Success response
|
|
946
946
|
* @name getSupportedLanguages
|
|
947
947
|
* @summary: List App Languages
|
|
948
|
-
* @description: Retrieve available languages and their configurations for the specified application. - Check out [method documentation](https://
|
|
948
|
+
* @description: Retrieve available languages and their configurations for the specified application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getSupportedLanguages/).
|
|
949
949
|
*/
|
|
950
950
|
async getSupportedLanguages(
|
|
951
951
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -982,7 +982,7 @@ class Content {
|
|
|
982
982
|
* @returns {Promise<TagsSchema>} - Success response
|
|
983
983
|
* @name getTags
|
|
984
984
|
* @summary: Get HTML tags
|
|
985
|
-
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://
|
|
985
|
+
* @description: Lists HTML tags to power additional functionalities within an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getTags/).
|
|
986
986
|
*/
|
|
987
987
|
async getTags(
|
|
988
988
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1019,7 +1019,7 @@ class Content {
|
|
|
1019
1019
|
* @returns {Promise<TranslateUiLabelsPage>} - Success response
|
|
1020
1020
|
* @name getTranslateUILabels
|
|
1021
1021
|
* @summary: Get Translate Ui Labels
|
|
1022
|
-
* @description: Retrieve Translate Ui Labels with filtering options for type, template, and locale settings. - Check out [method documentation](https://
|
|
1022
|
+
* @description: Retrieve Translate Ui Labels with filtering options for type, template, and locale settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/content/getTranslateUILabels/).
|
|
1023
1023
|
*/
|
|
1024
1024
|
async getTranslateUILabels(
|
|
1025
1025
|
{ template, templateThemeId, themeId, locale, type, requestHeaders } = {
|
|
@@ -15,7 +15,7 @@ declare class FileStorage {
|
|
|
15
15
|
* @returns {Promise<FileUploadComplete>} - Success response
|
|
16
16
|
* @name completeUpload
|
|
17
17
|
* @summary: Finalizes upload process.
|
|
18
|
-
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://
|
|
18
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/completeUpload/).
|
|
19
19
|
*/
|
|
20
20
|
completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FileUploadComplete>;
|
|
21
21
|
/**
|
|
@@ -24,7 +24,7 @@ declare class FileStorage {
|
|
|
24
24
|
* @returns {Promise<SignUrlResult>} - Success response
|
|
25
25
|
* @name signUrls
|
|
26
26
|
* @summary: Signs file URLs.
|
|
27
|
-
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://
|
|
27
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/signUrls/).
|
|
28
28
|
*/
|
|
29
29
|
signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SignUrlResult>;
|
|
30
30
|
/**
|
|
@@ -33,7 +33,7 @@ declare class FileStorage {
|
|
|
33
33
|
* @returns {Promise<FileUpload>} - Success response
|
|
34
34
|
* @name startUpload
|
|
35
35
|
* @summary: Initiates file upload
|
|
36
|
-
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://
|
|
36
|
+
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/startUpload/).
|
|
37
37
|
*/
|
|
38
38
|
startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FileUpload>;
|
|
39
39
|
/**
|