@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
|
@@ -9,8 +9,8 @@ declare class Configuration {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
|
|
11
11
|
* @name addDomain
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Create domain
|
|
13
|
+
* @description: Creates a domain for an sales channel. Note - Only 15 domains can be added to the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
|
|
14
14
|
*/
|
|
15
15
|
addDomain({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.AddDomainParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Domain>;
|
|
16
16
|
/**
|
|
@@ -21,7 +21,7 @@ declare class Configuration {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
23
23
|
* @name changeDomainType
|
|
24
|
-
* @summary:
|
|
24
|
+
* @summary: Update domain
|
|
25
25
|
* @description: Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/changeDomainType/).
|
|
26
26
|
*/
|
|
27
27
|
changeDomainType({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ChangeDomainTypeParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponse>;
|
|
@@ -33,7 +33,7 @@ declare class Configuration {
|
|
|
33
33
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
34
34
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
35
35
|
* @name getAppApiTokens
|
|
36
|
-
* @summary: Get
|
|
36
|
+
* @summary: Get sales channel API tokens
|
|
37
37
|
* @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
|
|
38
38
|
*/
|
|
39
39
|
getAppApiTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponse>;
|
|
@@ -45,7 +45,7 @@ declare class Configuration {
|
|
|
45
45
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
46
46
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
47
47
|
* @name getAppBasicDetails
|
|
48
|
-
* @summary: Get
|
|
48
|
+
* @summary: Get sales channel
|
|
49
49
|
* @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppBasicDetails/).
|
|
50
50
|
*/
|
|
51
51
|
getAppBasicDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
|
|
@@ -57,8 +57,8 @@ declare class Configuration {
|
|
|
57
57
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
58
58
|
* @returns {Promise<ConfigurationPlatformModel.CompaniesResponse>} - Success response
|
|
59
59
|
* @name getAppCompanies
|
|
60
|
-
* @summary:
|
|
61
|
-
* @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel
|
|
60
|
+
* @summary: List sales channel companies
|
|
61
|
+
* @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
|
|
62
62
|
*/
|
|
63
63
|
getAppCompanies({ uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppCompaniesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompaniesResponse>;
|
|
64
64
|
/**
|
|
@@ -70,8 +70,8 @@ declare class Configuration {
|
|
|
70
70
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
71
71
|
* Success response
|
|
72
72
|
* @name getAppContactInfo
|
|
73
|
-
* @summary: Get
|
|
74
|
-
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the
|
|
73
|
+
* @summary: Get sales channel contact
|
|
74
|
+
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
|
|
75
75
|
*/
|
|
76
76
|
getAppContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
77
77
|
/**
|
|
@@ -83,8 +83,8 @@ declare class Configuration {
|
|
|
83
83
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
84
84
|
* Success response
|
|
85
85
|
* @name getAppCurrencyConfig
|
|
86
|
-
* @summary: Get
|
|
87
|
-
* @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the
|
|
86
|
+
* @summary: Get sales channel currency configuration
|
|
87
|
+
* @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
|
|
88
88
|
*/
|
|
89
89
|
getAppCurrencyConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
90
90
|
/**
|
|
@@ -96,7 +96,7 @@ declare class Configuration {
|
|
|
96
96
|
* @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
|
|
97
97
|
* Success response
|
|
98
98
|
* @name getAppFeatures
|
|
99
|
-
* @summary: Get
|
|
99
|
+
* @summary: Get sales channel
|
|
100
100
|
* @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppFeatures/).
|
|
101
101
|
*/
|
|
102
102
|
getAppFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeatureResponse>;
|
|
@@ -108,8 +108,8 @@ declare class Configuration {
|
|
|
108
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
109
|
* @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
|
|
110
110
|
* @name getAppStores
|
|
111
|
-
* @summary:
|
|
112
|
-
* @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel
|
|
111
|
+
* @summary: list sales channel stores
|
|
112
|
+
* @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
|
|
113
113
|
*/
|
|
114
114
|
getAppStores({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetAppStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoresResponse>;
|
|
115
115
|
/**
|
|
@@ -121,8 +121,8 @@ declare class Configuration {
|
|
|
121
121
|
* @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
|
|
122
122
|
* Success response
|
|
123
123
|
* @name getAppSupportedCurrency
|
|
124
|
-
* @summary:
|
|
125
|
-
* @description: Retrieve a list of supported currencies for the
|
|
124
|
+
* @summary: List supported currencies
|
|
125
|
+
* @description: Retrieve a list of supported currencies for the sales channel. A list of currencies allowed in the current sales channel. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppSupportedCurrency/).
|
|
126
126
|
*/
|
|
127
127
|
getAppSupportedCurrency({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppCurrencyResponse>;
|
|
128
128
|
/**
|
|
@@ -133,8 +133,8 @@ declare class Configuration {
|
|
|
133
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
134
134
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
|
|
135
135
|
* @name getApplicationById
|
|
136
|
-
* @summary: Get
|
|
137
|
-
* @description: Retrieve detailed information about a specific
|
|
136
|
+
* @summary: Get sales channel by id
|
|
137
|
+
* @description: Retrieve detailed information about a specific sales channel. Use sales channel ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplicationById/).
|
|
138
138
|
*/
|
|
139
139
|
getApplicationById({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationById>;
|
|
140
140
|
/**
|
|
@@ -146,7 +146,7 @@ declare class Configuration {
|
|
|
146
146
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
147
147
|
* Success response
|
|
148
148
|
* @name getBuildConfig
|
|
149
|
-
* @summary: Get
|
|
149
|
+
* @summary: Get Build Configuration
|
|
150
150
|
* @description: Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBuildConfig/).
|
|
151
151
|
*/
|
|
152
152
|
getBuildConfig({ platformType, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetBuildConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.MobileAppConfiguration>;
|
|
@@ -169,8 +169,8 @@ declare class Configuration {
|
|
|
169
169
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
170
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
171
171
|
* @name getDomains
|
|
172
|
-
* @summary:
|
|
173
|
-
* @description:
|
|
172
|
+
* @summary: List domains
|
|
173
|
+
* @description: Retrieve a list of existing domains by its sales channel id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
174
174
|
*/
|
|
175
175
|
getDomains({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainsResponse>;
|
|
176
176
|
/**
|
|
@@ -196,7 +196,7 @@ declare class Configuration {
|
|
|
196
196
|
* Success response
|
|
197
197
|
* @name getOrderingStoreConfig
|
|
198
198
|
* @summary: Get ordering store configuration
|
|
199
|
-
* @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the
|
|
199
|
+
* @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
|
|
200
200
|
*/
|
|
201
201
|
getOrderingStoreConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoreConfig>;
|
|
202
202
|
/**
|
|
@@ -208,7 +208,7 @@ declare class Configuration {
|
|
|
208
208
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
209
209
|
* Success response
|
|
210
210
|
* @name getOrderingStoreCookie
|
|
211
|
-
* @summary: Get
|
|
211
|
+
* @summary: Get ordering store signed cookie
|
|
212
212
|
* @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
|
|
213
213
|
*/
|
|
214
214
|
getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
@@ -220,8 +220,8 @@ declare class Configuration {
|
|
|
220
220
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
221
221
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
|
|
222
222
|
* @name getOrderingStoresByFilter
|
|
223
|
-
* @summary:
|
|
224
|
-
* @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the
|
|
223
|
+
* @summary: List ordering stores
|
|
224
|
+
* @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoresByFilter/).
|
|
225
225
|
*/
|
|
226
226
|
getOrderingStoresByFilter({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetOrderingStoresByFilterParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStores>;
|
|
227
227
|
/**
|
|
@@ -247,7 +247,7 @@ declare class Configuration {
|
|
|
247
247
|
* Success response
|
|
248
248
|
* @name getStaffOrderingStores
|
|
249
249
|
* @summary: Get staff ordering stores
|
|
250
|
-
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the
|
|
250
|
+
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
|
|
251
251
|
*/
|
|
252
252
|
getStaffOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoresResponse>;
|
|
253
253
|
/**
|
|
@@ -258,8 +258,8 @@ declare class Configuration {
|
|
|
258
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
259
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
260
260
|
* @name modifyAppFeatures
|
|
261
|
-
* @summary:
|
|
262
|
-
* @description:
|
|
261
|
+
* @summary: update sales channel features
|
|
262
|
+
* @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
|
|
263
263
|
*/
|
|
264
264
|
modifyAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
265
265
|
/**
|
|
@@ -272,7 +272,7 @@ declare class Configuration {
|
|
|
272
272
|
* Success response
|
|
273
273
|
* @name partiallyUpdateInventoryConfig
|
|
274
274
|
* @summary: Partially update inventory configuration
|
|
275
|
-
* @description:
|
|
275
|
+
* @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
|
|
276
276
|
*/
|
|
277
277
|
partiallyUpdateInventoryConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.PartiallyUpdateInventoryConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInventory>;
|
|
278
278
|
/**
|
|
@@ -284,8 +284,8 @@ declare class Configuration {
|
|
|
284
284
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
285
285
|
* Success response
|
|
286
286
|
* @name removeDomainById
|
|
287
|
-
* @summary: Remove domain
|
|
288
|
-
* @description: Delete a specific domain from the
|
|
287
|
+
* @summary: Remove domain
|
|
288
|
+
* @description: Delete a specific domain from the sales channel. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
|
|
289
289
|
*/
|
|
290
290
|
removeDomainById({ id, requestHeaders }?: ConfigurationPlatformApplicationValidator.RemoveDomainByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
291
291
|
/**
|
|
@@ -297,7 +297,7 @@ declare class Configuration {
|
|
|
297
297
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
298
298
|
* Success response
|
|
299
299
|
* @name removeOrderingStoreCookie
|
|
300
|
-
* @summary:
|
|
300
|
+
* @summary: Delete Ordering Store signed cookie
|
|
301
301
|
* @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
|
|
302
302
|
*/
|
|
303
303
|
removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
@@ -309,8 +309,8 @@ declare class Configuration {
|
|
|
309
309
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
310
310
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
311
311
|
* @name updateAppApiTokens
|
|
312
|
-
* @summary: Update
|
|
313
|
-
* @description: Add
|
|
312
|
+
* @summary: Update sales channel API tokens
|
|
313
|
+
* @description: Add and edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppApiTokens/).
|
|
314
314
|
*/
|
|
315
315
|
updateAppApiTokens({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppApiTokensParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.TokenResponse>;
|
|
316
316
|
/**
|
|
@@ -321,7 +321,7 @@ declare class Configuration {
|
|
|
321
321
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
322
322
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
323
323
|
* @name updateAppBasicDetails
|
|
324
|
-
* @summary: Update
|
|
324
|
+
* @summary: Update sales channel basic details
|
|
325
325
|
* @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppBasicDetails/).
|
|
326
326
|
*/
|
|
327
327
|
updateAppBasicDetails({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppBasicDetailsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationDetail>;
|
|
@@ -334,8 +334,8 @@ declare class Configuration {
|
|
|
334
334
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
335
335
|
* Success response
|
|
336
336
|
* @name updateAppContactInfo
|
|
337
|
-
* @summary: Update
|
|
338
|
-
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the
|
|
337
|
+
* @summary: Update sales channel contact
|
|
338
|
+
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
|
|
339
339
|
*/
|
|
340
340
|
updateAppContactInfo({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppContactInfoParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationInformation>;
|
|
341
341
|
/**
|
|
@@ -347,8 +347,8 @@ declare class Configuration {
|
|
|
347
347
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
348
348
|
* Success response
|
|
349
349
|
* @name updateAppCurrencyConfig
|
|
350
|
-
* @summary: Update
|
|
351
|
-
* @description: Modify currency configuration settings for the
|
|
350
|
+
* @summary: Update sales channel currency configuration
|
|
351
|
+
* @description: Modify currency configuration settings for the sales channel. Add and edit the currencies supported in the sales channel. Initially, INR will be enabled by default. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppCurrencyConfig/).
|
|
352
352
|
*/
|
|
353
353
|
updateAppCurrencyConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppCurrencyConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppSupportedCurrency>;
|
|
354
354
|
/**
|
|
@@ -359,7 +359,7 @@ declare class Configuration {
|
|
|
359
359
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
360
360
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
361
361
|
* @name updateAppFeatures
|
|
362
|
-
* @summary: Update
|
|
362
|
+
* @summary: Update sales channel
|
|
363
363
|
* @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppFeatures/).
|
|
364
364
|
*/
|
|
365
365
|
updateAppFeatures({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateAppFeaturesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.AppFeature>;
|
|
@@ -398,7 +398,7 @@ declare class Configuration {
|
|
|
398
398
|
* @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
|
|
399
399
|
* @name updateOrderingStoreConfig
|
|
400
400
|
* @summary: Update ordering store configuration
|
|
401
|
-
* @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the
|
|
401
|
+
* @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
|
|
402
402
|
*/
|
|
403
403
|
updateOrderingStoreConfig({ body, requestHeaders }?: ConfigurationPlatformApplicationValidator.UpdateOrderingStoreConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DeploymentMeta>;
|
|
404
404
|
}
|
|
@@ -21,8 +21,8 @@ class Configuration {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
|
|
23
23
|
* @name addDomain
|
|
24
|
-
* @summary:
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Create domain
|
|
25
|
+
* @description: Creates a domain for an sales channel. Note - Only 15 domains can be added to the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
|
|
26
26
|
*/
|
|
27
27
|
async addDomain(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -102,7 +102,7 @@ class Configuration {
|
|
|
102
102
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
103
103
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
104
104
|
* @name changeDomainType
|
|
105
|
-
* @summary:
|
|
105
|
+
* @summary: Update domain
|
|
106
106
|
* @description: Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/changeDomainType/).
|
|
107
107
|
*/
|
|
108
108
|
async changeDomainType(
|
|
@@ -183,7 +183,7 @@ class Configuration {
|
|
|
183
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
184
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
185
185
|
* @name getAppApiTokens
|
|
186
|
-
* @summary: Get
|
|
186
|
+
* @summary: Get sales channel API tokens
|
|
187
187
|
* @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
|
|
188
188
|
*/
|
|
189
189
|
async getAppApiTokens(
|
|
@@ -260,7 +260,7 @@ class Configuration {
|
|
|
260
260
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
261
261
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
262
262
|
* @name getAppBasicDetails
|
|
263
|
-
* @summary: Get
|
|
263
|
+
* @summary: Get sales channel
|
|
264
264
|
* @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppBasicDetails/).
|
|
265
265
|
*/
|
|
266
266
|
async getAppBasicDetails(
|
|
@@ -337,8 +337,8 @@ class Configuration {
|
|
|
337
337
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
338
338
|
* @returns {Promise<ConfigurationPlatformModel.CompaniesResponse>} - Success response
|
|
339
339
|
* @name getAppCompanies
|
|
340
|
-
* @summary:
|
|
341
|
-
* @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel
|
|
340
|
+
* @summary: List sales channel companies
|
|
341
|
+
* @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
|
|
342
342
|
*/
|
|
343
343
|
async getAppCompanies(
|
|
344
344
|
{ uid, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -426,8 +426,8 @@ class Configuration {
|
|
|
426
426
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
427
427
|
* Success response
|
|
428
428
|
* @name getAppContactInfo
|
|
429
|
-
* @summary: Get
|
|
430
|
-
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the
|
|
429
|
+
* @summary: Get sales channel contact
|
|
430
|
+
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
|
|
431
431
|
*/
|
|
432
432
|
async getAppContactInfo(
|
|
433
433
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -504,8 +504,8 @@ class Configuration {
|
|
|
504
504
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
505
505
|
* Success response
|
|
506
506
|
* @name getAppCurrencyConfig
|
|
507
|
-
* @summary: Get
|
|
508
|
-
* @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the
|
|
507
|
+
* @summary: Get sales channel currency configuration
|
|
508
|
+
* @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
|
|
509
509
|
*/
|
|
510
510
|
async getAppCurrencyConfig(
|
|
511
511
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -582,7 +582,7 @@ class Configuration {
|
|
|
582
582
|
* @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
|
|
583
583
|
* Success response
|
|
584
584
|
* @name getAppFeatures
|
|
585
|
-
* @summary: Get
|
|
585
|
+
* @summary: Get sales channel
|
|
586
586
|
* @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppFeatures/).
|
|
587
587
|
*/
|
|
588
588
|
async getAppFeatures(
|
|
@@ -659,8 +659,8 @@ class Configuration {
|
|
|
659
659
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
660
660
|
* @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
|
|
661
661
|
* @name getAppStores
|
|
662
|
-
* @summary:
|
|
663
|
-
* @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel
|
|
662
|
+
* @summary: list sales channel stores
|
|
663
|
+
* @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
|
|
664
664
|
*/
|
|
665
665
|
async getAppStores(
|
|
666
666
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -745,8 +745,8 @@ class Configuration {
|
|
|
745
745
|
* @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
|
|
746
746
|
* Success response
|
|
747
747
|
* @name getAppSupportedCurrency
|
|
748
|
-
* @summary:
|
|
749
|
-
* @description: Retrieve a list of supported currencies for the
|
|
748
|
+
* @summary: List supported currencies
|
|
749
|
+
* @description: Retrieve a list of supported currencies for the sales channel. A list of currencies allowed in the current sales channel. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppSupportedCurrency/).
|
|
750
750
|
*/
|
|
751
751
|
async getAppSupportedCurrency(
|
|
752
752
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -822,8 +822,8 @@ class Configuration {
|
|
|
822
822
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
823
823
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
|
|
824
824
|
* @name getApplicationById
|
|
825
|
-
* @summary: Get
|
|
826
|
-
* @description: Retrieve detailed information about a specific
|
|
825
|
+
* @summary: Get sales channel by id
|
|
826
|
+
* @description: Retrieve detailed information about a specific sales channel. Use sales channel ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplicationById/).
|
|
827
827
|
*/
|
|
828
828
|
async getApplicationById(
|
|
829
829
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -900,7 +900,7 @@ class Configuration {
|
|
|
900
900
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
901
901
|
* Success response
|
|
902
902
|
* @name getBuildConfig
|
|
903
|
-
* @summary: Get
|
|
903
|
+
* @summary: Get Build Configuration
|
|
904
904
|
* @description: Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBuildConfig/).
|
|
905
905
|
*/
|
|
906
906
|
async getBuildConfig(
|
|
@@ -1061,8 +1061,8 @@ class Configuration {
|
|
|
1061
1061
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1062
1062
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
1063
1063
|
* @name getDomains
|
|
1064
|
-
* @summary:
|
|
1065
|
-
* @description:
|
|
1064
|
+
* @summary: List domains
|
|
1065
|
+
* @description: Retrieve a list of existing domains by its sales channel id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
1066
1066
|
*/
|
|
1067
1067
|
async getDomains(
|
|
1068
1068
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1218,7 +1218,7 @@ class Configuration {
|
|
|
1218
1218
|
* Success response
|
|
1219
1219
|
* @name getOrderingStoreConfig
|
|
1220
1220
|
* @summary: Get ordering store configuration
|
|
1221
|
-
* @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the
|
|
1221
|
+
* @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
|
|
1222
1222
|
*/
|
|
1223
1223
|
async getOrderingStoreConfig(
|
|
1224
1224
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1295,7 +1295,7 @@ class Configuration {
|
|
|
1295
1295
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1296
1296
|
* Success response
|
|
1297
1297
|
* @name getOrderingStoreCookie
|
|
1298
|
-
* @summary: Get
|
|
1298
|
+
* @summary: Get ordering store signed cookie
|
|
1299
1299
|
* @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
|
|
1300
1300
|
*/
|
|
1301
1301
|
async getOrderingStoreCookie(
|
|
@@ -1376,8 +1376,8 @@ class Configuration {
|
|
|
1376
1376
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1377
1377
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
|
|
1378
1378
|
* @name getOrderingStoresByFilter
|
|
1379
|
-
* @summary:
|
|
1380
|
-
* @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the
|
|
1379
|
+
* @summary: List ordering stores
|
|
1380
|
+
* @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoresByFilter/).
|
|
1381
1381
|
*/
|
|
1382
1382
|
async getOrderingStoresByFilter(
|
|
1383
1383
|
{ body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1547,7 +1547,7 @@ class Configuration {
|
|
|
1547
1547
|
* Success response
|
|
1548
1548
|
* @name getStaffOrderingStores
|
|
1549
1549
|
* @summary: Get staff ordering stores
|
|
1550
|
-
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the
|
|
1550
|
+
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
|
|
1551
1551
|
*/
|
|
1552
1552
|
async getStaffOrderingStores(
|
|
1553
1553
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1634,8 +1634,8 @@ class Configuration {
|
|
|
1634
1634
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1635
1635
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
1636
1636
|
* @name modifyAppFeatures
|
|
1637
|
-
* @summary:
|
|
1638
|
-
* @description:
|
|
1637
|
+
* @summary: update sales channel features
|
|
1638
|
+
* @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
|
|
1639
1639
|
*/
|
|
1640
1640
|
async modifyAppFeatures(
|
|
1641
1641
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1717,7 +1717,7 @@ class Configuration {
|
|
|
1717
1717
|
* Success response
|
|
1718
1718
|
* @name partiallyUpdateInventoryConfig
|
|
1719
1719
|
* @summary: Partially update inventory configuration
|
|
1720
|
-
* @description:
|
|
1720
|
+
* @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
|
|
1721
1721
|
*/
|
|
1722
1722
|
async partiallyUpdateInventoryConfig(
|
|
1723
1723
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1798,8 +1798,8 @@ class Configuration {
|
|
|
1798
1798
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1799
1799
|
* Success response
|
|
1800
1800
|
* @name removeDomainById
|
|
1801
|
-
* @summary: Remove domain
|
|
1802
|
-
* @description: Delete a specific domain from the
|
|
1801
|
+
* @summary: Remove domain
|
|
1802
|
+
* @description: Delete a specific domain from the sales channel. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
|
|
1803
1803
|
*/
|
|
1804
1804
|
async removeDomainById(
|
|
1805
1805
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1880,7 +1880,7 @@ class Configuration {
|
|
|
1880
1880
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1881
1881
|
* Success response
|
|
1882
1882
|
* @name removeOrderingStoreCookie
|
|
1883
|
-
* @summary:
|
|
1883
|
+
* @summary: Delete Ordering Store signed cookie
|
|
1884
1884
|
* @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
|
|
1885
1885
|
*/
|
|
1886
1886
|
async removeOrderingStoreCookie(
|
|
@@ -1957,8 +1957,8 @@ class Configuration {
|
|
|
1957
1957
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1958
1958
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
1959
1959
|
* @name updateAppApiTokens
|
|
1960
|
-
* @summary: Update
|
|
1961
|
-
* @description: Add
|
|
1960
|
+
* @summary: Update sales channel API tokens
|
|
1961
|
+
* @description: Add and edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppApiTokens/).
|
|
1962
1962
|
*/
|
|
1963
1963
|
async updateAppApiTokens(
|
|
1964
1964
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2038,7 +2038,7 @@ class Configuration {
|
|
|
2038
2038
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2039
2039
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
|
|
2040
2040
|
* @name updateAppBasicDetails
|
|
2041
|
-
* @summary: Update
|
|
2041
|
+
* @summary: Update sales channel basic details
|
|
2042
2042
|
* @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppBasicDetails/).
|
|
2043
2043
|
*/
|
|
2044
2044
|
async updateAppBasicDetails(
|
|
@@ -2120,8 +2120,8 @@ class Configuration {
|
|
|
2120
2120
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
2121
2121
|
* Success response
|
|
2122
2122
|
* @name updateAppContactInfo
|
|
2123
|
-
* @summary: Update
|
|
2124
|
-
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the
|
|
2123
|
+
* @summary: Update sales channel contact
|
|
2124
|
+
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
|
|
2125
2125
|
*/
|
|
2126
2126
|
async updateAppContactInfo(
|
|
2127
2127
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2202,8 +2202,8 @@ class Configuration {
|
|
|
2202
2202
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
2203
2203
|
* Success response
|
|
2204
2204
|
* @name updateAppCurrencyConfig
|
|
2205
|
-
* @summary: Update
|
|
2206
|
-
* @description: Modify currency configuration settings for the
|
|
2205
|
+
* @summary: Update sales channel currency configuration
|
|
2206
|
+
* @description: Modify currency configuration settings for the sales channel. Add and edit the currencies supported in the sales channel. Initially, INR will be enabled by default. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppCurrencyConfig/).
|
|
2207
2207
|
*/
|
|
2208
2208
|
async updateAppCurrencyConfig(
|
|
2209
2209
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2283,7 +2283,7 @@ class Configuration {
|
|
|
2283
2283
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2284
2284
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
2285
2285
|
* @name updateAppFeatures
|
|
2286
|
-
* @summary: Update
|
|
2286
|
+
* @summary: Update sales channel
|
|
2287
2287
|
* @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppFeatures/).
|
|
2288
2288
|
*/
|
|
2289
2289
|
async updateAppFeatures(
|
|
@@ -2531,7 +2531,7 @@ class Configuration {
|
|
|
2531
2531
|
* @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
|
|
2532
2532
|
* @name updateOrderingStoreConfig
|
|
2533
2533
|
* @summary: Update ordering store configuration
|
|
2534
|
-
* @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the
|
|
2534
|
+
* @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
|
|
2535
2535
|
*/
|
|
2536
2536
|
async updateOrderingStoreConfig(
|
|
2537
2537
|
{ body, requestHeaders } = { requestHeaders: {} },
|