@gofynd/fdk-client-javascript 0.1.35

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 (277) hide show
  1. package/.github/workflows/on_create_release.yml +23 -0
  2. package/.github/workflows/on_merge_main.yml +38 -0
  3. package/.github/workflows/on_pull_request.yml +35 -0
  4. package/.prettierrc +5 -0
  5. package/LICENSE +21 -0
  6. package/README.md +118 -0
  7. package/application.d.ts +3 -0
  8. package/application.js +6 -0
  9. package/common.d.ts +4 -0
  10. package/common.js +9 -0
  11. package/documentation/application/CART.md +7290 -0
  12. package/documentation/application/CATALOG.md +9570 -0
  13. package/documentation/application/COMMON.md +448 -0
  14. package/documentation/application/COMMUNICATION.md +463 -0
  15. package/documentation/application/CONFIGURATION.md +2902 -0
  16. package/documentation/application/CONTENT.md +3350 -0
  17. package/documentation/application/FILESTORAGE.md +491 -0
  18. package/documentation/application/LEAD.md +1891 -0
  19. package/documentation/application/LOGISTIC.md +439 -0
  20. package/documentation/application/ORDER.md +3428 -0
  21. package/documentation/application/PAYMENT.md +5035 -0
  22. package/documentation/application/POSCART.md +7889 -0
  23. package/documentation/application/README.md +21 -0
  24. package/documentation/application/REWARDS.md +714 -0
  25. package/documentation/application/SHARE.md +729 -0
  26. package/documentation/application/THEME.md +5796 -0
  27. package/documentation/application/USER.md +4326 -0
  28. package/documentation/platform/ANALYTICS.md +1150 -0
  29. package/documentation/platform/AUDITTRAIL.md +572 -0
  30. package/documentation/platform/BILLING.md +2396 -0
  31. package/documentation/platform/CART.md +5539 -0
  32. package/documentation/platform/CATALOG.md +21624 -0
  33. package/documentation/platform/COMMON.md +448 -0
  34. package/documentation/platform/COMMUNICATION.md +5714 -0
  35. package/documentation/platform/COMPANYPROFILE.md +2141 -0
  36. package/documentation/platform/CONFIGURATION.md +7335 -0
  37. package/documentation/platform/CONTENT.md +8989 -0
  38. package/documentation/platform/DISCOUNT.md +773 -0
  39. package/documentation/platform/FILESTORAGE.md +994 -0
  40. package/documentation/platform/INVENTORY.md +1775 -0
  41. package/documentation/platform/LEAD.md +4736 -0
  42. package/documentation/platform/ORDER.md +3764 -0
  43. package/documentation/platform/PARTNER.md +216 -0
  44. package/documentation/platform/PAYMENT.md +3444 -0
  45. package/documentation/platform/README.md +27 -0
  46. package/documentation/platform/REWARDS.md +871 -0
  47. package/documentation/platform/SHARE.md +602 -0
  48. package/documentation/platform/THEME.md +35725 -0
  49. package/documentation/platform/USER.md +2305 -0
  50. package/documentation/platform/WEBHOOK.md +587 -0
  51. package/documentation/public/CONFIGURATION.md +448 -0
  52. package/documentation/public/INVENTORY.md +686 -0
  53. package/documentation/public/WEBHOOK.md +348 -0
  54. package/index.d.ts +10 -0
  55. package/index.js +18 -0
  56. package/jest.config.d.ts +4 -0
  57. package/jest.config.js +6 -0
  58. package/package.json +35 -0
  59. package/platform.d.ts +3 -0
  60. package/platform.js +6 -0
  61. package/public.d.ts +3 -0
  62. package/public.js +6 -0
  63. package/sdk/application/ApplicationAPIClient.d.ts +11 -0
  64. package/sdk/application/ApplicationAPIClient.js +44 -0
  65. package/sdk/application/ApplicationClient.d.ts +40 -0
  66. package/sdk/application/ApplicationClient.js +84 -0
  67. package/sdk/application/ApplicationConfig.d.ts +19 -0
  68. package/sdk/application/ApplicationConfig.js +55 -0
  69. package/sdk/application/ApplicationModels.d.ts +826 -0
  70. package/sdk/application/ApplicationModels.js +10474 -0
  71. package/sdk/application/client/CartApplicationClient.d.ts +432 -0
  72. package/sdk/application/client/CartApplicationClient.js +1066 -0
  73. package/sdk/application/client/CatalogApplicationClient.d.ts +694 -0
  74. package/sdk/application/client/CatalogApplicationClient.js +1629 -0
  75. package/sdk/application/client/CommonApplicationClient.d.ts +38 -0
  76. package/sdk/application/client/CommonApplicationClient.js +105 -0
  77. package/sdk/application/client/CommunicationApplicationClient.d.ts +39 -0
  78. package/sdk/application/client/CommunicationApplicationClient.js +131 -0
  79. package/sdk/application/client/ConfigurationApplicationClient.d.ts +210 -0
  80. package/sdk/application/client/ConfigurationApplicationClient.js +649 -0
  81. package/sdk/application/client/ContentApplicationClient.d.ts +256 -0
  82. package/sdk/application/client/ContentApplicationClient.js +785 -0
  83. package/sdk/application/client/FileStorageApplicationClient.d.ts +88 -0
  84. package/sdk/application/client/FileStorageApplicationClient.js +214 -0
  85. package/sdk/application/client/LeadApplicationClient.d.ts +90 -0
  86. package/sdk/application/client/LeadApplicationClient.js +264 -0
  87. package/sdk/application/client/LogisticApplicationClient.d.ts +42 -0
  88. package/sdk/application/client/LogisticApplicationClient.js +128 -0
  89. package/sdk/application/client/OrderApplicationClient.d.ts +190 -0
  90. package/sdk/application/client/OrderApplicationClient.js +479 -0
  91. package/sdk/application/client/PaymentApplicationClient.d.ts +454 -0
  92. package/sdk/application/client/PaymentApplicationClient.js +1378 -0
  93. package/sdk/application/client/PosCartApplicationClient.d.ts +449 -0
  94. package/sdk/application/client/PosCartApplicationClient.js +1123 -0
  95. package/sdk/application/client/RewardsApplicationClient.d.ts +93 -0
  96. package/sdk/application/client/RewardsApplicationClient.js +293 -0
  97. package/sdk/application/client/ShareApplicationClient.d.ts +87 -0
  98. package/sdk/application/client/ShareApplicationClient.js +268 -0
  99. package/sdk/application/client/ThemeApplicationClient.d.ts +52 -0
  100. package/sdk/application/client/ThemeApplicationClient.js +161 -0
  101. package/sdk/application/client/UserApplicationClient.d.ts +446 -0
  102. package/sdk/application/client/UserApplicationClient.js +1275 -0
  103. package/sdk/application/constructUrl.d.ts +5 -0
  104. package/sdk/application/constructUrl.js +13 -0
  105. package/sdk/application/index.d.ts +2 -0
  106. package/sdk/application/index.js +4 -0
  107. package/sdk/application/models/CartValidator.d.ts +29 -0
  108. package/sdk/application/models/CartValidator.js +223 -0
  109. package/sdk/application/models/CatalogValidator.d.ts +33 -0
  110. package/sdk/application/models/CatalogValidator.js +233 -0
  111. package/sdk/application/models/CommonValidator.d.ts +5 -0
  112. package/sdk/application/models/CommonValidator.js +18 -0
  113. package/sdk/application/models/CommunicationValidator.d.ts +6 -0
  114. package/sdk/application/models/CommunicationValidator.js +20 -0
  115. package/sdk/application/models/ConfigurationValidator.d.ts +19 -0
  116. package/sdk/application/models/ConfigurationValidator.js +88 -0
  117. package/sdk/application/models/ContentValidator.d.ts +22 -0
  118. package/sdk/application/models/ContentValidator.js +106 -0
  119. package/sdk/application/models/FileStorageValidator.d.ts +6 -0
  120. package/sdk/application/models/FileStorageValidator.js +24 -0
  121. package/sdk/application/models/LeadValidator.d.ts +10 -0
  122. package/sdk/application/models/LeadValidator.js +48 -0
  123. package/sdk/application/models/LogisticValidator.d.ts +6 -0
  124. package/sdk/application/models/LogisticValidator.js +22 -0
  125. package/sdk/application/models/OrderValidator.d.ts +15 -0
  126. package/sdk/application/models/OrderValidator.js +87 -0
  127. package/sdk/application/models/PaymentValidator.d.ts +40 -0
  128. package/sdk/application/models/PaymentValidator.js +235 -0
  129. package/sdk/application/models/PosCartValidator.d.ts +30 -0
  130. package/sdk/application/models/PosCartValidator.js +232 -0
  131. package/sdk/application/models/RewardsValidator.d.ts +10 -0
  132. package/sdk/application/models/RewardsValidator.js +43 -0
  133. package/sdk/application/models/ShareValidator.d.ts +10 -0
  134. package/sdk/application/models/ShareValidator.js +44 -0
  135. package/sdk/application/models/ThemeValidator.d.ts +7 -0
  136. package/sdk/application/models/ThemeValidator.js +27 -0
  137. package/sdk/application/models/UserValidator.d.ts +38 -0
  138. package/sdk/application/models/UserValidator.js +233 -0
  139. package/sdk/common/AxiosHelper.d.ts +1 -0
  140. package/sdk/common/AxiosHelper.js +141 -0
  141. package/sdk/common/Constant.d.ts +294 -0
  142. package/sdk/common/Constant.js +332 -0
  143. package/sdk/common/FDKError.d.ts +26 -0
  144. package/sdk/common/FDKError.js +51 -0
  145. package/sdk/common/Logger.d.ts +2 -0
  146. package/sdk/common/Logger.js +85 -0
  147. package/sdk/common/Paginator.d.ts +16 -0
  148. package/sdk/common/Paginator.js +26 -0
  149. package/sdk/common/RequestSigner.d.ts +1 -0
  150. package/sdk/common/RequestSigner.js +306 -0
  151. package/sdk/common/Utility.d.ts +9 -0
  152. package/sdk/common/Utility.js +86 -0
  153. package/sdk/common/utils.d.ts +14 -0
  154. package/sdk/common/utils.js +165 -0
  155. package/sdk/platform/OAuthClient.d.ts +26 -0
  156. package/sdk/platform/OAuthClient.js +221 -0
  157. package/sdk/platform/PlatformAPIClient.d.ts +12 -0
  158. package/sdk/platform/PlatformAPIClient.js +43 -0
  159. package/sdk/platform/PlatformApplicationClient.d.ts +24398 -0
  160. package/sdk/platform/PlatformApplicationClient.js +23185 -0
  161. package/sdk/platform/PlatformApplicationModels.d.ts +333 -0
  162. package/sdk/platform/PlatformApplicationModels.js +21262 -0
  163. package/sdk/platform/PlatformClient.d.ts +9535 -0
  164. package/sdk/platform/PlatformClient.js +12336 -0
  165. package/sdk/platform/PlatformConfig.d.ts +29 -0
  166. package/sdk/platform/PlatformConfig.js +36 -0
  167. package/sdk/platform/PlatformModels.d.ts +1396 -0
  168. package/sdk/platform/PlatformModels.js +19222 -0
  169. package/sdk/platform/client/AnalyticsPlatformClient.d.ts +84 -0
  170. package/sdk/platform/client/AnalyticsPlatformClient.js +215 -0
  171. package/sdk/platform/client/AuditTrailPlatformClient.d.ts +38 -0
  172. package/sdk/platform/client/AuditTrailPlatformClient.js +133 -0
  173. package/sdk/platform/client/BillingPlatformClient.d.ts +109 -0
  174. package/sdk/platform/client/BillingPlatformClient.js +381 -0
  175. package/sdk/platform/client/CatalogPlatformClient.d.ts +806 -0
  176. package/sdk/platform/client/CatalogPlatformClient.js +2462 -0
  177. package/sdk/platform/client/CommonPlatformClient.d.ts +30 -0
  178. package/sdk/platform/client/CommonPlatformClient.js +84 -0
  179. package/sdk/platform/client/CommunicationPlatformClient.d.ts +26 -0
  180. package/sdk/platform/client/CommunicationPlatformClient.js +72 -0
  181. package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +182 -0
  182. package/sdk/platform/client/CompanyProfilePlatformClient.js +540 -0
  183. package/sdk/platform/client/ConfigurationPlatformClient.d.ts +277 -0
  184. package/sdk/platform/client/ConfigurationPlatformClient.js +806 -0
  185. package/sdk/platform/client/DiscountPlatformClient.d.ts +118 -0
  186. package/sdk/platform/client/DiscountPlatformClient.js +364 -0
  187. package/sdk/platform/client/FileStoragePlatformClient.d.ts +111 -0
  188. package/sdk/platform/client/FileStoragePlatformClient.js +268 -0
  189. package/sdk/platform/client/InventoryPlatformClient.d.ts +125 -0
  190. package/sdk/platform/client/InventoryPlatformClient.js +409 -0
  191. package/sdk/platform/client/LeadPlatformClient.d.ts +150 -0
  192. package/sdk/platform/client/LeadPlatformClient.js +439 -0
  193. package/sdk/platform/client/OrderPlatformClient.d.ts +190 -0
  194. package/sdk/platform/client/OrderPlatformClient.js +521 -0
  195. package/sdk/platform/client/PaymentPlatformClient.d.ts +98 -0
  196. package/sdk/platform/client/PaymentPlatformClient.js +331 -0
  197. package/sdk/platform/client/WebhookPlatformClient.d.ts +64 -0
  198. package/sdk/platform/client/WebhookPlatformClient.js +207 -0
  199. package/sdk/platform/index.d.ts +2 -0
  200. package/sdk/platform/index.js +4 -0
  201. package/sdk/platform/models/AnalyticsValidator.d.ts +7 -0
  202. package/sdk/platform/models/AnalyticsValidator.js +36 -0
  203. package/sdk/platform/models/AuditTrailValidator.d.ts +7 -0
  204. package/sdk/platform/models/AuditTrailValidator.js +26 -0
  205. package/sdk/platform/models/BillingValidator.d.ts +15 -0
  206. package/sdk/platform/models/BillingValidator.js +72 -0
  207. package/sdk/platform/models/CartValidator.d.ts +0 -0
  208. package/sdk/platform/models/CartValidator.js +0 -0
  209. package/sdk/platform/models/CatalogValidator.d.ts +74 -0
  210. package/sdk/platform/models/CatalogValidator.js +484 -0
  211. package/sdk/platform/models/CommonValidator.d.ts +5 -0
  212. package/sdk/platform/models/CommonValidator.js +18 -0
  213. package/sdk/platform/models/CommunicationValidator.d.ts +4 -0
  214. package/sdk/platform/models/CommunicationValidator.js +11 -0
  215. package/sdk/platform/models/CompanyProfileValidator.d.ts +17 -0
  216. package/sdk/platform/models/CompanyProfileValidator.js +93 -0
  217. package/sdk/platform/models/ConfigurationValidator.d.ts +21 -0
  218. package/sdk/platform/models/ConfigurationValidator.js +134 -0
  219. package/sdk/platform/models/ContentValidator.d.ts +0 -0
  220. package/sdk/platform/models/ContentValidator.js +0 -0
  221. package/sdk/platform/models/DiscountValidator.d.ts +13 -0
  222. package/sdk/platform/models/DiscountValidator.js +75 -0
  223. package/sdk/platform/models/FileStorageValidator.d.ts +9 -0
  224. package/sdk/platform/models/FileStorageValidator.js +44 -0
  225. package/sdk/platform/models/InventoryValidator.d.ts +15 -0
  226. package/sdk/platform/models/InventoryValidator.js +81 -0
  227. package/sdk/platform/models/LeadValidator.d.ts +14 -0
  228. package/sdk/platform/models/LeadValidator.js +78 -0
  229. package/sdk/platform/models/OrderValidator.d.ts +14 -0
  230. package/sdk/platform/models/OrderValidator.js +110 -0
  231. package/sdk/platform/models/PartnerValidator.d.ts +0 -0
  232. package/sdk/platform/models/PartnerValidator.js +0 -0
  233. package/sdk/platform/models/PaymentValidator.d.ts +13 -0
  234. package/sdk/platform/models/PaymentValidator.js +65 -0
  235. package/sdk/platform/models/RewardsValidator.d.ts +0 -0
  236. package/sdk/platform/models/RewardsValidator.js +0 -0
  237. package/sdk/platform/models/ShareValidator.d.ts +0 -0
  238. package/sdk/platform/models/ShareValidator.js +0 -0
  239. package/sdk/platform/models/ThemeValidator.d.ts +0 -0
  240. package/sdk/platform/models/ThemeValidator.js +0 -0
  241. package/sdk/platform/models/UserValidator.d.ts +0 -0
  242. package/sdk/platform/models/UserValidator.js +0 -0
  243. package/sdk/platform/models/WebhookValidator.d.ts +9 -0
  244. package/sdk/platform/models/WebhookValidator.js +42 -0
  245. package/sdk/public/PublicAPIClient.d.ts +11 -0
  246. package/sdk/public/PublicAPIClient.js +38 -0
  247. package/sdk/public/PublicClient.d.ts +12 -0
  248. package/sdk/public/PublicClient.js +24 -0
  249. package/sdk/public/PublicConfig.d.ts +10 -0
  250. package/sdk/public/PublicConfig.js +12 -0
  251. package/sdk/public/PublicModels.d.ts +50 -0
  252. package/sdk/public/PublicModels.js +712 -0
  253. package/sdk/public/client/ConfigurationPublicClient.d.ts +38 -0
  254. package/sdk/public/client/ConfigurationPublicClient.js +102 -0
  255. package/sdk/public/client/InventoryPublicClient.d.ts +81 -0
  256. package/sdk/public/client/InventoryPublicClient.js +239 -0
  257. package/sdk/public/client/WebhookPublicClient.d.ts +28 -0
  258. package/sdk/public/client/WebhookPublicClient.js +92 -0
  259. package/sdk/public/constructUrl.d.ts +5 -0
  260. package/sdk/public/constructUrl.js +13 -0
  261. package/sdk/public/index.d.ts +2 -0
  262. package/sdk/public/index.js +4 -0
  263. package/sdk/public/models/ConfigurationValidator.d.ts +5 -0
  264. package/sdk/public/models/ConfigurationValidator.js +18 -0
  265. package/sdk/public/models/InventoryValidator.d.ts +9 -0
  266. package/sdk/public/models/InventoryValidator.js +43 -0
  267. package/sdk/public/models/WebhookValidator.d.ts +5 -0
  268. package/sdk/public/models/WebhookValidator.js +14 -0
  269. package/tests/application/catalog.spec.js +47 -0
  270. package/tests/common/action-url.spec.js +35 -0
  271. package/tests/common/schema/action-url.json +163 -0
  272. package/tests/common/schema/url-action.json +667 -0
  273. package/tests/common/url-action.spec.js +48 -0
  274. package/tests/helpers/cookie.helper.js +31 -0
  275. package/tests/helpers/oauth.helper.js +43 -0
  276. package/tests/platform/catalog.spec.js +49 -0
  277. package/tests/public/location.spec.js +39 -0
@@ -0,0 +1,806 @@
1
+ export = Catalog;
2
+ declare class Catalog {
3
+ constructor(config: any);
4
+ config: any;
5
+ /**
6
+ * @param {Object} arg - Arg object.
7
+ * @param {string} [arg.q] - A search string that is searched with product
8
+ * bundle name.
9
+ * @param {string[]} [arg.slug] - Slugs of bundles to be retrieved.
10
+ * @summary: List all Product Bundles
11
+ * @description: Get all product bundles for a particular company
12
+ */
13
+ getProductBundle({ q, slug }?: {
14
+ q?: string;
15
+ slug?: string[];
16
+ }): Promise<any>;
17
+ /**
18
+ * @param {Object} arg - Arg object.
19
+ * @param {ProductBundleRequest} arg.body
20
+ * @summary: Create Product Bundle
21
+ * @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id
22
+ */
23
+ createProductBundle({ body }?: {
24
+ body: any;
25
+ }): Promise<any>;
26
+ /**
27
+ * @param {Object} arg - Arg object.
28
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
29
+ * detail. Pass the `id` of the keywords which you want to retrieve.
30
+ * @summary: Get a particular Product Bundle details
31
+ * @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
32
+ */
33
+ getProductBundleDetail({ id }?: {
34
+ id: string;
35
+ }): Promise<any>;
36
+ /**
37
+ * @param {Object} arg - Arg object.
38
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
39
+ * detail. Pass the `id` of the keywords which you want to delete.
40
+ * @param {ProductBundleUpdateRequest} arg.body
41
+ * @summary: Update a Product Bundle
42
+ * @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
43
+ */
44
+ updateProductBundle({ id, body }?: {
45
+ id: string;
46
+ body: any;
47
+ }): Promise<any>;
48
+ /**
49
+ * @param {Object} arg - Arg object.
50
+ * @param {boolean} [arg.active] - Filter size guide on basis of active, in-active
51
+ * @param {string} [arg.q] - Query that is to be searched.
52
+ * @param {string} [arg.tag] - To filter size guide on basis of tag.
53
+ * @param {number} [arg.pageNo] - The page number to navigate through the
54
+ * given set of results
55
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
56
+ * page. Default is 10.
57
+ * @summary: Get list of size guides
58
+ * @description: This API allows to view all the size guides associated to the seller.
59
+ */
60
+ getSizeGuides({ active, q, tag, pageNo, pageSize }?: {
61
+ active?: boolean;
62
+ q?: string;
63
+ tag?: string;
64
+ pageNo?: number;
65
+ pageSize?: number;
66
+ }): Promise<any>;
67
+ /**
68
+ * @param {Object} arg - Arg object.
69
+ * @param {ValidateSizeGuide} arg.body
70
+ * @summary: Create a size guide.
71
+ * @description: This API allows to create a size guide associated to a brand.
72
+ */
73
+ createSizeGuide({ body }?: {
74
+ body: any;
75
+ }): Promise<any>;
76
+ /**
77
+ * @param {Object} arg - Arg object.
78
+ * @param {string} arg.id - Id of the size guide to be viewed.
79
+ * @summary: Get a single size guide.
80
+ * @description: This API helps to get data associated to a size guide.
81
+ */
82
+ getSizeGuide({ id }?: {
83
+ id: string;
84
+ }): Promise<any>;
85
+ /**
86
+ * @param {Object} arg - Arg object.
87
+ * @param {string} arg.id - Mongo id of the size guide to be edited
88
+ * @param {ValidateSizeGuide} arg.body
89
+ * @summary: Edit a size guide.
90
+ * @description: This API allows to edit a size guide.
91
+ */
92
+ updateSizeGuide({ id, body }?: {
93
+ id: string;
94
+ body: any;
95
+ }): Promise<any>;
96
+ /**
97
+ * @param {Object} arg - Arg object.
98
+ * @param {string} arg.sellerAppId - Id of the seller application which is
99
+ * serving the invetory/catalog of the company
100
+ * @summary: Analytics data of catalog and inventory that are being cross-selled.
101
+ * @description: Analytics data of catalog and inventory that are being cross-selled.
102
+ */
103
+ getSellerInsights({ sellerAppId }?: {
104
+ sellerAppId: string;
105
+ }): Promise<any>;
106
+ /**
107
+ * @param {Object} arg - Arg object.
108
+ * @param {string} arg.marketplace - The marketplace for which the detail
109
+ * needs to be retrieved.
110
+ * @param {OptInPostRequest} arg.body
111
+ * @summary: Create/Update opt-in infomation.
112
+ * @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema`
113
+ */
114
+ createMarketplaceOptin({ marketplace, body }?: {
115
+ marketplace: string;
116
+ body: any;
117
+ }): Promise<any>;
118
+ /**
119
+ * @param {Object} arg - Arg object.
120
+ * @summary: Get opt-in infomation.
121
+ * @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema`
122
+ */
123
+ getMarketplaceOptinDetail({}?: any): Promise<any>;
124
+ /**
125
+ * @param {Object} arg - Arg object.
126
+ * @summary: Get the Company details.
127
+ * @description: Get the details of the company associated with the given company_id passed.
128
+ */
129
+ getCompanyDetail({}?: any): Promise<any>;
130
+ /**
131
+ * @param {Object} arg - Arg object.
132
+ * @param {boolean} [arg.isActive] - The is_active status for the optin id.
133
+ * @param {boolean} [arg.q] - The search value to filter the list.
134
+ * @param {number} [arg.pageNo] - The number of page for the company id.
135
+ * @param {number} [arg.pageSize] - Number of records that can be seen on
136
+ * the page for the company id.
137
+ * @param {string} [arg.marketplace] - The marketplace platform associated
138
+ * with the company id.
139
+ * @summary: Get the Company Brand details of Optin.
140
+ * @description: Get the details of the Brands associated with the given company_id passed.
141
+ */
142
+ getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace }?: {
143
+ isActive?: boolean;
144
+ q?: boolean;
145
+ pageNo?: number;
146
+ pageSize?: number;
147
+ marketplace?: string;
148
+ }): Promise<any>;
149
+ /**
150
+ * @param {Object} arg - Arg object.
151
+ * @summary: Get the Company metrics
152
+ * @description: Get the Company metrics associated with the company ID passed.
153
+ */
154
+ getCompanyMetrics({}?: any): Promise<any>;
155
+ /**
156
+ * @param {Object} arg - Arg object.
157
+ * @param {string} [arg.q] - The search related the store for the company id.
158
+ * @param {number} [arg.pageNo] - The number of page for the company id.
159
+ * @param {number} [arg.pageSize] - Number of records that can be seen on
160
+ * the page for the company id.
161
+ * @summary: Get the Store details.
162
+ * @description: Get the details of the store associated with the company ID passed.
163
+ */
164
+ getStoreDetail({ q, pageNo, pageSize }?: {
165
+ q?: string;
166
+ pageNo?: number;
167
+ pageSize?: number;
168
+ }): Promise<any>;
169
+ /**
170
+ * @param {Object} arg - Arg object.
171
+ * @param {string} arg.attributeSlug - Slug of the attribute for which you
172
+ * want to view the genders
173
+ * @summary: Get gender attribute details
174
+ * @description: This API allows to view the gender attribute details.
175
+ */
176
+ getGenderAttribute({ attributeSlug }?: {
177
+ attributeSlug: string;
178
+ }): Promise<any>;
179
+ /**
180
+ * @param {Object} arg - Arg object.
181
+ * @param {string} arg.departments - A `department` is name of a departments
182
+ * whose category needs to be listed. Can specify multiple departments.
183
+ * @param {string} arg.itemType - An `item_type` is the type of item, it can
184
+ * be `set`, `standard`, `digital`, etc.
185
+ * @summary: List Department specifiec product categories
186
+ * @description: Allows you to list all product categories values for the departments specified
187
+ */
188
+ listProductTemplateCategories({ departments, itemType }?: {
189
+ departments: string;
190
+ itemType: string;
191
+ }): Promise<any>;
192
+ /**
193
+ * @param {Object} arg - Arg object.
194
+ * @param {number} [arg.pageNo] - The page number to navigate through the
195
+ * given set of results
196
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
197
+ * page. Default is 10.
198
+ * @param {string} [arg.name] - Can search departments by passing name.
199
+ * @param {string} [arg.search] - Can search departments by passing name of
200
+ * the department in search parameter.
201
+ * @param {boolean} [arg.isActive] - Can query for departments based on
202
+ * whether they are active or inactive.
203
+ * @summary: List all Departments.
204
+ * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
205
+ */
206
+ listDepartmentsData({ pageNo, pageSize, name, search, isActive }?: {
207
+ pageNo?: number;
208
+ pageSize?: number;
209
+ name?: string;
210
+ search?: string;
211
+ isActive?: boolean;
212
+ }): Promise<any>;
213
+ /**
214
+ * @param {Object} arg - Arg object.
215
+ * @param {DepartmentCreateUpdate} arg.body
216
+ * @summary: Create the department.
217
+ * @description: Create departments using the API.
218
+ */
219
+ createDepartments({ body }?: {
220
+ body: any;
221
+ }): Promise<any>;
222
+ /**
223
+ * @param {Object} arg - Arg object.
224
+ * @param {string} arg.uid - A `uid` is a unique identifier of a department.
225
+ * @summary: Get specific departments details by passing in unique id of the department.
226
+ * @description: Allows you to get department data, by uid.
227
+ */
228
+ getDepartmentData({ uid }?: {
229
+ uid: string;
230
+ }): Promise<any>;
231
+ /**
232
+ * @param {Object} arg - Arg object.
233
+ * @param {string} arg.uid - A `uid` is a unique identifier of a department.
234
+ * @param {DepartmentCreateUpdate} arg.body
235
+ * @summary: Update the department by their uid.
236
+ * @description: Update the department by their uid using this API.
237
+ */
238
+ updateDepartment({ uid, body }?: {
239
+ uid: string;
240
+ body: any;
241
+ }): Promise<any>;
242
+ /**
243
+ * @param {Object} arg - Arg object.
244
+ * @param {string} arg.department - A `department` is the name of a
245
+ * particular department.
246
+ * @summary: List all Templates
247
+ * @description: Allows you to list all product templates, also can filter by department
248
+ */
249
+ listProductTemplate({ department }?: {
250
+ department: string;
251
+ }): Promise<any>;
252
+ /**
253
+ * @param {Object} arg - Arg object.
254
+ * @param {string} arg.slug - A `slug` is a unique identifier for a
255
+ * particular template.
256
+ * @summary: Validate Product Template Schema
257
+ * @description: Allows you to list all product templates validation values for all the fields present in the database
258
+ */
259
+ validateProductTemplate({ slug }?: {
260
+ slug: string;
261
+ }): Promise<any>;
262
+ /**
263
+ * @param {Object} arg - Arg object.
264
+ * @param {string} arg.slug - A `slug` is a unique identifier for a
265
+ * particular template.
266
+ * @summary: Download Product Template View
267
+ * @description: Allows you to download product template data
268
+ */
269
+ downloadProductTemplateViews({ slug }?: {
270
+ slug: string;
271
+ }): Promise<any>;
272
+ /**
273
+ * @param {Object} arg - Arg object.
274
+ * @param {string} arg.itemType - An `item_type` defines the type of item.
275
+ * @summary: Download Product Template View
276
+ * @description: Allows you to download product template data
277
+ */
278
+ downloadProductTemplateView({ itemType }?: {
279
+ itemType: string;
280
+ }): Promise<any>;
281
+ /**
282
+ * @param {Object} arg - Arg object.
283
+ * @param {string} arg.itemType - An `item_type` defines the type of item.
284
+ * The default value is standard.
285
+ * @summary: Validate Product Template Schema
286
+ * @description: Allows you to list all product templates validation values for all the fields present in the database
287
+ */
288
+ validateProductTemplateSchema({ itemType }?: {
289
+ itemType: string;
290
+ }): Promise<any>;
291
+ /**
292
+ * @param {Object} arg - Arg object.
293
+ * @summary: List HSN Codes
294
+ * @description: Allows you to list all hsn Codes
295
+ */
296
+ listHSNCodes({}?: any): Promise<any>;
297
+ /**
298
+ * @param {Object} arg - Arg object.
299
+ * @summary: Allows you to list all product templates export list details
300
+ * @description: Can view details including trigger data, task id , etc.
301
+ */
302
+ listProductTemplateExportDetails({}?: any): Promise<any>;
303
+ /**
304
+ * @param {Object} arg - Arg object.
305
+ * @param {string} arg.filter - A `filter` is the unique identifier of the
306
+ * type of value required.
307
+ * @summary: Allows you to list all values for Templates, Brands or Type
308
+ * @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same
309
+ */
310
+ listTemplateBrandTypeValues({ filter }?: {
311
+ filter: string;
312
+ }): Promise<any>;
313
+ /**
314
+ * @param {Object} arg - Arg object.
315
+ * @param {string} [arg.level] - Get category for multiple levels
316
+ * @param {string} [arg.departments] - Get category for multiple departments filtered
317
+ * @param {string} [arg.q] - Get multiple categories filtered by search string
318
+ * @param {number} [arg.pageNo] - The page number to navigate through the
319
+ * given set of results
320
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
321
+ * page. Default is 10.
322
+ * @summary: Get product categories list
323
+ * @description: This API gets meta associated to product categories.
324
+ */
325
+ listCategories({ level, departments, q, pageNo, pageSize }?: {
326
+ level?: string;
327
+ departments?: string;
328
+ q?: string;
329
+ pageNo?: number;
330
+ pageSize?: number;
331
+ }): Promise<any>;
332
+ /**
333
+ * @param {Object} arg - Arg object.
334
+ * @param {CategoryRequestBody} arg.body
335
+ * @summary: Create product categories
336
+ * @description: This API lets user create product categories
337
+ */
338
+ createCategories({ body }?: {
339
+ body: any;
340
+ }): Promise<any>;
341
+ /**
342
+ * @param {Object} arg - Arg object.
343
+ * @param {string} arg.uid - Category unique id
344
+ * @summary: Get product category by uid
345
+ * @description: This API gets meta associated to product categories.
346
+ */
347
+ getCategoryData({ uid }?: {
348
+ uid: string;
349
+ }): Promise<any>;
350
+ /**
351
+ * @param {Object} arg - Arg object.
352
+ * @param {string} arg.uid - Category unique id
353
+ * @param {CategoryRequestBody} arg.body
354
+ * @summary: Update product categories
355
+ * @description: Update a product category using this apu
356
+ */
357
+ updateCategory({ uid, body }?: {
358
+ uid: string;
359
+ body: any;
360
+ }): Promise<any>;
361
+ /**
362
+ * @param {Object} arg - Arg object.
363
+ * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
364
+ * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
365
+ * Category Ids
366
+ * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
367
+ * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
368
+ * Department Ids
369
+ * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
370
+ * @param {string} [arg.q] - Get multiple products filtered by q string
371
+ * @param {string[]} [arg.tags] - Get multiple products filtered by tags
372
+ * @param {number} [arg.pageNo] - The page number to navigate through the
373
+ * given set of results
374
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
375
+ * page. Default is 10.
376
+ * @summary: Get product list
377
+ * @description: This API gets meta associated to products.
378
+ */
379
+ getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, }?: {
380
+ brandIds?: number[];
381
+ categoryIds?: number[];
382
+ itemIds?: number[];
383
+ departmentIds?: number[];
384
+ itemCode?: string[];
385
+ q?: string;
386
+ tags?: string[];
387
+ pageNo?: number;
388
+ pageSize?: number;
389
+ }): Promise<any>;
390
+ /**
391
+ * @param {Object} arg - Arg object.
392
+ * @param {ProductCreateUpdate} arg.body
393
+ * @summary: Create a product.
394
+ * @description: This API allows to create product.
395
+ */
396
+ createProduct({ body }?: {
397
+ body: any;
398
+ }): Promise<any>;
399
+ /**
400
+ * @param {Object} arg - Arg object.
401
+ * @param {string} arg.category - It is the name of the l3 cateogry
402
+ * @param {boolean} [arg.filter] - If true, returns filtered values, else
403
+ * returns all the attributes
404
+ * @summary: Get list of all the attributes by their l3_categories
405
+ * @description: This API allows to list all the attributes by their l3_categories.
406
+ */
407
+ getProductAttributes({ category, filter }?: {
408
+ category: string;
409
+ filter?: boolean;
410
+ }): Promise<any>;
411
+ /**
412
+ * @param {Object} arg - Arg object.
413
+ * @param {string} [arg.itemCode] - Item code of the product.
414
+ * @param {number} arg.itemId - Item Id of the product.
415
+ * @param {number} [arg.brandUid] - Brand Id of the product.
416
+ * @summary: Get a single product.
417
+ * @description: This API helps to get data associated to a particular product.
418
+ */
419
+ getProduct({ itemId, itemCode, brandUid }?: {
420
+ itemCode?: string;
421
+ itemId: number;
422
+ brandUid?: number;
423
+ }): Promise<any>;
424
+ /**
425
+ * @param {Object} arg - Arg object.
426
+ * @param {number} arg.itemId - Id of the product to be updated.
427
+ * @param {ProductCreateUpdate} arg.body
428
+ * @summary: Edit a product.
429
+ * @description: This API allows to edit product.
430
+ */
431
+ editProduct({ itemId, body }?: {
432
+ itemId: number;
433
+ body: any;
434
+ }): Promise<any>;
435
+ /**
436
+ * @param {Object} arg - Arg object.
437
+ * @param {number} arg.itemId - Id of the product to be updated.
438
+ * @summary: Delete a product.
439
+ * @description: This API allows to delete product.
440
+ */
441
+ deleteProduct({ itemId }?: {
442
+ itemId: number;
443
+ }): Promise<any>;
444
+ /**
445
+ * @param {Object} arg - Arg object.
446
+ * @summary: Validate product/size data
447
+ * @description: This API validates product data.
448
+ */
449
+ getProductValidation({}?: any): Promise<any>;
450
+ /**
451
+ * @param {Object} arg - Arg object.
452
+ * @param {string} [arg.itemCode] - Item code of the product size.
453
+ * @param {number} arg.itemId - Item Id of the product size.
454
+ * @param {number} [arg.brandUid] - Brand Id of the product size.
455
+ * @param {number} [arg.uid] - Id of the product size.
456
+ * @summary: Get a single product size.
457
+ * @description: This API helps to get data associated to a particular product size.
458
+ */
459
+ getProductSize({ itemId, itemCode, brandUid, uid }?: {
460
+ itemCode?: string;
461
+ itemId: number;
462
+ brandUid?: number;
463
+ uid?: number;
464
+ }): Promise<any>;
465
+ /**
466
+ * @param {Object} arg - Arg object.
467
+ * @param {number} [arg.pageNo] - The page number to navigate through the
468
+ * given set of results
469
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
470
+ * page. Default is 12.
471
+ * @summary: Get a list of all bulk product upload jobs.
472
+ * @description: This API helps to get bulk product upload jobs data.
473
+ */
474
+ getProductBulkUploadHistory({ pageNo, pageSize }?: {
475
+ pageNo?: number;
476
+ pageSize?: number;
477
+ }): Promise<any>;
478
+ /**
479
+ * @param {Object} arg - Arg object.
480
+ * @param {BulkJob} arg.body
481
+ * @summary: Create a Bulk product to upload job.
482
+ * @description: This API helps to create a bulk products upload job.
483
+ */
484
+ createBulkProductUploadJob({ body }?: {
485
+ body: any;
486
+ }): Promise<any>;
487
+ /**
488
+ * @param {Object} arg - Arg object.
489
+ * @param {number} arg.batchId - Batch Id of the bulk product job to be deleted.
490
+ * @summary: Delete Bulk product job.
491
+ * @description: This API allows to delete bulk product job associated with company.
492
+ */
493
+ deleteProductBulkJob({ batchId }?: {
494
+ batchId: number;
495
+ }): Promise<any>;
496
+ /**
497
+ * @param {Object} arg - Arg object.
498
+ * @param {string} arg.batchId - Batch Id in which assets to be uploaded.
499
+ * @param {BulkProductRequest} arg.body
500
+ * @summary: Create products in bulk associated with given batch Id.
501
+ * @description: This API helps to create products in bulk push to kafka for approval/creation.
502
+ */
503
+ createProductsInBulk({ batchId, body }?: {
504
+ batchId: string;
505
+ body: any;
506
+ }): Promise<any>;
507
+ /**
508
+ * @param {Object} arg - Arg object.
509
+ * @summary: Get a list of all tags associated with company.
510
+ * @description: This API helps to get tags data associated to a particular company.
511
+ */
512
+ getProductTags({}?: any): Promise<any>;
513
+ /**
514
+ * @param {Object} arg - Arg object.
515
+ * @param {number} [arg.pageNo] - The page number to navigate through the
516
+ * given set of results
517
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
518
+ * page. Default is 12.
519
+ * @summary: Get a list of all bulk asset jobs.
520
+ * @description: This API helps to get bulk asset jobs data associated to a particular company.
521
+ */
522
+ getProductAssetsInBulk({ pageNo, pageSize }?: {
523
+ pageNo?: number;
524
+ pageSize?: number;
525
+ }): Promise<any>;
526
+ /**
527
+ * @param {Object} arg - Arg object.
528
+ * @param {ProductBulkAssets} arg.body
529
+ * @summary: Create a Bulk asset upload Job.
530
+ * @description: This API helps to create a bulk asset upload job.
531
+ */
532
+ createProductAssetsInBulk({ body }?: {
533
+ body: any;
534
+ }): Promise<any>;
535
+ /**
536
+ * @param {Object} arg - Arg object.
537
+ * @param {number} arg.itemId - Item Id of the product associated with size
538
+ * to be deleted.
539
+ * @param {number} arg.size - Size to be deleted.
540
+ * @summary: Delete a Size associated with product.
541
+ * @description: This API allows to delete size associated with product.
542
+ */
543
+ deleteSize({ itemId, size }?: {
544
+ itemId: number;
545
+ size: number;
546
+ }): Promise<any>;
547
+ /**
548
+ * @param {Object} arg - Arg object.
549
+ * @param {string} arg.itemId - Item code of the product of which size is to be get.
550
+ * @param {string} arg.size - Size of which inventory is to get.
551
+ * @param {number} [arg.pageNo] - The page number to navigate through the
552
+ * given set of results
553
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
554
+ * page. Default is 12.
555
+ * @param {string} [arg.q] - Search with help of store code.
556
+ * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
557
+ * @summary: Get Inventory for company
558
+ * @description: This API allows get Inventory data for particular company grouped by size and store.
559
+ */
560
+ getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable }?: {
561
+ itemId: string;
562
+ size: string;
563
+ pageNo?: number;
564
+ pageSize?: number;
565
+ q?: string;
566
+ sellable?: boolean;
567
+ }): Promise<any>;
568
+ /**
569
+ * @param {Object} arg - Arg object.
570
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
571
+ * @param {string} arg.size - Size in which inventory is to be added.
572
+ * @param {InventoryRequest} arg.body
573
+ * @summary: Add Inventory for particular size and store.
574
+ * @description: This API allows add Inventory for particular size and store.
575
+ */
576
+ addInventory({ itemId, size, body }?: {
577
+ itemId: number;
578
+ size: string;
579
+ body: any;
580
+ }): Promise<any>;
581
+ /**
582
+ * @param {Object} arg - Arg object.
583
+ * @param {string} arg.itemId - Item code of the product of which size is to be get.
584
+ * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
585
+ * or Primary Identifier) of which inventory is to get.
586
+ * @param {number} [arg.pageNo] - The page number to navigate through the
587
+ * given set of results
588
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
589
+ * page. Default is 12.
590
+ * @param {string} [arg.q] - Search with help of store code.
591
+ * @param {number[]} [arg.locationIds] - Search by store ids.
592
+ * @summary: Get Inventory for company
593
+ * @description: This API allows get Inventory data for particular company grouped by size and store.
594
+ */
595
+ getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
596
+ itemId: string;
597
+ sizeIdentifier: string;
598
+ pageNo?: number;
599
+ pageSize?: number;
600
+ q?: string;
601
+ locationIds?: number[];
602
+ }): Promise<any>;
603
+ /**
604
+ * @param {Object} arg - Arg object.
605
+ * @param {string} arg.size - Size that is to be deleted.
606
+ * @param {number} arg.itemId - Id of the product associated with Inventory
607
+ * to be deleted.
608
+ * @param {number} arg.locationId - Location ID of store of which inventory
609
+ * is to be deleted.
610
+ * @summary: Delete a Inventory.
611
+ * @description: This API allows to delete inventory of a particular product for particular company.
612
+ */
613
+ deleteInventory({ size, itemId, locationId }?: {
614
+ size: string;
615
+ itemId: number;
616
+ locationId: number;
617
+ }): Promise<any>;
618
+ /**
619
+ * @param {Object} arg - Arg object.
620
+ * @param {number} [arg.pageNo] - The page number to navigate through the
621
+ * given set of results
622
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
623
+ * page. Default is 12.
624
+ * @summary: Get a list of all bulk Inventory upload jobs.
625
+ * @description: This API helps to get bulk Inventory upload jobs data.
626
+ */
627
+ getInventoryBulkUploadHistory({ pageNo, pageSize }?: {
628
+ pageNo?: number;
629
+ pageSize?: number;
630
+ }): Promise<any>;
631
+ /**
632
+ * @param {Object} arg - Arg object.
633
+ * @param {BulkJob} arg.body
634
+ * @summary: Create a Bulk Inventory upload Job.
635
+ * @description: This API helps to create a bulk Inventory upload job.
636
+ */
637
+ createBulkInventoryJob({ body }?: {
638
+ body: any;
639
+ }): Promise<any>;
640
+ /**
641
+ * @param {Object} arg - Arg object.
642
+ * @param {string} arg.batchId - Batch Id of the bulk delete job.
643
+ * @summary: Delete Bulk Inventory job.
644
+ * @description: This API allows to delete bulk Inventory job associated with company.
645
+ */
646
+ deleteBulkInventoryJob({ batchId }?: {
647
+ batchId: string;
648
+ }): Promise<any>;
649
+ /**
650
+ * @param {Object} arg - Arg object.
651
+ * @param {string} arg.batchId - Batch Id of the bulk create job.
652
+ * @param {InventoryBulkRequest} arg.body
653
+ * @summary: Create products in bulk associated with given batch Id.
654
+ * @description: This API helps to create products in bulk push to kafka for approval/creation.
655
+ */
656
+ createBulkInventory({ batchId, body }?: {
657
+ batchId: string;
658
+ body: any;
659
+ }): Promise<any>;
660
+ /**
661
+ * @param {Object} arg - Arg object.
662
+ * @summary: Get Inventory export history.
663
+ * @description: This API helps to get Inventory export history.
664
+ */
665
+ getInventoryExport({}?: any): Promise<any>;
666
+ /**
667
+ * @param {Object} arg - Arg object.
668
+ * @param {InventoryExportRequest} arg.body
669
+ * @summary: Create a Inventory export Job.
670
+ * @description: This API helps to create a Inventory export job.
671
+ */
672
+ createInventoryExportJob({ body }?: {
673
+ body: any;
674
+ }): Promise<any>;
675
+ /**
676
+ * @param {Object} arg - Arg object.
677
+ * @param {string} [arg.filterType] - Filter type from any one of ['brand',
678
+ * 'store', 'type']
679
+ * @summary: Get List of different filters for inventory export
680
+ * @description: This API allows get List of different filters like brand, store, and type for inventory export.
681
+ */
682
+ exportInventoryConfig({ filterType }?: {
683
+ filterType?: string;
684
+ }): Promise<any>;
685
+ /**
686
+ * @param {Object} arg - Arg object.
687
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
688
+ * @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
689
+ * or Primary Identifier) of which inventory is to get.
690
+ * @param {InventoryRequestSchemaV2} arg.body
691
+ * @summary: Add Inventory for particular size and store.
692
+ * @description: This API allows add Inventory for particular size and store.
693
+ */
694
+ deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: {
695
+ itemId: number;
696
+ sellerIdentifier: string;
697
+ body: any;
698
+ }): Promise<any>;
699
+ /**
700
+ * @param {Object} arg - Arg object.
701
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
702
+ * @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
703
+ * or Primary Identifier) of which inventory is to get.
704
+ * @param {InventoryRequestSchemaV2} arg.body
705
+ * @summary: Add Inventory for particular size and store.
706
+ * @description: This API allows add Inventory for particular size and store.
707
+ */
708
+ updateRealtimeInventory({ itemId, sellerIdentifier, body }?: {
709
+ itemId: number;
710
+ sellerIdentifier: string;
711
+ body: any;
712
+ }): Promise<any>;
713
+ /**
714
+ * @param {Object} arg - Arg object.
715
+ * @param {InventoryRequestSchemaV2} arg.body
716
+ * @summary: Add Inventory for particular size and store.
717
+ * @description: This API allows add Inventory for particular size and store.
718
+ */
719
+ updateInventories({ body }?: {
720
+ body: any;
721
+ }): Promise<any>;
722
+ /**
723
+ * @param {Object} arg - Arg object.
724
+ * @param {number} [arg.pageNo] - Page no
725
+ * @param {number} [arg.pageSize] - Page size
726
+ * @param {string} [arg.q] - Search using hsn code.
727
+ * @summary: Hsn Code List.
728
+ * @description: Hsn Code List.
729
+ */
730
+ getAllHsnCodes({ pageNo, pageSize, q }?: {
731
+ pageNo?: number;
732
+ pageSize?: number;
733
+ q?: string;
734
+ }): Promise<any>;
735
+ /**
736
+ * @param {Object} arg - Arg object.
737
+ * @param {HsnUpsert} arg.body
738
+ * @summary: Create Hsn Code.
739
+ * @description: Create Hsn Code.
740
+ */
741
+ createHsnCode({ body }?: {
742
+ body: any;
743
+ }): Promise<any>;
744
+ /**
745
+ * @param {Object} arg - Arg object.
746
+ * @param {string} arg.id - Unique id
747
+ * @summary: Fetch Hsn Code.
748
+ * @description: Fetch Hsn Code.
749
+ */
750
+ getHsnCode({ id }?: {
751
+ id: string;
752
+ }): Promise<any>;
753
+ /**
754
+ * @param {Object} arg - Arg object.
755
+ * @param {string} arg.id - Unique id
756
+ * @param {HsnUpsert} arg.body
757
+ * @summary: Update Hsn Code.
758
+ * @description: Update Hsn Code.
759
+ */
760
+ updateHsnCode({ id, body }?: {
761
+ id: string;
762
+ body: any;
763
+ }): Promise<any>;
764
+ /**
765
+ * @param {Object} arg - Arg object.
766
+ * @param {BulkHsnUpsert} arg.body
767
+ * @summary: Bulk Create or Update Hsn Code.
768
+ * @description: Bulk Create or Update Hsn Code.
769
+ */
770
+ bulkHsnCode({ body }?: {
771
+ body: any;
772
+ }): Promise<any>;
773
+ /**
774
+ * @param {Object} arg - Arg object.
775
+ * @param {number} [arg.pageNo] - Page no
776
+ * @param {number} [arg.pageSize] - Page size
777
+ * @param {string} [arg.q] - Search using hsn code, description, reporting_hsn
778
+ * @param {string} [arg.type] - Search using type
779
+ * @summary: Hsn Code List.
780
+ * @description: Hsn Code List.
781
+ */
782
+ getAllProductHsnCodes({ pageNo, pageSize, q, type }?: {
783
+ pageNo?: number;
784
+ pageSize?: number;
785
+ q?: string;
786
+ type?: string;
787
+ }): Promise<any>;
788
+ /**
789
+ * @param {Object} arg - Arg object.
790
+ * @param {string} arg.reportingHsn - Reporting_hsn
791
+ * @summary: Hsn Code List.
792
+ * @description: Hsn Code List.
793
+ */
794
+ getSingleProductHSNCode({ reportingHsn }?: {
795
+ reportingHsn: string;
796
+ }): Promise<any>;
797
+ /**
798
+ * @param {Object} arg - Arg object.
799
+ * @param {AssignStore} arg.body
800
+ * @summary: Location Reassignment
801
+ * @description:
802
+ */
803
+ getOptimalLocations({ body }?: {
804
+ body: any;
805
+ }): Promise<any>;
806
+ }