@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- 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
|
@@ -29,8 +29,8 @@ declare class Configuration {
|
|
|
29
29
|
* @returns {Promise<ConfigurationApplicationModel.AppCurrencyResponse>} -
|
|
30
30
|
* Success response
|
|
31
31
|
* @name getAppCurrencies
|
|
32
|
-
* @summary:
|
|
33
|
-
* @description: Retrieve
|
|
32
|
+
* @summary: Get currency configuration
|
|
33
|
+
* @description: Retrieve currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
|
|
34
34
|
*/
|
|
35
35
|
getAppCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppCurrencyResponse>;
|
|
36
36
|
/**
|
|
@@ -40,8 +40,8 @@ declare class Configuration {
|
|
|
40
40
|
* @returns {Promise<ConfigurationApplicationModel.AppStaffListResponse>} -
|
|
41
41
|
* Success response
|
|
42
42
|
* @name getAppStaffList
|
|
43
|
-
* @summary:
|
|
44
|
-
* @description: Retrieve a list of staff
|
|
43
|
+
* @summary: List staff members
|
|
44
|
+
* @description: Retrieve a list of all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
|
|
45
45
|
*/
|
|
46
46
|
getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: ConfigurationApplicationValidator.GetAppStaffListParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppStaffListResponse>;
|
|
47
47
|
/**
|
|
@@ -51,8 +51,8 @@ declare class Configuration {
|
|
|
51
51
|
* @returns {Promise<ConfigurationApplicationModel.AppStaffResponse>} -
|
|
52
52
|
* Success response
|
|
53
53
|
* @name getAppStaffs
|
|
54
|
-
* @summary:
|
|
55
|
-
* @description: Retrieve a
|
|
54
|
+
* @summary: Get staff member
|
|
55
|
+
* @description: Retrieve 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://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
|
|
56
56
|
*/
|
|
57
57
|
getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: ConfigurationApplicationValidator.GetAppStaffsParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppStaffResponse>;
|
|
58
58
|
/**
|
|
@@ -61,8 +61,8 @@ declare class Configuration {
|
|
|
61
61
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
62
62
|
* @returns {Promise<ConfigurationApplicationModel.Application>} - Success response
|
|
63
63
|
* @name getApplication
|
|
64
|
-
* @summary:
|
|
65
|
-
* @description: Retrieve
|
|
64
|
+
* @summary: Get sales channel
|
|
65
|
+
* @description: Retrieve details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
|
|
66
66
|
*/
|
|
67
67
|
getApplication({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.Application>;
|
|
68
68
|
/**
|
|
@@ -72,8 +72,8 @@ declare class Configuration {
|
|
|
72
72
|
* @returns {Promise<ConfigurationApplicationModel.ApplicationDetail>} -
|
|
73
73
|
* Success response
|
|
74
74
|
* @name getBasicDetails
|
|
75
|
-
* @summary:
|
|
76
|
-
* @description: Retrieve
|
|
75
|
+
* @summary: Get Sales channel
|
|
76
|
+
* @description: Retrieve basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
|
|
77
77
|
*/
|
|
78
78
|
getBasicDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationDetail>;
|
|
79
79
|
/**
|
|
@@ -84,8 +84,8 @@ declare class Configuration {
|
|
|
84
84
|
* - Success response
|
|
85
85
|
*
|
|
86
86
|
* @name getContactInfo
|
|
87
|
-
* @summary:
|
|
88
|
-
* @description: Retrieve
|
|
87
|
+
* @summary: Get sales channel contact
|
|
88
|
+
* @description: Retrieve contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
|
|
89
89
|
*/
|
|
90
90
|
getContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationInformation>;
|
|
91
91
|
/**
|
|
@@ -95,8 +95,8 @@ declare class Configuration {
|
|
|
95
95
|
* @returns {Promise<ConfigurationApplicationModel.CurrenciesResponse>} -
|
|
96
96
|
* Success response
|
|
97
97
|
* @name getCurrencies
|
|
98
|
-
* @summary:
|
|
99
|
-
* @description: Retrieve a list of
|
|
98
|
+
* @summary: List currencies
|
|
99
|
+
* @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
|
|
100
100
|
*/
|
|
101
101
|
getCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.CurrenciesResponse>;
|
|
102
102
|
/**
|
|
@@ -105,8 +105,8 @@ declare class Configuration {
|
|
|
105
105
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
106
106
|
* @returns {Promise<ConfigurationApplicationModel.Currency>} - Success response
|
|
107
107
|
* @name getCurrencyById
|
|
108
|
-
* @summary:
|
|
109
|
-
* @description: Retrieve details of
|
|
108
|
+
* @summary: Get a currency
|
|
109
|
+
* @description: Retrieve details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
|
|
110
110
|
*/
|
|
111
111
|
getCurrencyById({ id, requestHeaders }?: ConfigurationApplicationValidator.GetCurrencyByIdParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.Currency>;
|
|
112
112
|
/**
|
|
@@ -116,8 +116,8 @@ declare class Configuration {
|
|
|
116
116
|
* @returns {Promise<ConfigurationApplicationModel.AppFeatureResponse>} -
|
|
117
117
|
* Success response
|
|
118
118
|
* @name getFeatures
|
|
119
|
-
* @summary:
|
|
120
|
-
* @description: Retrieve
|
|
119
|
+
* @summary: Get sales channel features
|
|
120
|
+
* @description: Retrieve configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
|
|
121
121
|
*/
|
|
122
122
|
getFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppFeatureResponse>;
|
|
123
123
|
/**
|
|
@@ -129,8 +129,8 @@ declare class Configuration {
|
|
|
129
129
|
* @returns {Promise<ConfigurationApplicationModel.AppTokenResponse>} -
|
|
130
130
|
* Success response
|
|
131
131
|
* @name getIntegrationTokens
|
|
132
|
-
* @summary:
|
|
133
|
-
* @description: Retrieve the
|
|
132
|
+
* @summary: Get API tokens
|
|
133
|
+
* @description: Retrieve tools integration token of the sales channel. For ex- Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
|
|
134
134
|
*/
|
|
135
135
|
getIntegrationTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppTokenResponse>;
|
|
136
136
|
/**
|
|
@@ -140,8 +140,8 @@ declare class Configuration {
|
|
|
140
140
|
* @returns {Promise<ConfigurationApplicationModel.LanguageResponse>} -
|
|
141
141
|
* Success response
|
|
142
142
|
* @name getLanguages
|
|
143
|
-
* @summary:
|
|
144
|
-
* @description:
|
|
143
|
+
* @summary: List languages
|
|
144
|
+
* @description: Retrieve a list of available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
|
|
145
145
|
*/
|
|
146
146
|
getLanguages({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.LanguageResponse>;
|
|
147
147
|
/**
|
|
@@ -154,8 +154,8 @@ declare class Configuration {
|
|
|
154
154
|
* - Success response
|
|
155
155
|
*
|
|
156
156
|
* @name getOrderingStoreCookie
|
|
157
|
-
* @summary:
|
|
158
|
-
* @description:
|
|
157
|
+
* @summary: Create cookies
|
|
158
|
+
* @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
|
|
159
159
|
*/
|
|
160
160
|
getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.SuccessMessageResponse>;
|
|
161
161
|
/**
|
|
@@ -164,8 +164,8 @@ declare class Configuration {
|
|
|
164
164
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
165
165
|
* @returns {Promise<ConfigurationApplicationModel.OrderingStores>} - Success response
|
|
166
166
|
* @name getOrderingStores
|
|
167
|
-
* @summary:
|
|
168
|
-
* @description: Retrieve
|
|
167
|
+
* @summary: List order-enabled selling locations
|
|
168
|
+
* @description: Retrieve details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
|
|
169
169
|
*/
|
|
170
170
|
getOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationApplicationValidator.GetOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.OrderingStores>;
|
|
171
171
|
/**
|
|
@@ -176,8 +176,8 @@ declare class Configuration {
|
|
|
176
176
|
* - Success response
|
|
177
177
|
*
|
|
178
178
|
* @name getOwnerInfo
|
|
179
|
-
* @summary:
|
|
180
|
-
* @description: Retrieve
|
|
179
|
+
* @summary: Get sales channel owner
|
|
180
|
+
* @description: Retrieve details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
|
|
181
181
|
*/
|
|
182
182
|
getOwnerInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationAboutResponse>;
|
|
183
183
|
/**
|
|
@@ -187,8 +187,8 @@ declare class Configuration {
|
|
|
187
187
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
188
188
|
* @returns {Promise<ConfigurationApplicationModel.OrderingStore>} - Success response
|
|
189
189
|
* @name getStoreDetailById
|
|
190
|
-
* @summary:
|
|
191
|
-
* @description: Retrieve
|
|
190
|
+
* @summary: Get a selling location
|
|
191
|
+
* @description: Retrieve detail of a selling location (store) by it's Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
|
|
192
192
|
*/
|
|
193
193
|
getStoreDetailById({ storeId, requestHeaders }?: ConfigurationApplicationValidator.GetStoreDetailByIdParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.OrderingStore>;
|
|
194
194
|
/**
|
|
@@ -201,8 +201,8 @@ declare class Configuration {
|
|
|
201
201
|
* - Success response
|
|
202
202
|
*
|
|
203
203
|
* @name removeOrderingStoreCookie
|
|
204
|
-
* @summary:
|
|
205
|
-
* @description:
|
|
204
|
+
* @summary: Delete store cookie
|
|
205
|
+
* @description: Remove store cookie - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
|
|
206
206
|
*/
|
|
207
207
|
removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.SuccessMessageResponse>;
|
|
208
208
|
}
|
|
@@ -58,8 +58,8 @@ class Configuration {
|
|
|
58
58
|
* @returns {Promise<ConfigurationApplicationModel.AppCurrencyResponse>} -
|
|
59
59
|
* Success response
|
|
60
60
|
* @name getAppCurrencies
|
|
61
|
-
* @summary:
|
|
62
|
-
* @description: Retrieve
|
|
61
|
+
* @summary: Get currency configuration
|
|
62
|
+
* @description: Retrieve currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
|
|
63
63
|
*/
|
|
64
64
|
async getAppCurrencies(
|
|
65
65
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -139,8 +139,8 @@ class Configuration {
|
|
|
139
139
|
* @returns {Promise<ConfigurationApplicationModel.AppStaffListResponse>} -
|
|
140
140
|
* Success response
|
|
141
141
|
* @name getAppStaffList
|
|
142
|
-
* @summary:
|
|
143
|
-
* @description: Retrieve a list of staff
|
|
142
|
+
* @summary: List staff members
|
|
143
|
+
* @description: Retrieve a list of all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
|
|
144
144
|
*/
|
|
145
145
|
async getAppStaffList(
|
|
146
146
|
{
|
|
@@ -234,8 +234,8 @@ class Configuration {
|
|
|
234
234
|
* @returns {Promise<ConfigurationApplicationModel.AppStaffResponse>} -
|
|
235
235
|
* Success response
|
|
236
236
|
* @name getAppStaffs
|
|
237
|
-
* @summary:
|
|
238
|
-
* @description: Retrieve a
|
|
237
|
+
* @summary: Get staff member
|
|
238
|
+
* @description: Retrieve 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://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
|
|
239
239
|
*/
|
|
240
240
|
async getAppStaffs(
|
|
241
241
|
{ orderIncent, orderingStore, user, requestHeaders } = {
|
|
@@ -317,8 +317,8 @@ class Configuration {
|
|
|
317
317
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
318
318
|
* @returns {Promise<ConfigurationApplicationModel.Application>} - Success response
|
|
319
319
|
* @name getApplication
|
|
320
|
-
* @summary:
|
|
321
|
-
* @description: Retrieve
|
|
320
|
+
* @summary: Get sales channel
|
|
321
|
+
* @description: Retrieve details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
|
|
322
322
|
*/
|
|
323
323
|
async getApplication(
|
|
324
324
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -398,8 +398,8 @@ class Configuration {
|
|
|
398
398
|
* @returns {Promise<ConfigurationApplicationModel.ApplicationDetail>} -
|
|
399
399
|
* Success response
|
|
400
400
|
* @name getBasicDetails
|
|
401
|
-
* @summary:
|
|
402
|
-
* @description: Retrieve
|
|
401
|
+
* @summary: Get Sales channel
|
|
402
|
+
* @description: Retrieve basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
|
|
403
403
|
*/
|
|
404
404
|
async getBasicDetails(
|
|
405
405
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -480,8 +480,8 @@ class Configuration {
|
|
|
480
480
|
* - Success response
|
|
481
481
|
*
|
|
482
482
|
* @name getContactInfo
|
|
483
|
-
* @summary:
|
|
484
|
-
* @description: Retrieve
|
|
483
|
+
* @summary: Get sales channel contact
|
|
484
|
+
* @description: Retrieve contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
|
|
485
485
|
*/
|
|
486
486
|
async getContactInfo(
|
|
487
487
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -561,8 +561,8 @@ class Configuration {
|
|
|
561
561
|
* @returns {Promise<ConfigurationApplicationModel.CurrenciesResponse>} -
|
|
562
562
|
* Success response
|
|
563
563
|
* @name getCurrencies
|
|
564
|
-
* @summary:
|
|
565
|
-
* @description: Retrieve a list of
|
|
564
|
+
* @summary: List currencies
|
|
565
|
+
* @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
|
|
566
566
|
*/
|
|
567
567
|
async getCurrencies(
|
|
568
568
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -641,8 +641,8 @@ class Configuration {
|
|
|
641
641
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
642
642
|
* @returns {Promise<ConfigurationApplicationModel.Currency>} - Success response
|
|
643
643
|
* @name getCurrencyById
|
|
644
|
-
* @summary:
|
|
645
|
-
* @description: Retrieve details of
|
|
644
|
+
* @summary: Get a currency
|
|
645
|
+
* @description: Retrieve details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
|
|
646
646
|
*/
|
|
647
647
|
async getCurrencyById(
|
|
648
648
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -722,8 +722,8 @@ class Configuration {
|
|
|
722
722
|
* @returns {Promise<ConfigurationApplicationModel.AppFeatureResponse>} -
|
|
723
723
|
* Success response
|
|
724
724
|
* @name getFeatures
|
|
725
|
-
* @summary:
|
|
726
|
-
* @description: Retrieve
|
|
725
|
+
* @summary: Get sales channel features
|
|
726
|
+
* @description: Retrieve configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
|
|
727
727
|
*/
|
|
728
728
|
async getFeatures(
|
|
729
729
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -803,8 +803,8 @@ class Configuration {
|
|
|
803
803
|
* @returns {Promise<ConfigurationApplicationModel.AppTokenResponse>} -
|
|
804
804
|
* Success response
|
|
805
805
|
* @name getIntegrationTokens
|
|
806
|
-
* @summary:
|
|
807
|
-
* @description: Retrieve the
|
|
806
|
+
* @summary: Get API tokens
|
|
807
|
+
* @description: Retrieve tools integration token of the sales channel. For ex- Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
|
|
808
808
|
*/
|
|
809
809
|
async getIntegrationTokens(
|
|
810
810
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -884,8 +884,8 @@ class Configuration {
|
|
|
884
884
|
* @returns {Promise<ConfigurationApplicationModel.LanguageResponse>} -
|
|
885
885
|
* Success response
|
|
886
886
|
* @name getLanguages
|
|
887
|
-
* @summary:
|
|
888
|
-
* @description:
|
|
887
|
+
* @summary: List languages
|
|
888
|
+
* @description: Retrieve a list of available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
|
|
889
889
|
*/
|
|
890
890
|
async getLanguages(
|
|
891
891
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -966,8 +966,8 @@ class Configuration {
|
|
|
966
966
|
* - Success response
|
|
967
967
|
*
|
|
968
968
|
* @name getOrderingStoreCookie
|
|
969
|
-
* @summary:
|
|
970
|
-
* @description:
|
|
969
|
+
* @summary: Create cookies
|
|
970
|
+
* @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
|
|
971
971
|
*/
|
|
972
972
|
async getOrderingStoreCookie(
|
|
973
973
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1046,8 +1046,8 @@ class Configuration {
|
|
|
1046
1046
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1047
1047
|
* @returns {Promise<ConfigurationApplicationModel.OrderingStores>} - Success response
|
|
1048
1048
|
* @name getOrderingStores
|
|
1049
|
-
* @summary:
|
|
1050
|
-
* @description: Retrieve
|
|
1049
|
+
* @summary: List order-enabled selling locations
|
|
1050
|
+
* @description: Retrieve details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
|
|
1051
1051
|
*/
|
|
1052
1052
|
async getOrderingStores(
|
|
1053
1053
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1131,8 +1131,8 @@ class Configuration {
|
|
|
1131
1131
|
* - Success response
|
|
1132
1132
|
*
|
|
1133
1133
|
* @name getOwnerInfo
|
|
1134
|
-
* @summary:
|
|
1135
|
-
* @description: Retrieve
|
|
1134
|
+
* @summary: Get sales channel owner
|
|
1135
|
+
* @description: Retrieve details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
|
|
1136
1136
|
*/
|
|
1137
1137
|
async getOwnerInfo(
|
|
1138
1138
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1210,8 +1210,8 @@ class Configuration {
|
|
|
1210
1210
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1211
1211
|
* @returns {Promise<ConfigurationApplicationModel.OrderingStore>} - Success response
|
|
1212
1212
|
* @name getStoreDetailById
|
|
1213
|
-
* @summary:
|
|
1214
|
-
* @description: Retrieve
|
|
1213
|
+
* @summary: Get a selling location
|
|
1214
|
+
* @description: Retrieve detail of a selling location (store) by it's Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
|
|
1215
1215
|
*/
|
|
1216
1216
|
async getStoreDetailById(
|
|
1217
1217
|
{ storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1294,8 +1294,8 @@ class Configuration {
|
|
|
1294
1294
|
* - Success response
|
|
1295
1295
|
*
|
|
1296
1296
|
* @name removeOrderingStoreCookie
|
|
1297
|
-
* @summary:
|
|
1298
|
-
* @description:
|
|
1297
|
+
* @summary: Delete store cookie
|
|
1298
|
+
* @description: Remove store cookie - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
|
|
1299
1299
|
*/
|
|
1300
1300
|
async removeOrderingStoreCookie(
|
|
1301
1301
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -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,8 +262,8 @@ 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
|
}
|