@gofynd/fdk-client-javascript 1.1.1 → 1.1.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.
Files changed (140) hide show
  1. package/README.md +1 -2
  2. package/index.d.ts +4 -7
  3. package/index.js +5 -12
  4. package/package.json +1 -1
  5. package/sdk/application/ApplicationClient.d.ts +20 -20
  6. package/sdk/application/ApplicationClient.js +26 -26
  7. package/sdk/application/Cart/CartApplicationClient.d.ts +45 -4
  8. package/sdk/application/Cart/CartApplicationClient.js +169 -9
  9. package/sdk/application/Cart/CartApplicationModel.d.ts +15 -0
  10. package/sdk/application/Cart/CartApplicationModel.js +177 -1
  11. package/sdk/application/Cart/CartApplicationValidator.d.ts +2 -0
  12. package/sdk/application/Cart/CartApplicationValidator.js +20 -0
  13. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +14 -4
  14. package/sdk/application/Catalog/CatalogApplicationClient.js +18 -6
  15. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1 -0
  16. package/sdk/application/Catalog/CatalogApplicationModel.js +13 -0
  17. package/sdk/application/Catalog/CatalogApplicationValidator.js +2 -0
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +14 -10
  19. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -10
  20. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1 -0
  21. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  22. package/sdk/application/Content/ContentApplicationModel.js +4 -1
  23. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -2
  24. package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -2
  25. package/sdk/application/FileStorage/FileStorageApplicationModel.js +2 -2
  26. package/sdk/application/Logistic/LogisticApplicationModel.js +3 -2
  27. package/sdk/application/Order/OrderApplicationClient.d.ts +17 -2
  28. package/sdk/application/Order/OrderApplicationClient.js +70 -2
  29. package/sdk/application/Order/OrderApplicationModel.d.ts +17 -0
  30. package/sdk/application/Order/OrderApplicationModel.js +129 -8
  31. package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -0
  32. package/sdk/application/Order/OrderApplicationValidator.js +7 -0
  33. package/sdk/application/Payment/PaymentApplicationClient.d.ts +35 -0
  34. package/sdk/application/Payment/PaymentApplicationClient.js +200 -0
  35. package/sdk/application/Payment/PaymentApplicationModel.d.ts +4 -0
  36. package/sdk/application/Payment/PaymentApplicationModel.js +58 -7
  37. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +3 -0
  38. package/sdk/application/Payment/PaymentApplicationValidator.js +19 -0
  39. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +16 -3
  40. package/sdk/application/PosCart/PosCartApplicationClient.js +39 -6
  41. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +10 -0
  42. package/sdk/application/PosCart/PosCartApplicationModel.js +113 -1
  43. package/sdk/application/PosCart/PosCartApplicationValidator.js +6 -0
  44. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +8 -8
  45. package/sdk/application/Rewards/RewardsApplicationClient.js +8 -8
  46. package/sdk/application/index.d.ts +10 -10
  47. package/sdk/application/index.js +13 -13
  48. package/sdk/common/AxiosHelper.js +1 -1
  49. package/sdk/common/Constant.d.ts +5 -0
  50. package/sdk/common/Constant.js +5 -0
  51. package/sdk/platform/Billing/BillingPlatformModel.js +6 -1
  52. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +479 -0
  53. package/sdk/platform/Cart/CartPlatformApplicationClient.js +2574 -307
  54. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +31 -0
  55. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +263 -0
  56. package/sdk/platform/Cart/CartPlatformModel.d.ts +61 -0
  57. package/sdk/platform/Cart/CartPlatformModel.js +697 -2
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +8 -2
  59. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +10 -0
  60. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +1 -0
  61. package/sdk/platform/Catalog/CatalogPlatformClient.js +2 -2
  62. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1 -0
  63. package/sdk/platform/Catalog/CatalogPlatformModel.js +41 -29
  64. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1 -0
  65. package/sdk/platform/Communication/CommunicationPlatformModel.js +9 -0
  66. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -2
  67. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +2 -2
  68. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +5 -4
  69. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +99 -78
  70. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +99 -78
  71. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +87 -71
  72. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +87 -71
  73. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -0
  74. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +26 -0
  75. package/sdk/platform/Content/ContentPlatformModel.js +4 -1
  76. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +10 -4
  77. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +15 -9
  78. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  79. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +1 -1
  80. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -2
  81. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -2
  82. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  83. package/sdk/platform/Finance/FinancePlatformClient.d.ts +135 -0
  84. package/sdk/platform/Finance/FinancePlatformClient.js +853 -0
  85. package/sdk/platform/Finance/FinancePlatformModel.d.ts +51 -0
  86. package/sdk/platform/Finance/FinancePlatformModel.js +342 -0
  87. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +16 -0
  88. package/sdk/platform/Finance/FinancePlatformValidator.js +84 -0
  89. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +11 -1
  90. package/sdk/platform/Order/OrderPlatformApplicationClient.js +66 -2
  91. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -0
  92. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -0
  93. package/sdk/platform/Order/OrderPlatformClient.d.ts +161 -81
  94. package/sdk/platform/Order/OrderPlatformClient.js +546 -119
  95. package/sdk/platform/Order/OrderPlatformModel.d.ts +42 -6
  96. package/sdk/platform/Order/OrderPlatformModel.js +570 -158
  97. package/sdk/platform/Order/OrderPlatformValidator.d.ts +6 -0
  98. package/sdk/platform/Order/OrderPlatformValidator.js +52 -10
  99. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +22 -0
  100. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +127 -0
  101. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +2 -0
  102. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +13 -0
  103. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +145 -0
  104. package/sdk/platform/Partner/PartnerPlatformClient.js +799 -0
  105. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +39 -0
  106. package/sdk/platform/Partner/PartnerPlatformModel.js +367 -0
  107. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +14 -0
  108. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -0
  109. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +221 -0
  110. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +1476 -190
  111. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +20 -0
  112. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +126 -0
  113. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +44 -0
  114. package/sdk/platform/Payment/PaymentPlatformModel.js +410 -0
  115. package/sdk/platform/PlatformApplicationClient.d.ts +1149 -930
  116. package/sdk/platform/PlatformApplicationClient.js +1260 -1027
  117. package/sdk/platform/PlatformClient.d.ts +10360 -8660
  118. package/sdk/platform/PlatformClient.js +11126 -9093
  119. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -26
  120. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +14 -74
  121. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -1
  122. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -7
  123. package/sdk/platform/index.d.ts +15 -14
  124. package/sdk/platform/index.js +20 -18
  125. package/sdk/public/PublicClient.d.ts +2 -2
  126. package/sdk/public/PublicClient.js +4 -4
  127. package/sdk/public/index.d.ts +1 -1
  128. package/sdk/public/index.js +2 -2
  129. package/partner.d.ts +0 -4
  130. package/partner.js +0 -7
  131. package/sdk/partner/OAuthClient.d.ts +0 -14
  132. package/sdk/partner/OAuthClient.js +0 -112
  133. package/sdk/partner/PartnerAPIClient.d.ts +0 -12
  134. package/sdk/partner/PartnerAPIClient.js +0 -42
  135. package/sdk/partner/PartnerClient.d.ts +0 -6
  136. package/sdk/partner/PartnerClient.js +0 -17
  137. package/sdk/partner/PartnerConfig.d.ts +0 -30
  138. package/sdk/partner/PartnerConfig.js +0 -39
  139. package/sdk/partner/index.d.ts +0 -3
  140. package/sdk/partner/index.js +0 -5
@@ -15,8 +15,8 @@ class Configuration {
15
15
  * @param {Object} arg - Arg object.
16
16
  * @param {CreateApplicationRequest} arg.body
17
17
  * @returns {Promise<CreateAppResponse>} - Success response
18
- * @summary: Create application
19
- * @description: Create new application
18
+ * @summary: Create a new sales channel
19
+ * @description: Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company.
20
20
  */
21
21
  async createApplication({ body } = {}) {
22
22
  const { error } = ConfigurationValidator.createApplication().validate(
@@ -81,10 +81,10 @@ class Configuration {
81
81
  * @param {Object} arg - Arg object.
82
82
  * @param {number} [arg.pageNo] -
83
83
  * @param {number} [arg.pageSize] -
84
- * @param {string} [arg.q] - Url encoded object used as mongodb query
84
+ * @param {string} [arg.q] - Search param by name or domain
85
85
  * @returns {Promise<ApplicationsResponse>} - Success response
86
- * @summary: Get list of application under company
87
- * @description: Get list of application under company
86
+ * @summary: Get list of registered sales channels under company
87
+ * @description: 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.
88
88
  */
89
89
  async getApplications({ pageNo, pageSize, q } = {}) {
90
90
  const { error } = ConfigurationValidator.getApplications().validate(
@@ -155,9 +155,9 @@ class Configuration {
155
155
  /**
156
156
  * @param {Object} arg - Arg object.
157
157
  * @param {number} [arg.pageSize] -
158
- * @param {string} [arg.q] - Url encoded object used as mongodb query
159
- * @summary: Get list of application under company
160
- * @description: Get list of application under company
158
+ * @param {string} [arg.q] - Search param by name or domain
159
+ * @summary: Get list of registered sales channels under company
160
+ * @description: 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.
161
161
  */
162
162
  getApplicationsPaginator({ pageSize, q } = {}) {
163
163
  const paginator = new Paginator();
@@ -182,11 +182,13 @@ class Configuration {
182
182
 
183
183
  /**
184
184
  * @param {Object} arg - Arg object.
185
- * @param {number} [arg.pageNo] - Current page no
186
- * @param {number} [arg.pageSize] - Current request items count
185
+ * @param {number} [arg.pageNo] - The page number to navigate through the
186
+ * given set of results. Default value is 1.
187
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
188
+ * page. Default value is 10.
187
189
  * @returns {Promise<GetIntegrationsOptInsResponse>} - Success response
188
190
  * @summary: Get all available integration opt-ins
189
- * @description: Get all available integration opt-ins
191
+ * @description: Use this API to get a list of all available integrations in a company
190
192
  */
191
193
  async getAvailableOptIns({ pageNo, pageSize } = {}) {
192
194
  const { error } = ConfigurationValidator.getAvailableOptIns().validate(
@@ -255,8 +257,8 @@ class Configuration {
255
257
  * @param {Object} arg - Arg object.
256
258
  * @param {string} [arg.q] - Search text for brand name
257
259
  * @returns {Promise<BrandsByCompanyResponse>} - Success response
258
- * @summary: Get brands by company
259
- * @description: Get brands by company
260
+ * @summary: Get brands by company.
261
+ * @description: Use this API to get all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image.
260
262
  */
261
263
  async getBrandsByCompany({ q } = {}) {
262
264
  const { error } = ConfigurationValidator.getBrandsByCompany().validate(
@@ -320,12 +322,14 @@ class Configuration {
320
322
 
321
323
  /**
322
324
  * @param {Object} arg - Arg object.
323
- * @param {number} [arg.pageNo] - Current page no
324
- * @param {number} [arg.pageSize] - Current request items count
325
+ * @param {number} [arg.pageNo] - The page number to navigate through the
326
+ * given set of results. Default value is 1.
327
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
328
+ * page. Default value is 10.
325
329
  * @param {CompanyByBrandsRequest} arg.body
326
330
  * @returns {Promise<CompanyByBrandsResponse>} - Success response
327
331
  * @summary: Get company by brand uids
328
- * @description: Get company by brand uids
332
+ * @description: Use this API to get a list of companies by the brands they deal
329
333
  */
330
334
  async getCompanyByBrands({ body, pageNo, pageSize } = {}) {
331
335
  const { error } = ConfigurationValidator.getCompanyByBrands().validate(
@@ -394,10 +398,11 @@ class Configuration {
394
398
 
395
399
  /**
396
400
  * @param {Object} arg - Arg object.
397
- * @param {number} [arg.pageSize] - Current request items count
401
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
402
+ * page. Default value is 10.
398
403
  * @param {CompanyByBrandsRequest} arg.body
399
404
  * @summary: Get company by brand uids
400
- * @description: Get company by brand uids
405
+ * @description: Use this API to get a list of companies by the brands they deal
401
406
  */
402
407
  getCompanyByBrandsPaginator({ pageSize, body } = {}) {
403
408
  const paginator = new Paginator();
@@ -424,7 +429,7 @@ class Configuration {
424
429
  * @param {Object} arg - Arg object.
425
430
  * @returns {Promise<CurrenciesResponse>} - Success response
426
431
  * @summary: Get all currencies
427
- * @description: Get all currencies
432
+ * @description: 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.
428
433
  */
429
434
  async getCurrencies({} = {}) {
430
435
  const { error } = ConfigurationValidator.getCurrencies().validate(
@@ -483,8 +488,8 @@ class Configuration {
483
488
  * @param {Object} arg - Arg object.
484
489
  * @param {DomainSuggestionsRequest} arg.body
485
490
  * @returns {Promise<DomainSuggestionsResponse>} - Success response
486
- * @summary: Check domain availibility before linking to application
487
- * @description: Check domain availibility before linking to application. Also sends domain suggestions with similar to queried domain. \ Custom domain search is currently powered by GoDaddy provider.
491
+ * @summary: Check domain availability before linking to application
492
+ * @description: 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.
488
493
  */
489
494
  async getDomainAvailibility({ body } = {}) {
490
495
  const { error } = ConfigurationValidator.getDomainAvailibility().validate(
@@ -549,8 +554,8 @@ class Configuration {
549
554
  * @param {Object} arg - Arg object.
550
555
  * @param {number} arg.id - Integration id
551
556
  * @returns {Promise<Integration>} - Success response
552
- * @summary: Get integration data
553
- * @description: Get integration data
557
+ * @summary: Get integration data by its ID
558
+ * @description: Use this API to fetch the details of an integration (such as Ginesys, SAP, etc.) using its ID
554
559
  */
555
560
  async getIntegrationById({ id } = {}) {
556
561
  const { error } = ConfigurationValidator.getIntegrationById().validate(
@@ -613,12 +618,12 @@ class Configuration {
613
618
 
614
619
  /**
615
620
  * @param {Object} arg - Arg object.
616
- * @param {string} arg.id - Integration id
617
- * @param {string} arg.level - Integration level
618
- * @param {number} arg.uid - Integration level uid
621
+ * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
622
+ * @param {string} arg.level - Integration level, `store` or `company`
623
+ * @param {number} arg.uid - Unique identifier of integration level (store/company)
619
624
  * @returns {Promise<IntegrationLevel>} - Success response
620
- * @summary: Get level data for integration
621
- * @description: Get level data for integration
625
+ * @summary: Get integration config at a particular level (store/company)
626
+ * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).
622
627
  */
623
628
  async getIntegrationByLevelId({ id, level, uid } = {}) {
624
629
  const { error } = ConfigurationValidator.getIntegrationByLevelId().validate(
@@ -685,13 +690,15 @@ class Configuration {
685
690
 
686
691
  /**
687
692
  * @param {Object} arg - Arg object.
688
- * @param {string} arg.id - Integration id
689
- * @param {string} arg.level - Integration level
690
- * @param {boolean} [arg.opted] - Filter on opted stores
691
- * @param {boolean} [arg.checkPermission] - Filter on if permissions are present
693
+ * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
694
+ * @param {string} arg.level - Store or company
695
+ * @param {boolean} [arg.opted] - True means get the opted stores. False
696
+ * means get the stores that aren't opted.
697
+ * @param {boolean} [arg.checkPermission] - Filter on if permissions (for
698
+ * inventory/order) are present
692
699
  * @returns {Promise<IntegrationConfigResponse>} - Success response
693
700
  * @summary: Get integration level config
694
- * @description: Get integration/integration-opt-in level config
701
+ * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc.
695
702
  */
696
703
  async getIntegrationLevelConfig({ id, level, opted, checkPermission } = {}) {
697
704
  const {
@@ -764,12 +771,12 @@ class Configuration {
764
771
 
765
772
  /**
766
773
  * @param {Object} arg - Arg object.
767
- * @param {string} arg.id - Integration id
768
- * @param {string} arg.level - Integration level
769
- * @param {number} arg.uid - Integration level uid
774
+ * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
775
+ * @param {string} arg.level - Integration level, `store` or `company`
776
+ * @param {number} arg.uid - Unique identifier of integration level (store/company)
770
777
  * @returns {Promise<OptedStoreIntegration>} - Success response
771
- * @summary: Check store has active integration
772
- * @description: API checks if a store is already opted in any other integrations
778
+ * @summary: Check active integration at store
779
+ * @description: Use this API to check if a store is already opted-in for any integration
773
780
  */
774
781
  async getLevelActiveIntegrations({ id, level, uid } = {}) {
775
782
  const {
@@ -841,8 +848,8 @@ class Configuration {
841
848
  * @param {Object} arg - Arg object.
842
849
  * @param {string} arg.id - Application Id
843
850
  * @returns {Promise<OptedApplicationResponse>} - Success response
844
- * @summary: Get other seller applications
845
- * @description: Get other seller application
851
+ * @summary: Get other seller's sales channel by ID
852
+ * @description: Use application ID to fetch details of a seller application that was not created within the current company. but has opted for the current company's inventory
846
853
  */
847
854
  async getOtherSellerApplicationById({ id } = {}) {
848
855
  const {
@@ -909,11 +916,13 @@ class Configuration {
909
916
 
910
917
  /**
911
918
  * @param {Object} arg - Arg object.
912
- * @param {number} [arg.pageNo] - Current page no
913
- * @param {number} [arg.pageSize] - Current request items count
919
+ * @param {number} [arg.pageNo] - The page number to navigate through the
920
+ * given set of results. Default value is 1.
921
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
922
+ * page. Default value is 10.
914
923
  * @returns {Promise<OtherSellerApplications>} - Success response
915
- * @summary: Get other seller applications
916
- * @description: Get other seller applications who has opted current company as inventory
924
+ * @summary: Get other seller sales channels
925
+ * @description: Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory
917
926
  */
918
927
  async getOtherSellerApplications({ pageNo, pageSize } = {}) {
919
928
  const {
@@ -983,9 +992,10 @@ class Configuration {
983
992
 
984
993
  /**
985
994
  * @param {Object} arg - Arg object.
986
- * @param {number} [arg.pageSize] - Current request items count
987
- * @summary: Get other seller applications
988
- * @description: Get other seller applications who has opted current company as inventory
995
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
996
+ * page. Default value is 10.
997
+ * @summary: Get other seller sales channels
998
+ * @description: Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory
989
999
  */
990
1000
  getOtherSellerApplicationsPaginator({ pageSize } = {}) {
991
1001
  const paginator = new Paginator();
@@ -1009,13 +1019,15 @@ class Configuration {
1009
1019
 
1010
1020
  /**
1011
1021
  * @param {Object} arg - Arg object.
1012
- * @param {string} arg.level - Integration level
1013
- * @param {number} arg.uid - Integration level uid
1014
- * @param {number} [arg.pageNo] - Current page no
1015
- * @param {number} [arg.pageSize] - Current request items count
1022
+ * @param {string} arg.level - Store or company
1023
+ * @param {number} arg.uid - Unique identifier of the selected integration level.
1024
+ * @param {number} [arg.pageNo] - The page number to navigate through the
1025
+ * given set of results. Default value is 1.
1026
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
1027
+ * page. Default value is 10.
1016
1028
  * @returns {Promise<GetIntegrationsOptInsResponse>} - Success response
1017
1029
  * @summary: Get company/store level integration opt-ins
1018
- * @description: Get company/store level integration opt-ins
1030
+ * @description: Use this API to get the store-level/company-level integrations configured in a company
1019
1031
  */
1020
1032
  async getSelectedOptIns({ level, uid, pageNo, pageSize } = {}) {
1021
1033
  const { error } = ConfigurationValidator.getSelectedOptIns().validate(
@@ -1086,12 +1098,14 @@ class Configuration {
1086
1098
 
1087
1099
  /**
1088
1100
  * @param {Object} arg - Arg object.
1089
- * @param {number} [arg.pageNo] - Current page no
1090
- * @param {number} [arg.pageSize] - Current request items count
1101
+ * @param {number} [arg.pageNo] - The page number to navigate through the
1102
+ * given set of results. Default value is 1.
1103
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
1104
+ * page. Default value is 10.
1091
1105
  * @param {StoreByBrandsRequest} arg.body
1092
1106
  * @returns {Promise<StoreByBrandsResponse>} - Success response
1093
- * @summary: Get stores by brand uids
1094
- * @description: Get stores by brand uids
1107
+ * @summary: Get stores by brand uids for the current company
1108
+ * @description: Use this API to get 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.
1095
1109
  */
1096
1110
  async getStoreByBrands({ body, pageNo, pageSize } = {}) {
1097
1111
  const { error } = ConfigurationValidator.getStoreByBrands().validate(
@@ -1160,10 +1174,11 @@ class Configuration {
1160
1174
 
1161
1175
  /**
1162
1176
  * @param {Object} arg - Arg object.
1163
- * @param {number} [arg.pageSize] - Current request items count
1177
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each
1178
+ * page. Default value is 10.
1164
1179
  * @param {StoreByBrandsRequest} arg.body
1165
- * @summary: Get stores by brand uids
1166
- * @description: Get stores by brand uids
1180
+ * @summary: Get stores by brand uids for the current company
1181
+ * @description: Use this API to get 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.
1167
1182
  */
1168
1183
  getStoreByBrandsPaginator({ pageSize, body } = {}) {
1169
1184
  const paginator = new Paginator();
@@ -1188,11 +1203,12 @@ class Configuration {
1188
1203
 
1189
1204
  /**
1190
1205
  * @param {Object} arg - Arg object.
1191
- * @param {string} arg.id - Application Id
1206
+ * @param {string} arg.id - Alphanumeric ID allotted to an application
1207
+ * (sales channel website) created within a business account.
1192
1208
  * @param {OptOutInventory} arg.body
1193
1209
  * @returns {Promise<SuccessMessageResponse>} - Success response
1194
- * @summary: Opt out company or store from other seller application
1195
- * @description: Opt out company or store from other seller application
1210
+ * @summary: Opt-out company or store from other seller application
1211
+ * @description: Use this API 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.
1196
1212
  */
1197
1213
  async optOutFromApplication({ id, body } = {}) {
1198
1214
  const { error } = ConfigurationValidator.optOutFromApplication().validate(
@@ -1257,12 +1273,12 @@ class Configuration {
1257
1273
 
1258
1274
  /**
1259
1275
  * @param {Object} arg - Arg object.
1260
- * @param {string} arg.id - Integration id
1261
- * @param {string} arg.level - Integration level
1276
+ * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
1277
+ * @param {string} arg.level - Integration level, `store` or `company`
1262
1278
  * @param {UpdateIntegrationLevelRequest} arg.body
1263
1279
  * @returns {Promise<IntegrationLevel>} - Success response
1264
- * @summary: Update a store level opt-in for integration
1265
- * @description: Update a store level opt-in for integration
1280
+ * @summary: Update a store level integration you opted
1281
+ * @description: Use this API to 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).
1266
1282
  */
1267
1283
  async updateLevelIntegration({ id, level, body } = {}) {
1268
1284
  const { error } = ConfigurationValidator.updateLevelIntegration().validate(
@@ -1329,13 +1345,13 @@ class Configuration {
1329
1345
 
1330
1346
  /**
1331
1347
  * @param {Object} arg - Arg object.
1332
- * @param {string} arg.id - Integration id
1333
- * @param {string} arg.level - Integration level
1334
- * @param {number} arg.uid - Integration level uid
1348
+ * @param {string} arg.id - Integration ID (24-digit Mongo Object ID)
1349
+ * @param {string} arg.level - Integration level, `store` or `company`
1350
+ * @param {number} arg.uid - Unique identifier of integration level (store/company)
1335
1351
  * @param {IntegrationLevel} arg.body
1336
1352
  * @returns {Promise<IntegrationLevel>} - Success response
1337
- * @summary: Update a store level opt-in for integration
1338
- * @description: Update a store level opt-in for integration
1353
+ * @summary: Update integration level by store UID
1354
+ * @description: Update the level of integration by store UID
1339
1355
  */
1340
1356
  async updateLevelUidIntegration({ id, level, uid, body } = {}) {
1341
1357
  const {
@@ -147,6 +147,7 @@ declare class ConfigurationModel {
147
147
  static OtherSellerApplications(): any;
148
148
  static OtherSellerCompany(): any;
149
149
  static Page(): any;
150
+ static PanCardConfig(): any;
150
151
  static PaymentModeConfig(): any;
151
152
  static PaymentSelectionLock(): any;
152
153
  static PcrFeature(): any;
@@ -181,6 +182,7 @@ declare class ConfigurationModel {
181
182
  static UpdateIntegrationLevelRequest(): any;
182
183
  static UserEmail(): any;
183
184
  static UserPhoneNumber(): any;
185
+ static ValidationFailedResponse(): any;
184
186
  static Validators(): any;
185
187
  static VimeoLink(): any;
186
188
  static YoutubeLink(): any;
@@ -23,6 +23,7 @@ class ConfigurationModel {
23
23
  enabled: Joi.boolean(),
24
24
  max_cart_items: Joi.number(),
25
25
  min_cart_value: Joi.number(),
26
+ pan_card: ConfigurationModel.PanCardConfig(),
26
27
  revenue_engine_coupon: Joi.boolean(),
27
28
  });
28
29
  }
@@ -255,6 +256,7 @@ class ConfigurationModel {
255
256
  }
256
257
  static AppPaymentConfig() {
257
258
  return Joi.object({
259
+ anonymous_cod: Joi.boolean(),
258
260
  callback_url: ConfigurationModel.CallbackUrl(),
259
261
  cod_amount_limit: Joi.number(),
260
262
  cod_charges: Joi.number(),
@@ -568,7 +570,13 @@ class ConfigurationModel {
568
570
  }
569
571
  static DomainAdd() {
570
572
  return Joi.object({
573
+ _id: Joi.string().allow(""),
574
+ is_primary: Joi.boolean(),
575
+ is_shortlink: Joi.boolean(),
576
+ message: Joi.string().allow(""),
571
577
  name: Joi.string().allow(""),
578
+ txt_records: Joi.array().items(Joi.string().allow("")),
579
+ verified: Joi.boolean(),
572
580
  });
573
581
  }
574
582
  static DomainAddRequest() {
@@ -930,6 +938,7 @@ class ConfigurationModel {
930
938
  }
931
939
  static ListingPriceFeature() {
932
940
  return Joi.object({
941
+ sort: Joi.string().allow(""),
933
942
  value: Joi.string().allow(""),
934
943
  });
935
944
  }
@@ -1170,6 +1179,13 @@ class ConfigurationModel {
1170
1179
  type: Joi.string().allow("").required(),
1171
1180
  });
1172
1181
  }
1182
+ static PanCardConfig() {
1183
+ return Joi.object({
1184
+ cod_threshold_amount: Joi.number(),
1185
+ enabled: Joi.boolean(),
1186
+ online_threshold_amount: Joi.number(),
1187
+ });
1188
+ }
1173
1189
  static PaymentModeConfig() {
1174
1190
  return Joi.object({
1175
1191
  enabled: Joi.boolean(),
@@ -1323,6 +1339,7 @@ class ConfigurationModel {
1323
1339
  static SuccessMessageResponse() {
1324
1340
  return Joi.object({
1325
1341
  message: Joi.string().allow(""),
1342
+ success: Joi.boolean(),
1326
1343
  });
1327
1344
  }
1328
1345
  static TokenResponse() {
@@ -1362,6 +1379,10 @@ class ConfigurationModel {
1362
1379
  static UpdateDomain() {
1363
1380
  return Joi.object({
1364
1381
  _id: Joi.string().allow(""),
1382
+ is_primary: Joi.boolean(),
1383
+ is_shortlink: Joi.boolean(),
1384
+ name: Joi.string().allow(""),
1385
+ verified: Joi.boolean(),
1365
1386
  });
1366
1387
  }
1367
1388
  static UpdateDomainTypeRequest() {
@@ -1392,6 +1413,11 @@ class ConfigurationModel {
1392
1413
  verified: Joi.boolean(),
1393
1414
  });
1394
1415
  }
1416
+ static ValidationFailedResponse() {
1417
+ return Joi.object({
1418
+ message: Joi.string().allow(""),
1419
+ });
1420
+ }
1395
1421
  static Validators() {
1396
1422
  return Joi.object({
1397
1423
  company: ConfigurationModel.CompanyValidator(),
@@ -347,6 +347,7 @@ class ContentModel {
347
347
  static Detail() {
348
348
  return Joi.object({
349
349
  description: Joi.string().allow(""),
350
+ image_url: Joi.string().allow(""),
350
351
  title: Joi.string().allow(""),
351
352
  });
352
353
  }
@@ -957,7 +958,9 @@ class ContentModel {
957
958
 
958
959
  "shipping-policy",
959
960
 
960
- "return-policy"
961
+ "return-policy",
962
+
963
+ "order-status"
961
964
  );
962
965
  }
963
966
  }
@@ -5,7 +5,10 @@ declare class FileStorage {
5
5
  applicationId: any;
6
6
  /**
7
7
  * @param {Object} arg - Arg object.
8
- * @param {string} arg.namespace - Bucket name
8
+ * @param {string} arg.namespace - Segregation of different types of
9
+ * files(products, orders, logistics etc), Required for validating the
10
+ * data of the file being uploaded, decides where exactly the file will be
11
+ * stored inside the storage bucket.
9
12
  * @param {StartResponse} arg.body
10
13
  * @returns {Promise<CompleteResponse>} - Success response
11
14
  * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -46,7 +49,10 @@ declare class FileStorage {
46
49
  }): Promise<BulkUploadResponse>;
47
50
  /**
48
51
  * @param {Object} arg - Arg object.
49
- * @param {string} arg.namespace - Bucket name
52
+ * @param {string} arg.namespace - Segregation of different types of
53
+ * files(products, orders, logistics etc), Required for validating the
54
+ * data of the file being uploaded, decides where exactly the file will be
55
+ * stored inside the storage bucket.
50
56
  * @param {StartRequest} arg.body
51
57
  * @returns {Promise<StartResponse>} - Success response
52
58
  * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
@@ -81,7 +87,7 @@ declare class FileStorage {
81
87
  * @summary: Browse Files
82
88
  * @description: Browse Files
83
89
  */
84
- browse({ namespace, pageNo, }?: {
90
+ appbrowse({ namespace, pageNo, }?: {
85
91
  namespace: string;
86
92
  pageNo?: number;
87
93
  }): Promise<BrowseResponse>;
@@ -93,7 +99,7 @@ declare class FileStorage {
93
99
  * @summary: Browse Files
94
100
  * @description: Browse Files
95
101
  */
96
- browsePaginator({ namespace, companyId, applicationId }?: {
102
+ appbrowsePaginator({ namespace, companyId, applicationId }?: {
97
103
  namespace: string;
98
104
  companyId: number;
99
105
  applicationId: number;
@@ -16,7 +16,10 @@ class FileStorage {
16
16
 
17
17
  /**
18
18
  * @param {Object} arg - Arg object.
19
- * @param {string} arg.namespace - Bucket name
19
+ * @param {string} arg.namespace - Segregation of different types of
20
+ * files(products, orders, logistics etc), Required for validating the
21
+ * data of the file being uploaded, decides where exactly the file will be
22
+ * stored inside the storage bucket.
20
23
  * @param {StartResponse} arg.body
21
24
  * @returns {Promise<CompleteResponse>} - Success response
22
25
  * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -170,7 +173,10 @@ class FileStorage {
170
173
 
171
174
  /**
172
175
  * @param {Object} arg - Arg object.
173
- * @param {string} arg.namespace - Bucket name
176
+ * @param {string} arg.namespace - Segregation of different types of
177
+ * files(products, orders, logistics etc), Required for validating the
178
+ * data of the file being uploaded, decides where exactly the file will be
179
+ * stored inside the storage bucket.
174
180
  * @param {StartRequest} arg.body
175
181
  * @returns {Promise<StartResponse>} - Success response
176
182
  * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
@@ -263,12 +269,12 @@ class FileStorage {
263
269
  * @summary: Browse Files
264
270
  * @description: Browse Files
265
271
  */
266
- async browse({
272
+ async appbrowse({
267
273
  namespace,
268
274
 
269
275
  pageNo,
270
276
  } = {}) {
271
- const { error } = FileStorageValidator.browse().validate(
277
+ const { error } = FileStorageValidator.appbrowse().validate(
272
278
  {
273
279
  namespace,
274
280
 
@@ -281,7 +287,7 @@ class FileStorage {
281
287
  }
282
288
 
283
289
  // Showing warrnings if extra unknown parameters are found
284
- const { error: warrning } = FileStorageValidator.browse().validate(
290
+ const { error: warrning } = FileStorageValidator.appbrowse().validate(
285
291
  {
286
292
  namespace,
287
293
 
@@ -292,7 +298,7 @@ class FileStorage {
292
298
  if (warrning) {
293
299
  Logger({
294
300
  level: "WARN",
295
- message: "Parameter Validation warrnings for browse",
301
+ message: "Parameter Validation warrnings for appbrowse",
296
302
  });
297
303
  Logger({ level: "WARN", message: warrning });
298
304
  }
@@ -318,7 +324,7 @@ class FileStorage {
318
324
  if (res_error) {
319
325
  Logger({
320
326
  level: "WARN",
321
- message: "Response Validation Warnnings for browse",
327
+ message: "Response Validation Warnnings for appbrowse",
322
328
  });
323
329
  Logger({ level: "WARN", message: res_error });
324
330
  }
@@ -334,13 +340,13 @@ class FileStorage {
334
340
  * @summary: Browse Files
335
341
  * @description: Browse Files
336
342
  */
337
- browsePaginator({ namespace, companyId, applicationId } = {}) {
343
+ appbrowsePaginator({ namespace, companyId, applicationId } = {}) {
338
344
  const paginator = new Paginator();
339
345
  const callback = async () => {
340
346
  const pageId = paginator.nextId;
341
347
  const pageNo = paginator.pageNo;
342
348
  const pageType = "number";
343
- const data = await this.browse({
349
+ const data = await this.appbrowse({
344
350
  namespace: namespace,
345
351
  companyId: companyId,
346
352
  applicationId: applicationId,
@@ -3,5 +3,5 @@ declare class FileStorageValidator {
3
3
  static appCompleteUpload(): any;
4
4
  static appCopyFiles(): any;
5
5
  static appStartUpload(): any;
6
- static browse(): any;
6
+ static appbrowse(): any;
7
7
  }
@@ -26,7 +26,7 @@ class FileStorageValidator {
26
26
  }).required();
27
27
  }
28
28
 
29
- static browse() {
29
+ static appbrowse() {
30
30
  return Joi.object({
31
31
  namespace: Joi.string().allow("").required(),
32
32
 
@@ -25,7 +25,10 @@ declare class FileStorage {
25
25
  }): Paginator;
26
26
  /**
27
27
  * @param {Object} arg - Arg object.
28
- * @param {string} arg.namespace - Bucket name
28
+ * @param {string} arg.namespace - Segregation of different types of
29
+ * files(products, orders, logistics etc), Required for validating the
30
+ * data of the file being uploaded, decides where exactly the file will be
31
+ * stored inside the storage bucket.
29
32
  * @param {StartResponse} arg.body
30
33
  * @returns {Promise<CompleteResponse>} - Success response
31
34
  * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -86,7 +89,10 @@ declare class FileStorage {
86
89
  }): Promise<string>;
87
90
  /**
88
91
  * @param {Object} arg - Arg object.
89
- * @param {string} arg.namespace - Bucket name
92
+ * @param {string} arg.namespace - Segregation of different types of
93
+ * files(products, orders, logistics etc), Required for validating the
94
+ * data of the file being uploaded, decides where exactly the file will be
95
+ * stored inside the storage bucket.
90
96
  * @param {StartRequest} arg.body
91
97
  * @returns {Promise<StartResponse>} - Success response
92
98
  * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
@@ -116,7 +116,10 @@ class FileStorage {
116
116
 
117
117
  /**
118
118
  * @param {Object} arg - Arg object.
119
- * @param {string} arg.namespace - Bucket name
119
+ * @param {string} arg.namespace - Segregation of different types of
120
+ * files(products, orders, logistics etc), Required for validating the
121
+ * data of the file being uploaded, decides where exactly the file will be
122
+ * stored inside the storage bucket.
120
123
  * @param {StartResponse} arg.body
121
124
  * @returns {Promise<CompleteResponse>} - Success response
122
125
  * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
@@ -400,7 +403,10 @@ class FileStorage {
400
403
 
401
404
  /**
402
405
  * @param {Object} arg - Arg object.
403
- * @param {string} arg.namespace - Bucket name
406
+ * @param {string} arg.namespace - Segregation of different types of
407
+ * files(products, orders, logistics etc), Required for validating the
408
+ * data of the file being uploaded, decides where exactly the file will be
409
+ * stored inside the storage bucket.
404
410
  * @param {StartRequest} arg.body
405
411
  * @returns {Promise<StartResponse>} - Success response
406
412
  * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
@@ -22,8 +22,8 @@ class FileStorageModel {
22
22
  }
23
23
  static CDN() {
24
24
  return Joi.object({
25
- absolute_url: Joi.string().allow(""),
26
- relative_url: Joi.string().allow(""),
25
+ absolute_url: Joi.string().allow("").required(),
26
+ relative_url: Joi.string().allow("").required(),
27
27
  url: Joi.string().allow("").required(),
28
28
  });
29
29
  }