@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
|
@@ -8,8 +8,8 @@ declare class Configuration {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<ConfigurationPlatformModel.CreateAppResponse>} - Success response
|
|
10
10
|
* @name createApplication
|
|
11
|
-
* @summary: Create
|
|
12
|
-
* @description: Generate and add a new
|
|
11
|
+
* @summary: Create sales channel
|
|
12
|
+
* @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
|
|
13
13
|
*/
|
|
14
14
|
createApplication({ body, requestHeaders }?: ConfigurationPlatformValidator.CreateApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CreateAppResponse>;
|
|
15
15
|
/**
|
|
@@ -19,8 +19,8 @@ declare class Configuration {
|
|
|
19
19
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
|
|
20
20
|
* Success response
|
|
21
21
|
* @name getApplications
|
|
22
|
-
* @summary:
|
|
23
|
-
* @description: Retrieve a list of available
|
|
22
|
+
* @summary: List sales channel stores
|
|
23
|
+
* @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
|
|
24
24
|
*/
|
|
25
25
|
getApplications({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformValidator.GetApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationsResponse>;
|
|
26
26
|
/**
|
|
@@ -31,8 +31,8 @@ declare class Configuration {
|
|
|
31
31
|
* - Success response
|
|
32
32
|
*
|
|
33
33
|
* @name getAvailableOptIns
|
|
34
|
-
* @summary:
|
|
35
|
-
* @description: Retrieve a list of available opt-ins. Retrieve a list of all available integrations in a company.
|
|
34
|
+
* @summary: List available opt-ins
|
|
35
|
+
* @description: Retrieve a list of available opt-ins. Retrieve a list of all available integrations in a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
|
|
36
36
|
*/
|
|
37
37
|
getAvailableOptIns({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetAvailableOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
|
|
38
38
|
/**
|
|
@@ -42,8 +42,8 @@ declare class Configuration {
|
|
|
42
42
|
* @returns {Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>} -
|
|
43
43
|
* Success response
|
|
44
44
|
* @name getBrandsByCompany
|
|
45
|
-
* @summary:
|
|
46
|
-
* @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
|
|
45
|
+
* @summary: List brands by company
|
|
46
|
+
* @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
|
|
47
47
|
*/
|
|
48
48
|
getBrandsByCompany({ q, requestHeaders }?: ConfigurationPlatformValidator.GetBrandsByCompanyParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>;
|
|
49
49
|
/**
|
|
@@ -53,8 +53,8 @@ declare class Configuration {
|
|
|
53
53
|
* @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
|
|
54
54
|
* Success response
|
|
55
55
|
* @name getCompanyByBrands
|
|
56
|
-
* @summary:
|
|
57
|
-
* @description: Retrieve companies associated with specific brands.
|
|
56
|
+
* @summary: List companies by brand
|
|
57
|
+
* @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
|
|
58
58
|
*/
|
|
59
59
|
getCompanyByBrands({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetCompanyByBrandsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>;
|
|
60
60
|
/**
|
|
@@ -64,8 +64,8 @@ declare class Configuration {
|
|
|
64
64
|
* @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
|
|
65
65
|
* Success response
|
|
66
66
|
* @name getCurrencies
|
|
67
|
-
* @summary:
|
|
68
|
-
* @description: Retrieve a list of available currencies.
|
|
67
|
+
* @summary: List currencies
|
|
68
|
+
* @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
|
|
69
69
|
*/
|
|
70
70
|
getCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CurrenciesResponse>;
|
|
71
71
|
/**
|
|
@@ -76,8 +76,8 @@ declare class Configuration {
|
|
|
76
76
|
* - Success response
|
|
77
77
|
*
|
|
78
78
|
* @name getDomainAvailibility
|
|
79
|
-
* @summary:
|
|
80
|
-
* @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to
|
|
79
|
+
* @summary: List suggestion domain
|
|
80
|
+
* @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
|
|
81
81
|
*/
|
|
82
82
|
getDomainAvailibility({ body, requestHeaders }?: ConfigurationPlatformValidator.GetDomainAvailibilityParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainSuggestionsResponse>;
|
|
83
83
|
/**
|
|
@@ -86,7 +86,7 @@ declare class Configuration {
|
|
|
86
86
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
87
87
|
* @returns {Promise<ConfigurationPlatformModel.Integration>} - Success response
|
|
88
88
|
* @name getIntegrationById
|
|
89
|
-
* @summary: Get integration by
|
|
89
|
+
* @summary: Get integration by Id
|
|
90
90
|
* @description: Retrieve detailed information about a specific integration. Retrieve the details of an integration (such as Ginesys, SAP, etc.) using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
|
|
91
91
|
*/
|
|
92
92
|
getIntegrationById({ id, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Integration>;
|
|
@@ -98,7 +98,7 @@ declare class Configuration {
|
|
|
98
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
100
100
|
* @name getIntegrationByLevelId
|
|
101
|
-
* @summary: Get integration
|
|
101
|
+
* @summary: Get integration Id
|
|
102
102
|
* @description: Retrieve integration details for a specific level. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
|
|
103
103
|
*/
|
|
104
104
|
getIntegrationByLevelId({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByLevelIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
|
|
@@ -112,7 +112,7 @@ declare class Configuration {
|
|
|
112
112
|
* - Success response
|
|
113
113
|
*
|
|
114
114
|
* @name getIntegrationLevelConfig
|
|
115
|
-
* @summary: Get
|
|
115
|
+
* @summary: Get level configuration
|
|
116
116
|
* @description: Retrieve configuration settings for integration levels. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
|
|
117
117
|
*/
|
|
118
118
|
getIntegrationLevelConfig({ id, level, opted, checkPermission, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationLevelConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationConfigResponse>;
|
|
@@ -125,7 +125,7 @@ declare class Configuration {
|
|
|
125
125
|
* @returns {Promise<ConfigurationPlatformModel.OptedStoreIntegration>} -
|
|
126
126
|
* Success response
|
|
127
127
|
* @name getLevelActiveIntegrations
|
|
128
|
-
* @summary: Get active integrations
|
|
128
|
+
* @summary: Get active integrations
|
|
129
129
|
* @description: Check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
|
|
130
130
|
*/
|
|
131
131
|
getLevelActiveIntegrations({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OptedStoreIntegration>;
|
|
@@ -139,8 +139,8 @@ declare class Configuration {
|
|
|
139
139
|
* - Success response
|
|
140
140
|
*
|
|
141
141
|
* @name getOtherSellerApplicationById
|
|
142
|
-
* @summary: Get
|
|
143
|
-
* @description: Retrieve details of a seller
|
|
142
|
+
* @summary: Get others sales. channel
|
|
143
|
+
* @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
|
|
144
144
|
*/
|
|
145
145
|
getOtherSellerApplicationById({ id, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OptedApplicationResponse>;
|
|
146
146
|
/**
|
|
@@ -152,8 +152,8 @@ declare class Configuration {
|
|
|
152
152
|
* @returns {Promise<ConfigurationPlatformModel.OtherSellerApplications>} -
|
|
153
153
|
* Success response
|
|
154
154
|
* @name getOtherSellerApplications
|
|
155
|
-
* @summary: Get other
|
|
156
|
-
* @description: Retrieve
|
|
155
|
+
* @summary: Get other sales channel
|
|
156
|
+
* @description: Retrieve sales channels of other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
|
|
157
157
|
*/
|
|
158
158
|
getOtherSellerApplications({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OtherSellerApplications>;
|
|
159
159
|
/**
|
|
@@ -164,7 +164,7 @@ declare class Configuration {
|
|
|
164
164
|
* - Success response
|
|
165
165
|
*
|
|
166
166
|
* @name getSelectedOptIns
|
|
167
|
-
* @summary:
|
|
167
|
+
* @summary: List selected opt-in
|
|
168
168
|
* @description: Retrieve a list of selected opt-ins. Retrieve the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
|
|
169
169
|
*/
|
|
170
170
|
getSelectedOptIns({ level, uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetSelectedOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
|
|
@@ -176,7 +176,7 @@ declare class Configuration {
|
|
|
176
176
|
* Success response
|
|
177
177
|
* @name getStoreByBrands
|
|
178
178
|
* @summary: Get store by brands
|
|
179
|
-
* @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
|
|
179
|
+
* @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
|
|
180
180
|
*/
|
|
181
181
|
getStoreByBrands({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetStoreByBrandsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoreByBrandsResponse>;
|
|
182
182
|
/**
|
|
@@ -186,8 +186,8 @@ declare class Configuration {
|
|
|
186
186
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
187
187
|
* Success response
|
|
188
188
|
* @name optOutFromApplication
|
|
189
|
-
* @summary:
|
|
190
|
-
* @description:
|
|
189
|
+
* @summary: opt out of marketplaces
|
|
190
|
+
* @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
|
|
191
191
|
*/
|
|
192
192
|
optOutFromApplication({ id, body, requestHeaders }?: ConfigurationPlatformValidator.OptOutFromApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
|
|
193
193
|
/**
|
|
@@ -20,8 +20,8 @@ class Configuration {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ConfigurationPlatformModel.CreateAppResponse>} - Success response
|
|
22
22
|
* @name createApplication
|
|
23
|
-
* @summary: Create
|
|
24
|
-
* @description: Generate and add a new
|
|
23
|
+
* @summary: Create sales channel
|
|
24
|
+
* @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
|
|
25
25
|
*/
|
|
26
26
|
async createApplication(
|
|
27
27
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -102,8 +102,8 @@ class Configuration {
|
|
|
102
102
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
|
|
103
103
|
* Success response
|
|
104
104
|
* @name getApplications
|
|
105
|
-
* @summary:
|
|
106
|
-
* @description: Retrieve a list of available
|
|
105
|
+
* @summary: List sales channel stores
|
|
106
|
+
* @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
|
|
107
107
|
*/
|
|
108
108
|
async getApplications(
|
|
109
109
|
{ pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -190,8 +190,8 @@ class Configuration {
|
|
|
190
190
|
* - Success response
|
|
191
191
|
*
|
|
192
192
|
* @name getAvailableOptIns
|
|
193
|
-
* @summary:
|
|
194
|
-
* @description: Retrieve a list of available opt-ins. Retrieve a list of all available integrations in a company.
|
|
193
|
+
* @summary: List available opt-ins
|
|
194
|
+
* @description: Retrieve a list of available opt-ins. Retrieve a list of all available integrations in a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
|
|
195
195
|
*/
|
|
196
196
|
async getAvailableOptIns(
|
|
197
197
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -276,8 +276,8 @@ class Configuration {
|
|
|
276
276
|
* @returns {Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>} -
|
|
277
277
|
* Success response
|
|
278
278
|
* @name getBrandsByCompany
|
|
279
|
-
* @summary:
|
|
280
|
-
* @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
|
|
279
|
+
* @summary: List brands by company
|
|
280
|
+
* @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
|
|
281
281
|
*/
|
|
282
282
|
async getBrandsByCompany(
|
|
283
283
|
{ q, requestHeaders } = { requestHeaders: {} },
|
|
@@ -359,8 +359,8 @@ class Configuration {
|
|
|
359
359
|
* @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
|
|
360
360
|
* Success response
|
|
361
361
|
* @name getCompanyByBrands
|
|
362
|
-
* @summary:
|
|
363
|
-
* @description: Retrieve companies associated with specific brands.
|
|
362
|
+
* @summary: List companies by brand
|
|
363
|
+
* @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
|
|
364
364
|
*/
|
|
365
365
|
async getCompanyByBrands(
|
|
366
366
|
{ body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -447,8 +447,8 @@ class Configuration {
|
|
|
447
447
|
* @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
|
|
448
448
|
* Success response
|
|
449
449
|
* @name getCurrencies
|
|
450
|
-
* @summary:
|
|
451
|
-
* @description: Retrieve a list of available currencies.
|
|
450
|
+
* @summary: List currencies
|
|
451
|
+
* @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
|
|
452
452
|
*/
|
|
453
453
|
async getCurrencies(
|
|
454
454
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -524,8 +524,8 @@ class Configuration {
|
|
|
524
524
|
* - Success response
|
|
525
525
|
*
|
|
526
526
|
* @name getDomainAvailibility
|
|
527
|
-
* @summary:
|
|
528
|
-
* @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to
|
|
527
|
+
* @summary: List suggestion domain
|
|
528
|
+
* @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
|
|
529
529
|
*/
|
|
530
530
|
async getDomainAvailibility(
|
|
531
531
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -605,7 +605,7 @@ class Configuration {
|
|
|
605
605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
606
606
|
* @returns {Promise<ConfigurationPlatformModel.Integration>} - Success response
|
|
607
607
|
* @name getIntegrationById
|
|
608
|
-
* @summary: Get integration by
|
|
608
|
+
* @summary: Get integration by Id
|
|
609
609
|
* @description: Retrieve detailed information about a specific integration. Retrieve the details of an integration (such as Ginesys, SAP, etc.) using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
|
|
610
610
|
*/
|
|
611
611
|
async getIntegrationById(
|
|
@@ -688,7 +688,7 @@ class Configuration {
|
|
|
688
688
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
689
689
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
690
690
|
* @name getIntegrationByLevelId
|
|
691
|
-
* @summary: Get integration
|
|
691
|
+
* @summary: Get integration Id
|
|
692
692
|
* @description: Retrieve integration details for a specific level. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
|
|
693
693
|
*/
|
|
694
694
|
async getIntegrationByLevelId(
|
|
@@ -777,7 +777,7 @@ class Configuration {
|
|
|
777
777
|
* - Success response
|
|
778
778
|
*
|
|
779
779
|
* @name getIntegrationLevelConfig
|
|
780
|
-
* @summary: Get
|
|
780
|
+
* @summary: Get level configuration
|
|
781
781
|
* @description: Retrieve configuration settings for integration levels. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
|
|
782
782
|
*/
|
|
783
783
|
async getIntegrationLevelConfig(
|
|
@@ -871,7 +871,7 @@ class Configuration {
|
|
|
871
871
|
* @returns {Promise<ConfigurationPlatformModel.OptedStoreIntegration>} -
|
|
872
872
|
* Success response
|
|
873
873
|
* @name getLevelActiveIntegrations
|
|
874
|
-
* @summary: Get active integrations
|
|
874
|
+
* @summary: Get active integrations
|
|
875
875
|
* @description: Check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
|
|
876
876
|
*/
|
|
877
877
|
async getLevelActiveIntegrations(
|
|
@@ -960,8 +960,8 @@ class Configuration {
|
|
|
960
960
|
* - Success response
|
|
961
961
|
*
|
|
962
962
|
* @name getOtherSellerApplicationById
|
|
963
|
-
* @summary: Get
|
|
964
|
-
* @description: Retrieve details of a seller
|
|
963
|
+
* @summary: Get others sales. channel
|
|
964
|
+
* @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
|
|
965
965
|
*/
|
|
966
966
|
async getOtherSellerApplicationById(
|
|
967
967
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1044,8 +1044,8 @@ class Configuration {
|
|
|
1044
1044
|
* @returns {Promise<ConfigurationPlatformModel.OtherSellerApplications>} -
|
|
1045
1045
|
* Success response
|
|
1046
1046
|
* @name getOtherSellerApplications
|
|
1047
|
-
* @summary: Get other
|
|
1048
|
-
* @description: Retrieve
|
|
1047
|
+
* @summary: Get other sales channel
|
|
1048
|
+
* @description: Retrieve sales channels of other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
|
|
1049
1049
|
*/
|
|
1050
1050
|
async getOtherSellerApplications(
|
|
1051
1051
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1131,7 +1131,7 @@ class Configuration {
|
|
|
1131
1131
|
* - Success response
|
|
1132
1132
|
*
|
|
1133
1133
|
* @name getSelectedOptIns
|
|
1134
|
-
* @summary:
|
|
1134
|
+
* @summary: List selected opt-in
|
|
1135
1135
|
* @description: Retrieve a list of selected opt-ins. Retrieve the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
|
|
1136
1136
|
*/
|
|
1137
1137
|
async getSelectedOptIns(
|
|
@@ -1222,7 +1222,7 @@ class Configuration {
|
|
|
1222
1222
|
* Success response
|
|
1223
1223
|
* @name getStoreByBrands
|
|
1224
1224
|
* @summary: Get store by brands
|
|
1225
|
-
* @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
|
|
1225
|
+
* @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
|
|
1226
1226
|
*/
|
|
1227
1227
|
async getStoreByBrands(
|
|
1228
1228
|
{ body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1309,8 +1309,8 @@ class Configuration {
|
|
|
1309
1309
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1310
1310
|
* Success response
|
|
1311
1311
|
* @name optOutFromApplication
|
|
1312
|
-
* @summary:
|
|
1313
|
-
* @description:
|
|
1312
|
+
* @summary: opt out of marketplaces
|
|
1313
|
+
* @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
|
|
1314
1314
|
*/
|
|
1315
1315
|
async optOutFromApplication(
|
|
1316
1316
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|