@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.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.
Files changed (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  42. package/sdk/application/User/UserApplicationClient.js +64 -64
  43. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  44. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  45. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  46. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  47. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  48. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  49. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  50. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  51. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  52. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  54. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  59. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  60. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  61. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  62. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  63. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  64. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  66. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  67. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  68. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  70. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  71. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  72. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  73. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  74. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  75. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  77. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  78. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  79. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  81. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  82. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  83. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  84. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  85. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  86. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
  89. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  90. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
  93. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  94. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  95. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  97. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  98. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  99. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  100. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  101. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  102. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  103. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  104. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  105. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  108. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  109. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  110. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  111. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  112. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  121. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  122. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  123. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  124. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  125. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  126. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  127. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  128. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  129. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  130. package/sdk/platform/User/UserPlatformModel.js +2 -2
  131. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  132. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  133. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  134. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  135. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  136. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  137. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  138. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  140. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -21,8 +21,8 @@ class Configuration {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
23
23
  * @name addDomain
24
- * @summary: Add new domain to current sales channel
25
- * @description: 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/).
24
+ * @summary: Add domain.
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(
28
28
  { body, requestHeaders } = { requestHeaders: {} },
@@ -102,8 +102,8 @@ class Configuration {
102
102
  * @param {import("../PlatformAPIClient").Options} - Options
103
103
  * @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
104
104
  * @name changeDomainType
105
- * @summary: Change the type of domain in the current sales channel
106
- * @description: Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. Use this API to change a domain to either Primary or a Shortlink domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/changeDomainType/).
105
+ * @summary: Change domain type.
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(
109
109
  { body, requestHeaders } = { requestHeaders: {} },
@@ -183,8 +183,8 @@ class Configuration {
183
183
  * @param {import("../PlatformAPIClient").Options} - Options
184
184
  * @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
185
185
  * @name getAppApiTokens
186
- * @summary: Get social tokens for the sales channel
187
- * @description: Use this API to retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. **Note** - Token values are encrypted with AES encryption using a secret key. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
186
+ * @summary: Get application API tokens.
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(
190
190
  { requestHeaders } = { requestHeaders: {} },
@@ -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 sales channel 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,8 +337,8 @@ class Configuration {
337
337
  * @param {import("../PlatformAPIClient").Options} - Options
338
338
  * @returns {Promise<ConfigurationPlatformModel.CompaniesResponse>} - Success response
339
339
  * @name getAppCompanies
340
- * @summary: Get companies enabled in the sales channel inventory
341
- * @description: Fetch 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/).
340
+ * @summary: Get application companies.
341
+ * @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
342
342
  */
343
343
  async getAppCompanies(
344
344
  { uid, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -417,42 +417,6 @@ class Configuration {
417
417
  return response;
418
418
  }
419
419
 
420
- /**
421
- * @param {Object} arg - Arg object.
422
- * @param {number} arg.companyId - Numeric ID allotted to a business account
423
- * on Fynd Platform
424
- * @param {string} arg.applicationId - Alphanumeric ID allotted to an
425
- * application (sales channel website) created within a business account
426
- * @param {number} [arg.uid] - UID of companies to be fetched
427
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
428
- * page. Default value is 10.
429
- * @returns {Paginator<ConfigurationPlatformModel.CompaniesResponse>}
430
- * @summary: Get companies enabled in the sales channel inventory
431
- * @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
432
- */
433
- getAppCompaniesPaginator({ companyId, applicationId, uid, pageSize } = {}) {
434
- const paginator = new Paginator();
435
- const callback = async () => {
436
- const pageId = paginator.nextId;
437
- const pageNo = paginator.pageNo;
438
- const pageType = "number";
439
- const data = await this.getAppCompanies({
440
- companyId: companyId,
441
- applicationId: applicationId,
442
- uid: uid,
443
- pageNo: pageNo,
444
- pageSize: pageSize,
445
- });
446
- paginator.setPaginator({
447
- hasNext: data.page.has_next ? true : false,
448
- nextId: data.page.next_id,
449
- });
450
- return data;
451
- };
452
- paginator.setCallback(callback.bind(this));
453
- return paginator;
454
- }
455
-
456
420
  /**
457
421
  * @param {ConfigurationPlatformApplicationValidator.GetAppContactInfoParam} arg
458
422
  * - Arg object
@@ -462,7 +426,7 @@ class Configuration {
462
426
  * @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
463
427
  * Success response
464
428
  * @name getAppContactInfo
465
- * @summary: Get current information of the sales channel
429
+ * @summary: Get application contact information.
466
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/).
467
431
  */
468
432
  async getAppContactInfo(
@@ -540,8 +504,8 @@ class Configuration {
540
504
  * @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
541
505
  * Success response
542
506
  * @name getAppCurrencyConfig
543
- * @summary: Get currencies supported in the application
544
- * @description: Get 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/).
507
+ * @summary: Get application currency configuration.
508
+ * @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
545
509
  */
546
510
  async getAppCurrencyConfig(
547
511
  { requestHeaders } = { requestHeaders: {} },
@@ -618,7 +582,7 @@ class Configuration {
618
582
  * @returns {Promise<ConfigurationPlatformModel.AppFeatureResponse>} -
619
583
  * Success response
620
584
  * @name getAppFeatures
621
- * @summary: Get the sales channel configuration and features
585
+ * @summary: Get application features.
622
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/).
623
587
  */
624
588
  async getAppFeatures(
@@ -695,8 +659,8 @@ class Configuration {
695
659
  * @param {import("../PlatformAPIClient").Options} - Options
696
660
  * @returns {Promise<ConfigurationPlatformModel.StoresResponse>} - Success response
697
661
  * @name getAppStores
698
- * @summary: Get stores enabled in the sales channel inventory
699
- * @description: Fetch info 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/).
662
+ * @summary: Get application stores.
663
+ * @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
700
664
  */
701
665
  async getAppStores(
702
666
  { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -772,40 +736,6 @@ class Configuration {
772
736
  return response;
773
737
  }
774
738
 
775
- /**
776
- * @param {Object} arg - Arg object.
777
- * @param {number} arg.companyId - Numeric ID allotted to a business account
778
- * on Fynd Platform
779
- * @param {string} arg.applicationId - Alphanumeric ID allotted to an
780
- * application (sales channel website) created within a business account
781
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
782
- * page. Default value is 10.
783
- * @returns {Paginator<ConfigurationPlatformModel.StoresResponse>}
784
- * @summary: Get stores enabled in the sales channel inventory
785
- * @description: Fetch info 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
786
- */
787
- getAppStoresPaginator({ companyId, applicationId, pageSize } = {}) {
788
- const paginator = new Paginator();
789
- const callback = async () => {
790
- const pageId = paginator.nextId;
791
- const pageNo = paginator.pageNo;
792
- const pageType = "number";
793
- const data = await this.getAppStores({
794
- companyId: companyId,
795
- applicationId: applicationId,
796
- pageNo: pageNo,
797
- pageSize: pageSize,
798
- });
799
- paginator.setPaginator({
800
- hasNext: data.page.has_next ? true : false,
801
- nextId: data.page.next_id,
802
- });
803
- return data;
804
- };
805
- paginator.setCallback(callback.bind(this));
806
- return paginator;
807
- }
808
-
809
739
  /**
810
740
  * @param {ConfigurationPlatformApplicationValidator.GetAppSupportedCurrencyParam} arg
811
741
  * - Arg object
@@ -815,8 +745,8 @@ class Configuration {
815
745
  * @returns {Promise<ConfigurationPlatformModel.AppCurrencyResponse>} -
816
746
  * Success response
817
747
  * @name getAppSupportedCurrency
818
- * @summary: Get currencies enabled in the application
819
- * @description: Use this API to get 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/).
748
+ * @summary: Get supported currencies.
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/).
820
750
  */
821
751
  async getAppSupportedCurrency(
822
752
  { requestHeaders } = { requestHeaders: {} },
@@ -890,10 +820,10 @@ class Configuration {
890
820
  *
891
821
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
892
822
  * @param {import("../PlatformAPIClient").Options} - Options
893
- * @returns {Promise<ConfigurationPlatformModel.Application>} - Success response
823
+ * @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
894
824
  * @name getApplicationById
895
- * @summary: Get sales channel data by ID
896
- * @description: 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/).
825
+ * @summary: Get application by ID.
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/).
897
827
  */
898
828
  async getApplicationById(
899
829
  { requestHeaders } = { requestHeaders: {} },
@@ -942,7 +872,7 @@ class Configuration {
942
872
 
943
873
  const {
944
874
  error: res_error,
945
- } = ConfigurationPlatformModel.Application().validate(responseData, {
875
+ } = ConfigurationPlatformModel.ApplicationById().validate(responseData, {
946
876
  abortEarly: false,
947
877
  allowUnknown: true,
948
878
  });
@@ -970,8 +900,8 @@ class Configuration {
970
900
  * @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
971
901
  * Success response
972
902
  * @name getBuildConfig
973
- * @summary: Get configuration of latest mobile build
974
- * @description: Fetch 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/).
903
+ * @summary: Get build configuration.
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/).
975
905
  */
976
906
  async getBuildConfig(
977
907
  { platformType, requestHeaders } = { requestHeaders: {} },
@@ -1052,8 +982,8 @@ class Configuration {
1052
982
  * @returns {Promise<ConfigurationPlatformModel.DomainStatusResponse>} -
1053
983
  * Success response
1054
984
  * @name getDomainStatus
1055
- * @summary: Get the status of connected domain
1056
- * @description: 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/).
985
+ * @summary: Get domain status.
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/).
1057
987
  */
1058
988
  async getDomainStatus(
1059
989
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1131,8 +1061,8 @@ class Configuration {
1131
1061
  * @param {import("../PlatformAPIClient").Options} - Options
1132
1062
  * @returns {Promise<ConfigurationPlatformModel.DomainsResponse>} - Success response
1133
1063
  * @name getDomains
1134
- * @summary: Fetch all the domains added to an application (sales channel website), including pre-defined domain (free domain) or custom domain (owned by the brand). Know the verification status of each domain name, and find out which one is the primary domain, short link domain, or both.
1135
- * @description: Get list of domains - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
1064
+ * @summary: Get domains.
1065
+ * @description: Get list of domains. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
1136
1066
  */
1137
1067
  async getDomains(
1138
1068
  { requestHeaders } = { requestHeaders: {} },
@@ -1209,8 +1139,8 @@ class Configuration {
1209
1139
  * @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
1210
1140
  * Success response
1211
1141
  * @name getInventoryConfig
1212
- * @summary: Get sales channel configuration
1213
- * @description: Use this API to fetch 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/).
1142
+ * @summary: Get inventory configuration.
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/).
1214
1144
  */
1215
1145
  async getInventoryConfig(
1216
1146
  { requestHeaders } = { requestHeaders: {} },
@@ -1287,8 +1217,8 @@ class Configuration {
1287
1217
  * @returns {Promise<ConfigurationPlatformModel.OrderingStoreConfig>} -
1288
1218
  * Success response
1289
1219
  * @name getOrderingStoreConfig
1290
- * @summary: Get ordering store config
1291
- * @description: Fetch 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/).
1220
+ * @summary: Get ordering store configuration.
1221
+ * @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
1292
1222
  */
1293
1223
  async getOrderingStoreConfig(
1294
1224
  { requestHeaders } = { requestHeaders: {} },
@@ -1446,8 +1376,8 @@ class Configuration {
1446
1376
  * @param {import("../PlatformAPIClient").Options} - Options
1447
1377
  * @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
1448
1378
  * @name getOrderingStoresByFilter
1449
- * @summary: Get ordering store by filter
1450
- * @description: Use this API to 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/).
1379
+ * @summary: Get ordering stores by filter.
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/).
1451
1381
  */
1452
1382
  async getOrderingStoresByFilter(
1453
1383
  { body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -1525,47 +1455,6 @@ class Configuration {
1525
1455
  return response;
1526
1456
  }
1527
1457
 
1528
- /**
1529
- * @param {Object} arg - Arg object.
1530
- * @param {number} arg.companyId - Numeric ID allotted to a business account
1531
- * on Fynd Platform
1532
- * @param {string} arg.applicationId - Alphanumeric ID allotted to an
1533
- * application (sales channel website) created within a business account
1534
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
1535
- * page. Default value is 10.
1536
- * @param {ConfigurationPlatformModel.FilterOrderingStoreRequest} arg.body
1537
- * @returns {Paginator<ConfigurationPlatformModel.OrderingStores>}
1538
- * @summary: Get ordering store by filter
1539
- * @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
1540
- */
1541
- getOrderingStoresByFilterPaginator({
1542
- companyId,
1543
- applicationId,
1544
- pageSize,
1545
- body,
1546
- } = {}) {
1547
- const paginator = new Paginator();
1548
- const callback = async () => {
1549
- const pageId = paginator.nextId;
1550
- const pageNo = paginator.pageNo;
1551
- const pageType = "number";
1552
- const data = await this.getOrderingStoresByFilter({
1553
- companyId: companyId,
1554
- applicationId: applicationId,
1555
- body: body,
1556
- pageNo: pageNo,
1557
- pageSize: pageSize,
1558
- });
1559
- paginator.setPaginator({
1560
- hasNext: data.page.has_next ? true : false,
1561
- nextId: data.page.next_id,
1562
- });
1563
- return data;
1564
- };
1565
- paginator.setCallback(callback.bind(this));
1566
- return paginator;
1567
- }
1568
-
1569
1458
  /**
1570
1459
  * @param {ConfigurationPlatformApplicationValidator.GetPreviousVersionsParam} arg
1571
1460
  * - Arg object
@@ -1575,8 +1464,8 @@ class Configuration {
1575
1464
  * @returns {Promise<ConfigurationPlatformModel.BuildVersionHistory>} -
1576
1465
  * Success response
1577
1466
  * @name getPreviousVersions
1578
- * @summary: Get details of previous mobile builds
1579
- * @description: Fetch 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/).
1467
+ * @summary: Get previous versions.
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/).
1580
1469
  */
1581
1470
  async getPreviousVersions(
1582
1471
  { platformType, requestHeaders } = { requestHeaders: {} },
@@ -1657,8 +1546,8 @@ class Configuration {
1657
1546
  * @returns {Promise<ConfigurationPlatformModel.OrderingStoresResponse>} -
1658
1547
  * Success response
1659
1548
  * @name getStaffOrderingStores
1660
- * @summary: Get deployment stores
1661
- * @description: Use this API to 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/).
1549
+ * @summary: Get staff ordering stores.
1550
+ * @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
1662
1551
  */
1663
1552
  async getStaffOrderingStores(
1664
1553
  { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -1737,47 +1626,6 @@ class Configuration {
1737
1626
  return response;
1738
1627
  }
1739
1628
 
1740
- /**
1741
- * @param {Object} arg - Arg object.
1742
- * @param {number} arg.companyId - Numeric ID allotted to a business account
1743
- * on Fynd Platform
1744
- * @param {string} arg.applicationId - Alphanumeric ID allotted to an
1745
- * application (sales channel website) created within a business account
1746
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
1747
- * page. Default value is 10.
1748
- * @param {string} [arg.q] - Store code or name of the ordering store.
1749
- * @returns {Paginator<ConfigurationPlatformModel.OrderingStoresResponse>}
1750
- * @summary: Get deployment stores
1751
- * @description: Use this API to retrieve the details of all stores access given to the staff member (the selling locations where the application will be utilized for placing orders).
1752
- */
1753
- getStaffOrderingStoresPaginator({
1754
- companyId,
1755
- applicationId,
1756
- pageSize,
1757
- q,
1758
- } = {}) {
1759
- const paginator = new Paginator();
1760
- const callback = async () => {
1761
- const pageId = paginator.nextId;
1762
- const pageNo = paginator.pageNo;
1763
- const pageType = "number";
1764
- const data = await this.getStaffOrderingStores({
1765
- companyId: companyId,
1766
- applicationId: applicationId,
1767
- pageNo: pageNo,
1768
- pageSize: pageSize,
1769
- q: q,
1770
- });
1771
- paginator.setPaginator({
1772
- hasNext: data.page.has_next ? true : false,
1773
- nextId: data.page.next_id,
1774
- });
1775
- return data;
1776
- };
1777
- paginator.setCallback(callback.bind(this));
1778
- return paginator;
1779
- }
1780
-
1781
1629
  /**
1782
1630
  * @param {ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam} arg
1783
1631
  * - Arg object
@@ -1786,7 +1634,7 @@ class Configuration {
1786
1634
  * @param {import("../PlatformAPIClient").Options} - Options
1787
1635
  * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
1788
1636
  * @name modifyAppFeatures
1789
- * @summary: Update features of application
1637
+ * @summary: Modify application features.
1790
1638
  * @description: Update features of application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
1791
1639
  */
1792
1640
  async modifyAppFeatures(
@@ -1868,7 +1716,7 @@ class Configuration {
1868
1716
  * @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
1869
1717
  * Success response
1870
1718
  * @name partiallyUpdateInventoryConfig
1871
- * @summary: Partially update sales channel configuration
1719
+ * @summary: Partially update inventory configuration.
1872
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/).
1873
1721
  */
1874
1722
  async partiallyUpdateInventoryConfig(
@@ -1950,8 +1798,8 @@ class Configuration {
1950
1798
  * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
1951
1799
  * Success response
1952
1800
  * @name removeDomainById
1953
- * @summary: Remove attached domain from current sales channel
1954
- * @description: 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/).
1801
+ * @summary: Remove domain by ID.
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/).
1955
1803
  */
1956
1804
  async removeDomainById(
1957
1805
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2109,8 +1957,8 @@ class Configuration {
2109
1957
  * @param {import("../PlatformAPIClient").Options} - Options
2110
1958
  * @returns {Promise<ConfigurationPlatformModel.TokenResponse>} - Success response
2111
1959
  * @name updateAppApiTokens
2112
- * @summary: Add or update social tokens for the sales channel
2113
- * @description: Use this API to 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/).
1960
+ * @summary: Update application API tokens.
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/).
2114
1962
  */
2115
1963
  async updateAppApiTokens(
2116
1964
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2190,7 +2038,7 @@ class Configuration {
2190
2038
  * @param {import("../PlatformAPIClient").Options} - Options
2191
2039
  * @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
2192
2040
  * @name updateAppBasicDetails
2193
- * @summary: Update sales channel details
2041
+ * @summary: Update application basic details.
2194
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/).
2195
2043
  */
2196
2044
  async updateAppBasicDetails(
@@ -2272,7 +2120,7 @@ class Configuration {
2272
2120
  * @returns {Promise<ConfigurationPlatformModel.ApplicationInformation>} -
2273
2121
  * Success response
2274
2122
  * @name updateAppContactInfo
2275
- * @summary: Save or update current information of the sales channel
2123
+ * @summary: Update application contact information.
2276
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/).
2277
2125
  */
2278
2126
  async updateAppContactInfo(
@@ -2354,8 +2202,8 @@ class Configuration {
2354
2202
  * @returns {Promise<ConfigurationPlatformModel.AppSupportedCurrency>} -
2355
2203
  * Success response
2356
2204
  * @name updateAppCurrencyConfig
2357
- * @summary: Update initial sales channel supported currency
2358
- * @description: Use this API to 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/).
2205
+ * @summary: Update application currency configuration.
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/).
2359
2207
  */
2360
2208
  async updateAppCurrencyConfig(
2361
2209
  { body, requestHeaders } = { requestHeaders: {} },
@@ -2435,7 +2283,7 @@ class Configuration {
2435
2283
  * @param {import("../PlatformAPIClient").Options} - Options
2436
2284
  * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
2437
2285
  * @name updateAppFeatures
2438
- * @summary: Update the sales channel configuration and features
2286
+ * @summary: Update application features.
2439
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/).
2440
2288
  */
2441
2289
  async updateAppFeatures(
@@ -2517,7 +2365,7 @@ class Configuration {
2517
2365
  * @returns {Promise<ConfigurationPlatformModel.MobileAppConfiguration>} -
2518
2366
  * Success response
2519
2367
  * @name updateBuildConfig
2520
- * @summary: Update the configuration for next mobile build
2368
+ * @summary: Update build configuration.
2521
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/).
2522
2370
  */
2523
2371
  async updateBuildConfig(
@@ -2601,7 +2449,7 @@ class Configuration {
2601
2449
  * @returns {Promise<ConfigurationPlatformModel.ApplicationInventory>} -
2602
2450
  * Success response
2603
2451
  * @name updateInventoryConfig
2604
- * @summary: Update sales channel configuration
2452
+ * @summary: Update inventory configuration.
2605
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/).
2606
2454
  */
2607
2455
  async updateInventoryConfig(
@@ -2682,8 +2530,8 @@ class Configuration {
2682
2530
  * @param {import("../PlatformAPIClient").Options} - Options
2683
2531
  * @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
2684
2532
  * @name updateOrderingStoreConfig
2685
- * @summary: Add/Update ordering store config
2686
- * @description: Use this API to 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/).
2533
+ * @summary: Update ordering store configuration.
2534
+ * @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
2687
2535
  */
2688
2536
  async updateOrderingStoreConfig(
2689
2537
  { body, requestHeaders } = { requestHeaders: {} },