@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +41 -41
- package/sdk/platform/Order/OrderPlatformClient.js +41 -41
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -21,7 +21,7 @@ class Configuration {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
|
|
23
23
|
* @name addDomain
|
|
24
|
-
* @summary: Add domain
|
|
24
|
+
* @summary: Add domain
|
|
25
25
|
* @description: Add a new domain. Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
|
|
26
26
|
*/
|
|
27
27
|
async addDomain(
|
|
@@ -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: Change domain type
|
|
105
|
+
* @summary: Change domain type
|
|
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 application API tokens
|
|
186
|
+
* @summary: Get application 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 application basic details
|
|
263
|
+
* @summary: Get application basic details
|
|
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,7 +337,7 @@ class Configuration {
|
|
|
337
337
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
338
338
|
* @returns {Promise<ConfigurationPlatformModel.CompaniesResponse>} - Success response
|
|
339
339
|
* @name getAppCompanies
|
|
340
|
-
* @summary: Get application companies
|
|
340
|
+
* @summary: Get application companies
|
|
341
341
|
* @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
|
|
342
342
|
*/
|
|
343
343
|
async getAppCompanies(
|
|
@@ -426,7 +426,7 @@ class Configuration {
|
|
|
426
426
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
427
427
|
* Success response
|
|
428
428
|
* @name getAppContactInfo
|
|
429
|
-
* @summary: Get application contact information
|
|
429
|
+
* @summary: Get application contact information
|
|
430
430
|
* @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
|
|
431
431
|
*/
|
|
432
432
|
async getAppContactInfo(
|
|
@@ -504,7 +504,7 @@ class Configuration {
|
|
|
504
504
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
505
505
|
* Success response
|
|
506
506
|
* @name getAppCurrencyConfig
|
|
507
|
-
* @summary: Get application currency configuration
|
|
507
|
+
* @summary: Get application currency configuration
|
|
508
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 application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
|
|
509
509
|
*/
|
|
510
510
|
async getAppCurrencyConfig(
|
|
@@ -582,7 +582,7 @@ class Configuration {
|
|
|
582
582
|
* @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
|
|
583
583
|
* Success response
|
|
584
584
|
* @name getAppFeatures
|
|
585
|
-
* @summary: Get application features
|
|
585
|
+
* @summary: Get application features
|
|
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,7 +659,7 @@ class Configuration {
|
|
|
659
659
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
660
660
|
* @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
|
|
661
661
|
* @name getAppStores
|
|
662
|
-
* @summary: Get application stores
|
|
662
|
+
* @summary: Get application stores
|
|
663
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 application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
|
|
664
664
|
*/
|
|
665
665
|
async getAppStores(
|
|
@@ -745,7 +745,7 @@ class Configuration {
|
|
|
745
745
|
* @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
|
|
746
746
|
* Success response
|
|
747
747
|
* @name getAppSupportedCurrency
|
|
748
|
-
* @summary: Get supported currencies
|
|
748
|
+
* @summary: Get supported currencies
|
|
749
749
|
* @description: Retrieve a list of supported currencies for the application. A list of currencies allowed in the current application. 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(
|
|
@@ -822,7 +822,7 @@ class Configuration {
|
|
|
822
822
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
823
823
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
|
|
824
824
|
* @name getApplicationById
|
|
825
|
-
* @summary: Get application by ID
|
|
825
|
+
* @summary: Get application by ID
|
|
826
826
|
* @description: Retrieve detailed information about a specific application. Use application 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(
|
|
@@ -900,7 +900,7 @@ class Configuration {
|
|
|
900
900
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
901
901
|
* Success response
|
|
902
902
|
* @name getBuildConfig
|
|
903
|
-
* @summary: Get build configuration
|
|
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(
|
|
@@ -982,7 +982,7 @@ class Configuration {
|
|
|
982
982
|
* @returns {Promise<ConfigurationPlatformModel.DomainStatusResponse>} -
|
|
983
983
|
* Success response
|
|
984
984
|
* @name getDomainStatus
|
|
985
|
-
* @summary: Get domain status
|
|
985
|
+
* @summary: Get domain status
|
|
986
986
|
* @description: Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainStatus/).
|
|
987
987
|
*/
|
|
988
988
|
async getDomainStatus(
|
|
@@ -1061,7 +1061,7 @@ class Configuration {
|
|
|
1061
1061
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1062
1062
|
* @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
|
|
1063
1063
|
* @name getDomains
|
|
1064
|
-
* @summary: Get domains
|
|
1064
|
+
* @summary: Get domains
|
|
1065
1065
|
* @description: Get list of domains. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
|
|
1066
1066
|
*/
|
|
1067
1067
|
async getDomains(
|
|
@@ -1139,7 +1139,7 @@ class Configuration {
|
|
|
1139
1139
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
1140
1140
|
* Success response
|
|
1141
1141
|
* @name getInventoryConfig
|
|
1142
|
-
* @summary: Get inventory configuration
|
|
1142
|
+
* @summary: Get inventory configuration
|
|
1143
1143
|
* @description: Retrieve 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/getInventoryConfig/).
|
|
1144
1144
|
*/
|
|
1145
1145
|
async getInventoryConfig(
|
|
@@ -1217,7 +1217,7 @@ class Configuration {
|
|
|
1217
1217
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStoreConfig>} -
|
|
1218
1218
|
* Success response
|
|
1219
1219
|
* @name getOrderingStoreConfig
|
|
1220
|
-
* @summary: Get ordering store configuration
|
|
1220
|
+
* @summary: Get ordering store configuration
|
|
1221
1221
|
* @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the application 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(
|
|
@@ -1295,7 +1295,7 @@ class Configuration {
|
|
|
1295
1295
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1296
1296
|
* Success response
|
|
1297
1297
|
* @name getOrderingStoreCookie
|
|
1298
|
-
* @summary: Get an Ordering Store signed cookie on selection of ordering store
|
|
1298
|
+
* @summary: Get an Ordering Store signed cookie on selection of ordering store
|
|
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,7 +1376,7 @@ class Configuration {
|
|
|
1376
1376
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1377
1377
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
|
|
1378
1378
|
* @name getOrderingStoresByFilter
|
|
1379
|
-
* @summary: Get ordering stores by filter
|
|
1379
|
+
* @summary: Get ordering stores by filter
|
|
1380
1380
|
* @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the application 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(
|
|
@@ -1464,7 +1464,7 @@ class Configuration {
|
|
|
1464
1464
|
* @returns {Promise<ConfigurationPlatformModel.BuildVersionHistory>} -
|
|
1465
1465
|
* Success response
|
|
1466
1466
|
* @name getPreviousVersions
|
|
1467
|
-
* @summary: Get previous versions
|
|
1467
|
+
* @summary: Get previous versions
|
|
1468
1468
|
* @description: Retrieve version details of the app, this includes the build status, build date, version name, latest version, and a lot more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getPreviousVersions/).
|
|
1469
1469
|
*/
|
|
1470
1470
|
async getPreviousVersions(
|
|
@@ -1546,7 +1546,7 @@ class Configuration {
|
|
|
1546
1546
|
* @returns {Promise<ConfigurationPlatformModel.OrderingStoresResponse>} -
|
|
1547
1547
|
* Success response
|
|
1548
1548
|
* @name getStaffOrderingStores
|
|
1549
|
-
* @summary: Get staff ordering stores
|
|
1549
|
+
* @summary: Get staff ordering stores
|
|
1550
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 application 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(
|
|
@@ -1634,7 +1634,7 @@ class Configuration {
|
|
|
1634
1634
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1635
1635
|
* @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
|
|
1636
1636
|
* @name modifyAppFeatures
|
|
1637
|
-
* @summary: Modify application features
|
|
1637
|
+
* @summary: Modify application features
|
|
1638
1638
|
* @description: Update features of application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
|
|
1639
1639
|
*/
|
|
1640
1640
|
async modifyAppFeatures(
|
|
@@ -1716,7 +1716,7 @@ class Configuration {
|
|
|
1716
1716
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
1717
1717
|
* Success response
|
|
1718
1718
|
* @name partiallyUpdateInventoryConfig
|
|
1719
|
-
* @summary: Partially update inventory configuration
|
|
1719
|
+
* @summary: Partially update inventory configuration
|
|
1720
1720
|
* @description: Partially update 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(
|
|
@@ -1798,7 +1798,7 @@ class Configuration {
|
|
|
1798
1798
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1799
1799
|
* Success response
|
|
1800
1800
|
* @name removeDomainById
|
|
1801
|
-
* @summary: Remove domain by ID
|
|
1801
|
+
* @summary: Remove domain by ID
|
|
1802
1802
|
* @description: Delete a specific domain from the application. 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(
|
|
@@ -1880,7 +1880,7 @@ class Configuration {
|
|
|
1880
1880
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1881
1881
|
* Success response
|
|
1882
1882
|
* @name removeOrderingStoreCookie
|
|
1883
|
-
* @summary: Unset the Ordering Store signed cookie
|
|
1883
|
+
* @summary: Unset the 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,7 +1957,7 @@ class Configuration {
|
|
|
1957
1957
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1958
1958
|
* @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
|
|
1959
1959
|
* @name updateAppApiTokens
|
|
1960
|
-
* @summary: Update application API tokens
|
|
1960
|
+
* @summary: Update application API tokens
|
|
1961
1961
|
* @description: Add or 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(
|
|
@@ -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 application basic details
|
|
2041
|
+
* @summary: Update application 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,7 +2120,7 @@ class Configuration {
|
|
|
2120
2120
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
|
|
2121
2121
|
* Success response
|
|
2122
2122
|
* @name updateAppContactInfo
|
|
2123
|
-
* @summary: Update application contact information
|
|
2123
|
+
* @summary: Update application contact information
|
|
2124
2124
|
* @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
|
|
2125
2125
|
*/
|
|
2126
2126
|
async updateAppContactInfo(
|
|
@@ -2202,7 +2202,7 @@ class Configuration {
|
|
|
2202
2202
|
* @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
|
|
2203
2203
|
* Success response
|
|
2204
2204
|
* @name updateAppCurrencyConfig
|
|
2205
|
-
* @summary: Update application currency configuration
|
|
2205
|
+
* @summary: Update application currency configuration
|
|
2206
2206
|
* @description: Modify currency configuration settings for the application. Add and edit the currencies supported in the application. 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(
|
|
@@ -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 application features
|
|
2286
|
+
* @summary: Update application features
|
|
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(
|
|
@@ -2365,7 +2365,7 @@ class Configuration {
|
|
|
2365
2365
|
* @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
|
|
2366
2366
|
* Success response
|
|
2367
2367
|
* @name updateBuildConfig
|
|
2368
|
-
* @summary: Update build configuration
|
|
2368
|
+
* @summary: Update build configuration
|
|
2369
2369
|
* @description: Modify the existing 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/updateBuildConfig/).
|
|
2370
2370
|
*/
|
|
2371
2371
|
async updateBuildConfig(
|
|
@@ -2449,7 +2449,7 @@ class Configuration {
|
|
|
2449
2449
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
|
|
2450
2450
|
* Success response
|
|
2451
2451
|
* @name updateInventoryConfig
|
|
2452
|
-
* @summary: Update inventory configuration
|
|
2452
|
+
* @summary: Update inventory configuration
|
|
2453
2453
|
* @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/updateInventoryConfig/).
|
|
2454
2454
|
*/
|
|
2455
2455
|
async updateInventoryConfig(
|
|
@@ -2530,7 +2530,7 @@ class Configuration {
|
|
|
2530
2530
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2531
2531
|
* @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
|
|
2532
2532
|
* @name updateOrderingStoreConfig
|
|
2533
|
-
* @summary: Update ordering store configuration
|
|
2533
|
+
* @summary: Update ordering store configuration
|
|
2534
2534
|
* @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the application 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(
|
|
@@ -8,7 +8,7 @@ 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 application
|
|
11
|
+
* @summary: Create application
|
|
12
12
|
* @description: Generate and add a new application. Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application 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>;
|
|
@@ -19,7 +19,7 @@ declare class Configuration {
|
|
|
19
19
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
|
|
20
20
|
* Success response
|
|
21
21
|
* @name getApplications
|
|
22
|
-
* @summary: Get applications
|
|
22
|
+
* @summary: Get applications
|
|
23
23
|
* @description: Retrieve a list of available applications. Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications 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>;
|
|
@@ -31,7 +31,7 @@ declare class Configuration {
|
|
|
31
31
|
* - Success response
|
|
32
32
|
*
|
|
33
33
|
* @name getAvailableOptIns
|
|
34
|
-
* @summary: Get available opt-ins
|
|
34
|
+
* @summary: Get available opt-ins
|
|
35
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>;
|
|
@@ -42,7 +42,7 @@ declare class Configuration {
|
|
|
42
42
|
* @returns {Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>} -
|
|
43
43
|
* Success response
|
|
44
44
|
* @name getBrandsByCompany
|
|
45
|
-
* @summary: Get brands by company
|
|
45
|
+
* @summary: Get brands by company
|
|
46
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/).
|
|
47
47
|
*/
|
|
48
48
|
getBrandsByCompany({ q, requestHeaders }?: ConfigurationPlatformValidator.GetBrandsByCompanyParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>;
|
|
@@ -53,7 +53,7 @@ declare class Configuration {
|
|
|
53
53
|
* @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
|
|
54
54
|
* Success response
|
|
55
55
|
* @name getCompanyByBrands
|
|
56
|
-
* @summary: Get company by brands
|
|
56
|
+
* @summary: Get company by brands
|
|
57
57
|
* @description: Retrieve companies associated with specific brands. Retrieve a list of companies by the brands they deal. - 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>;
|
|
@@ -64,7 +64,7 @@ declare class Configuration {
|
|
|
64
64
|
* @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
|
|
65
65
|
* Success response
|
|
66
66
|
* @name getCurrencies
|
|
67
|
-
* @summary: Get currencies
|
|
67
|
+
* @summary: Get currencies
|
|
68
68
|
* @description: Retrieve a list of available currencies. Use this API to get a list of currencies allowed in the company. 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/getCurrencies/).
|
|
69
69
|
*/
|
|
70
70
|
getCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CurrenciesResponse>;
|
|
@@ -76,7 +76,7 @@ declare class Configuration {
|
|
|
76
76
|
* - Success response
|
|
77
77
|
*
|
|
78
78
|
* @name getDomainAvailibility
|
|
79
|
-
* @summary: Get domain availability
|
|
79
|
+
* @summary: Get domain availability
|
|
80
80
|
* @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to application. 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>;
|
|
@@ -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 ID
|
|
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 by level ID
|
|
101
|
+
* @summary: Get integration by level 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 integration level configuration
|
|
115
|
+
* @summary: Get integration 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 for a level
|
|
128
|
+
* @summary: Get active integrations for a level
|
|
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,7 +139,7 @@ declare class Configuration {
|
|
|
139
139
|
* - Success response
|
|
140
140
|
*
|
|
141
141
|
* @name getOtherSellerApplicationById
|
|
142
|
-
* @summary: Get other seller application by ID
|
|
142
|
+
* @summary: Get other seller application by ID
|
|
143
143
|
* @description: Retrieve details of a seller application that was not created within the current company. but has opted for the current company's inventory - 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>;
|
|
@@ -152,7 +152,7 @@ declare class Configuration {
|
|
|
152
152
|
* @returns {Promise<ConfigurationPlatformModel.OtherSellerApplications>} -
|
|
153
153
|
* Success response
|
|
154
154
|
* @name getOtherSellerApplications
|
|
155
|
-
* @summary: Get other seller applications
|
|
155
|
+
* @summary: Get other seller applications
|
|
156
156
|
* @description: Retrieve applications from other sellers. Retrieve all other seller applications 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>;
|
|
@@ -164,7 +164,7 @@ declare class Configuration {
|
|
|
164
164
|
* - Success response
|
|
165
165
|
*
|
|
166
166
|
* @name getSelectedOptIns
|
|
167
|
-
* @summary: Get selected opt-ins
|
|
167
|
+
* @summary: Get selected opt-ins
|
|
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>;
|
|
@@ -175,7 +175,7 @@ declare class Configuration {
|
|
|
175
175
|
* @returns {Promise<ConfigurationPlatformModel.StoreByBrandsResponse>} -
|
|
176
176
|
* Success response
|
|
177
177
|
* @name getStoreByBrands
|
|
178
|
-
* @summary: Get store by brands
|
|
178
|
+
* @summary: Get store by brands
|
|
179
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/).
|
|
180
180
|
*/
|
|
181
181
|
getStoreByBrands({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetStoreByBrandsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoreByBrandsResponse>;
|
|
@@ -186,7 +186,7 @@ declare class Configuration {
|
|
|
186
186
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
187
187
|
* Success response
|
|
188
188
|
* @name optOutFromApplication
|
|
189
|
-
* @summary: Opt out from an application
|
|
189
|
+
* @summary: Opt out from an application
|
|
190
190
|
* @description: Choose to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store. - 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>;
|
|
@@ -198,7 +198,7 @@ declare class Configuration {
|
|
|
198
198
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
199
199
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
200
200
|
* @name updateLevelIntegration
|
|
201
|
-
* @summary: Update level integration
|
|
201
|
+
* @summary: Update level integration
|
|
202
202
|
* @description: Modify level integration. Update 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/updateLevelIntegration/).
|
|
203
203
|
*/
|
|
204
204
|
updateLevelIntegration({ id, level, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
|
|
@@ -210,7 +210,7 @@ declare class Configuration {
|
|
|
210
210
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
211
211
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
212
212
|
* @name updateLevelUidIntegration
|
|
213
|
-
* @summary: Update level UID integration
|
|
213
|
+
* @summary: Update level UID integration
|
|
214
214
|
* @description: Modify UID-based integration. Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
|
|
215
215
|
*/
|
|
216
216
|
updateLevelUidIntegration({ id, level, uid, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
|
|
@@ -20,7 +20,7 @@ class Configuration {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ConfigurationPlatformModel.CreateAppResponse>} - Success response
|
|
22
22
|
* @name createApplication
|
|
23
|
-
* @summary: Create application
|
|
23
|
+
* @summary: Create application
|
|
24
24
|
* @description: Generate and add a new application. Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
|
|
25
25
|
*/
|
|
26
26
|
async createApplication(
|
|
@@ -102,7 +102,7 @@ class Configuration {
|
|
|
102
102
|
* @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
|
|
103
103
|
* Success response
|
|
104
104
|
* @name getApplications
|
|
105
|
-
* @summary: Get applications
|
|
105
|
+
* @summary: Get applications
|
|
106
106
|
* @description: Retrieve a list of available applications. Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
|
|
107
107
|
*/
|
|
108
108
|
async getApplications(
|
|
@@ -190,7 +190,7 @@ class Configuration {
|
|
|
190
190
|
* - Success response
|
|
191
191
|
*
|
|
192
192
|
* @name getAvailableOptIns
|
|
193
|
-
* @summary: Get available opt-ins
|
|
193
|
+
* @summary: Get available opt-ins
|
|
194
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(
|
|
@@ -276,7 +276,7 @@ class Configuration {
|
|
|
276
276
|
* @returns {Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>} -
|
|
277
277
|
* Success response
|
|
278
278
|
* @name getBrandsByCompany
|
|
279
|
-
* @summary: Get brands by company
|
|
279
|
+
* @summary: Get brands by company
|
|
280
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/).
|
|
281
281
|
*/
|
|
282
282
|
async getBrandsByCompany(
|
|
@@ -359,7 +359,7 @@ class Configuration {
|
|
|
359
359
|
* @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
|
|
360
360
|
* Success response
|
|
361
361
|
* @name getCompanyByBrands
|
|
362
|
-
* @summary: Get company by brands
|
|
362
|
+
* @summary: Get company by brands
|
|
363
363
|
* @description: Retrieve companies associated with specific brands. Retrieve a list of companies by the brands they deal. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
|
|
364
364
|
*/
|
|
365
365
|
async getCompanyByBrands(
|
|
@@ -447,7 +447,7 @@ class Configuration {
|
|
|
447
447
|
* @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
|
|
448
448
|
* Success response
|
|
449
449
|
* @name getCurrencies
|
|
450
|
-
* @summary: Get currencies
|
|
450
|
+
* @summary: Get currencies
|
|
451
451
|
* @description: Retrieve a list of available currencies. Use this API to get a list of currencies allowed in the company. 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/getCurrencies/).
|
|
452
452
|
*/
|
|
453
453
|
async getCurrencies(
|
|
@@ -524,7 +524,7 @@ class Configuration {
|
|
|
524
524
|
* - Success response
|
|
525
525
|
*
|
|
526
526
|
* @name getDomainAvailibility
|
|
527
|
-
* @summary: Get domain availability
|
|
527
|
+
* @summary: Get domain availability
|
|
528
528
|
* @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to application. 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(
|
|
@@ -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 ID
|
|
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 by level ID
|
|
691
|
+
* @summary: Get integration by level 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 integration level configuration
|
|
780
|
+
* @summary: Get integration 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 for a level
|
|
874
|
+
* @summary: Get active integrations for a level
|
|
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,7 +960,7 @@ class Configuration {
|
|
|
960
960
|
* - Success response
|
|
961
961
|
*
|
|
962
962
|
* @name getOtherSellerApplicationById
|
|
963
|
-
* @summary: Get other seller application by ID
|
|
963
|
+
* @summary: Get other seller application by ID
|
|
964
964
|
* @description: Retrieve details of a seller application that was not created within the current company. but has opted for the current company's inventory - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
|
|
965
965
|
*/
|
|
966
966
|
async getOtherSellerApplicationById(
|
|
@@ -1044,7 +1044,7 @@ class Configuration {
|
|
|
1044
1044
|
* @returns {Promise<ConfigurationPlatformModel.OtherSellerApplications>} -
|
|
1045
1045
|
* Success response
|
|
1046
1046
|
* @name getOtherSellerApplications
|
|
1047
|
-
* @summary: Get other seller applications
|
|
1047
|
+
* @summary: Get other seller applications
|
|
1048
1048
|
* @description: Retrieve applications from other sellers. Retrieve all other seller applications 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(
|
|
@@ -1131,7 +1131,7 @@ class Configuration {
|
|
|
1131
1131
|
* - Success response
|
|
1132
1132
|
*
|
|
1133
1133
|
* @name getSelectedOptIns
|
|
1134
|
-
* @summary: Get selected opt-ins
|
|
1134
|
+
* @summary: Get selected opt-ins
|
|
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(
|
|
@@ -1221,7 +1221,7 @@ class Configuration {
|
|
|
1221
1221
|
* @returns {Promise<ConfigurationPlatformModel.StoreByBrandsResponse>} -
|
|
1222
1222
|
* Success response
|
|
1223
1223
|
* @name getStoreByBrands
|
|
1224
|
-
* @summary: Get store by brands
|
|
1224
|
+
* @summary: Get store by brands
|
|
1225
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/).
|
|
1226
1226
|
*/
|
|
1227
1227
|
async getStoreByBrands(
|
|
@@ -1309,7 +1309,7 @@ class Configuration {
|
|
|
1309
1309
|
* @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
|
|
1310
1310
|
* Success response
|
|
1311
1311
|
* @name optOutFromApplication
|
|
1312
|
-
* @summary: Opt out from an application
|
|
1312
|
+
* @summary: Opt out from an application
|
|
1313
1313
|
* @description: Choose to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
|
|
1314
1314
|
*/
|
|
1315
1315
|
async optOutFromApplication(
|
|
@@ -1394,7 +1394,7 @@ class Configuration {
|
|
|
1394
1394
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1395
1395
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
1396
1396
|
* @name updateLevelIntegration
|
|
1397
|
-
* @summary: Update level integration
|
|
1397
|
+
* @summary: Update level integration
|
|
1398
1398
|
* @description: Modify level integration. Update 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/updateLevelIntegration/).
|
|
1399
1399
|
*/
|
|
1400
1400
|
async updateLevelIntegration(
|
|
@@ -1481,7 +1481,7 @@ class Configuration {
|
|
|
1481
1481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1482
1482
|
* @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
|
|
1483
1483
|
* @name updateLevelUidIntegration
|
|
1484
|
-
* @summary: Update level UID integration
|
|
1484
|
+
* @summary: Update level UID integration
|
|
1485
1485
|
* @description: Modify UID-based integration. Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
|
|
1486
1486
|
*/
|
|
1487
1487
|
async updateLevelUidIntegration(
|