@gofynd/fdk-client-javascript 1.0.1 → 1.0.2

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 (134) hide show
  1. package/documentation/application/CART.md +251 -251
  2. package/documentation/application/CATALOG.md +414 -414
  3. package/documentation/application/CONTENT.md +15 -1
  4. package/documentation/application/ORDER.md +290 -290
  5. package/documentation/application/PAYMENT.md +255 -255
  6. package/documentation/application/POSCART.md +297 -297
  7. package/documentation/platform/CART.md +499 -499
  8. package/documentation/platform/CATALOG.md +3088 -2702
  9. package/documentation/platform/COMPANYPROFILE.md +201 -201
  10. package/documentation/platform/CONTENT.md +123 -1
  11. package/documentation/platform/ORDER.md +1233 -1158
  12. package/documentation/platform/PARTNER.md +7 -7
  13. package/documentation/platform/PAYMENT.md +83 -83
  14. package/package.json +1 -1
  15. package/sdk/application/ApplicationConfig.js +1 -1
  16. package/sdk/application/Cart/CartApplicationClient.js +619 -108
  17. package/sdk/application/Cart/CartApplicationModel.d.ts +7 -7
  18. package/sdk/application/Cart/CartApplicationModel.js +335 -335
  19. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
  20. package/sdk/application/Catalog/CatalogApplicationClient.js +730 -134
  21. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +21 -21
  22. package/sdk/application/Catalog/CatalogApplicationModel.js +547 -547
  23. package/sdk/application/Common/CommonApplicationClient.js +48 -8
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +75 -14
  25. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +1 -1
  26. package/sdk/application/Configuration/ConfigurationApplicationClient.js +392 -66
  27. package/sdk/application/Content/ContentApplicationClient.js +444 -76
  28. package/sdk/application/Content/ContentApplicationModel.d.ts +1 -0
  29. package/sdk/application/Content/ContentApplicationModel.js +11 -1
  30. package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -12
  31. package/sdk/application/Lead/LeadApplicationClient.js +164 -30
  32. package/sdk/application/Logistic/LogisticApplicationClient.js +98 -16
  33. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  34. package/sdk/application/Order/OrderApplicationClient.js +287 -54
  35. package/sdk/application/Order/OrderApplicationModel.d.ts +19 -19
  36. package/sdk/application/Order/OrderApplicationModel.js +357 -357
  37. package/sdk/application/Payment/PaymentApplicationClient.js +961 -186
  38. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3 -3
  39. package/sdk/application/Payment/PaymentApplicationModel.js +352 -352
  40. package/sdk/application/PosCart/PosCartApplicationClient.js +645 -114
  41. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +15 -15
  42. package/sdk/application/PosCart/PosCartApplicationModel.js +389 -389
  43. package/sdk/application/Rewards/RewardsApplicationClient.js +168 -28
  44. package/sdk/application/Share/ShareApplicationClient.js +157 -32
  45. package/sdk/application/Theme/ThemeApplicationClient.js +94 -16
  46. package/sdk/application/User/UserApplicationClient.js +806 -148
  47. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +16 -8
  48. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +191 -34
  49. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  50. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
  51. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  52. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +103 -16
  53. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -12
  54. package/sdk/platform/Billing/BillingPlatformClient.js +299 -54
  55. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -17
  56. package/sdk/platform/Cart/CartPlatformApplicationClient.js +409 -72
  57. package/sdk/platform/Cart/CartPlatformModel.d.ts +35 -35
  58. package/sdk/platform/Cart/CartPlatformModel.js +617 -617
  59. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +167 -114
  60. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1562 -453
  61. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +8 -8
  62. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +39 -39
  63. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +314 -196
  64. package/sdk/platform/Catalog/CatalogPlatformClient.js +2459 -718
  65. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +103 -94
  66. package/sdk/platform/Catalog/CatalogPlatformModel.js +2063 -1797
  67. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +17 -15
  68. package/sdk/platform/Catalog/CatalogPlatformValidator.js +95 -76
  69. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -2
  70. package/sdk/platform/Common/CommonPlatformClient.js +51 -8
  71. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -40
  72. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1000 -168
  73. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  74. package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
  75. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -14
  76. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +335 -54
  77. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +10 -10
  78. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +278 -278
  79. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +56 -28
  80. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +702 -118
  81. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  82. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +457 -82
  83. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +148 -67
  84. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1724 -284
  85. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -0
  86. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -0
  87. package/sdk/platform/Content/ContentPlatformModel.d.ts +4 -0
  88. package/sdk/platform/Content/ContentPlatformModel.js +43 -1
  89. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +21 -10
  90. package/sdk/platform/Discount/DiscountPlatformClient.js +270 -44
  91. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +8 -4
  92. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +102 -16
  93. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -6
  94. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +150 -24
  95. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +27 -14
  96. package/sdk/platform/Inventory/InventoryPlatformClient.js +316 -52
  97. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +26 -13
  98. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +311 -52
  99. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -11
  100. package/sdk/platform/Lead/LeadPlatformClient.js +266 -44
  101. package/sdk/platform/OAuthClient.js +8 -8
  102. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -3
  103. package/sdk/platform/Order/OrderPlatformApplicationClient.js +78 -14
  104. package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -43
  105. package/sdk/platform/Order/OrderPlatformClient.js +1062 -180
  106. package/sdk/platform/Order/OrderPlatformModel.d.ts +64 -60
  107. package/sdk/platform/Order/OrderPlatformModel.js +1481 -1425
  108. package/sdk/platform/Order/OrderPlatformValidator.js +5 -0
  109. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  110. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
  111. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  112. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  113. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -11
  114. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +287 -56
  115. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +21 -11
  116. package/sdk/platform/Payment/PaymentPlatformClient.js +263 -48
  117. package/sdk/platform/Payment/PaymentPlatformModel.js +122 -122
  118. package/sdk/platform/PlatformApplicationClient.d.ts +2959 -2787
  119. package/sdk/platform/PlatformApplicationClient.js +3420 -3212
  120. package/sdk/platform/PlatformClient.d.ts +2959 -2787
  121. package/sdk/platform/PlatformClient.js +3420 -3212
  122. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +26 -13
  123. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +308 -54
  124. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +8 -4
  125. package/sdk/platform/Share/SharePlatformApplicationClient.js +94 -16
  126. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +47 -23
  127. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +571 -96
  128. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +24 -12
  129. package/sdk/platform/User/UserPlatformApplicationClient.js +296 -48
  130. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +12 -6
  131. package/sdk/platform/Webhook/WebhookPlatformClient.js +157 -30
  132. package/sdk/public/Configuration/ConfigurationPublicClient.js +51 -8
  133. package/sdk/public/Inventory/InventoryPublicClient.js +149 -26
  134. package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
@@ -2,49 +2,63 @@ export = Catalog;
2
2
  declare class Catalog {
3
3
  constructor(config: any);
4
4
  config: any;
5
+ /**
6
+ * @param {Object} arg - Arg object.
7
+ * @param {ProductBundleRequest} arg.body
8
+ * @returns {Promise<GetProductBundleCreateResponse>} - Success response
9
+ * @summary: Create Product Bundle
10
+ * @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
11
+ */
12
+ createProductBundle({ body }?: {
13
+ body: ProductBundleRequest;
14
+ }): Promise<GetProductBundleCreateResponse>;
5
15
  /**
6
16
  * @param {Object} arg - Arg object.
7
17
  * @param {string} [arg.q] - A search string that is searched with product
8
18
  * bundle name.
9
19
  * @param {string[]} [arg.slug] - Slugs of bundles to be retrieved.
20
+ * @returns {Promise<GetProductBundleListingResponse>} - Success response
10
21
  * @summary: List all Product Bundles
11
22
  * @description: Get all product bundles for a particular company
12
23
  */
13
24
  getProductBundle({ q, slug }?: {
14
25
  q?: string;
15
26
  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: ProductBundleRequest;
25
- }): Promise<any>;
27
+ }): Promise<GetProductBundleListingResponse>;
26
28
  /**
27
29
  * @param {Object} arg - Arg object.
28
30
  * @param {string} arg.id - A `id` is a unique identifier for a particular
29
31
  * detail. Pass the `id` of the keywords which you want to retrieve.
32
+ * @returns {Promise<GetProductBundleResponse>} - Success response
30
33
  * @summary: Get a particular Product Bundle details
31
34
  * @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
32
35
  */
33
36
  getProductBundleDetail({ id }?: {
34
37
  id: string;
35
- }): Promise<any>;
38
+ }): Promise<GetProductBundleResponse>;
36
39
  /**
37
40
  * @param {Object} arg - Arg object.
38
41
  * @param {string} arg.id - A `id` is a unique identifier for a particular
39
42
  * detail. Pass the `id` of the keywords which you want to delete.
40
43
  * @param {ProductBundleUpdateRequest} arg.body
44
+ * @returns {Promise<GetProductBundleCreateResponse>} - Success response
41
45
  * @summary: Update a Product Bundle
42
46
  * @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
43
47
  */
44
48
  updateProductBundle({ id, body }?: {
45
49
  id: string;
46
50
  body: ProductBundleUpdateRequest;
47
- }): Promise<any>;
51
+ }): Promise<GetProductBundleCreateResponse>;
52
+ /**
53
+ * @param {Object} arg - Arg object.
54
+ * @param {ValidateSizeGuide} arg.body
55
+ * @returns {Promise<SuccessResponse>} - Success response
56
+ * @summary: Create a size guide.
57
+ * @description: This API allows to create a size guide associated to a brand.
58
+ */
59
+ createSizeGuide({ body }?: {
60
+ body: ValidateSizeGuide;
61
+ }): Promise<SuccessResponse>;
48
62
  /**
49
63
  * @param {Object} arg - Arg object.
50
64
  * @param {boolean} [arg.active] - Filter size guide on basis of active, in-active
@@ -54,6 +68,7 @@ declare class Catalog {
54
68
  * given set of results
55
69
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
56
70
  * page. Default is 10.
71
+ * @returns {Promise<ListSizeGuide>} - Success response
57
72
  * @summary: Get list of size guides
58
73
  * @description: This API allows to view all the size guides associated to the seller.
59
74
  */
@@ -63,70 +78,67 @@ declare class Catalog {
63
78
  tag?: string;
64
79
  pageNo?: number;
65
80
  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: ValidateSizeGuide;
75
- }): Promise<any>;
81
+ }): Promise<ListSizeGuide>;
76
82
  /**
77
83
  * @param {Object} arg - Arg object.
78
84
  * @param {string} arg.id - Id of the size guide to be viewed.
85
+ * @returns {Promise<SizeGuideResponse>} - Success response
79
86
  * @summary: Get a single size guide.
80
87
  * @description: This API helps to get data associated to a size guide.
81
88
  */
82
89
  getSizeGuide({ id }?: {
83
90
  id: string;
84
- }): Promise<any>;
91
+ }): Promise<SizeGuideResponse>;
85
92
  /**
86
93
  * @param {Object} arg - Arg object.
87
94
  * @param {string} arg.id - Mongo id of the size guide to be edited
88
95
  * @param {ValidateSizeGuide} arg.body
96
+ * @returns {Promise<SuccessResponse>} - Success response
89
97
  * @summary: Edit a size guide.
90
98
  * @description: This API allows to edit a size guide.
91
99
  */
92
100
  updateSizeGuide({ id, body }?: {
93
101
  id: string;
94
102
  body: ValidateSizeGuide;
95
- }): Promise<any>;
103
+ }): Promise<SuccessResponse>;
96
104
  /**
97
105
  * @param {Object} arg - Arg object.
98
106
  * @param {string} arg.sellerAppId - Id of the seller application which is
99
107
  * serving the invetory/catalog of the company
108
+ * @returns {Promise<CrossSellingResponse>} - Success response
100
109
  * @summary: Analytics data of catalog and inventory that are being cross-selled.
101
110
  * @description: Analytics data of catalog and inventory that are being cross-selled.
102
111
  */
103
112
  getSellerInsights({ sellerAppId }?: {
104
113
  sellerAppId: string;
105
- }): Promise<any>;
114
+ }): Promise<CrossSellingResponse>;
106
115
  /**
107
116
  * @param {Object} arg - Arg object.
108
117
  * @param {string} arg.marketplace - The marketplace for which the detail
109
118
  * needs to be retrieved.
110
119
  * @param {OptInPostRequest} arg.body
120
+ * @returns {Promise<UpdatedResponse>} - Success response
111
121
  * @summary: Create/Update opt-in infomation.
112
122
  * @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
123
  */
114
124
  createMarketplaceOptin({ marketplace, body }?: {
115
125
  marketplace: string;
116
126
  body: OptInPostRequest;
117
- }): Promise<any>;
127
+ }): Promise<UpdatedResponse>;
118
128
  /**
119
129
  * @param {Object} arg - Arg object.
130
+ * @returns {Promise<GetOptInPlatform>} - Success response
120
131
  * @summary: Get opt-in infomation.
121
132
  * @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
133
  */
123
- getMarketplaceOptinDetail({}?: any): Promise<any>;
134
+ getMarketplaceOptinDetail({}?: any): Promise<GetOptInPlatform>;
124
135
  /**
125
136
  * @param {Object} arg - Arg object.
137
+ * @returns {Promise<OptinCompanyDetail>} - Success response
126
138
  * @summary: Get the Company details.
127
139
  * @description: Get the details of the company associated with the given company_id passed.
128
140
  */
129
- getCompanyDetail({}?: any): Promise<any>;
141
+ getCompanyDetail({}?: any): Promise<OptinCompanyDetail>;
130
142
  /**
131
143
  * @param {Object} arg - Arg object.
132
144
  * @param {boolean} [arg.isActive] - The is_active status for the optin id.
@@ -136,28 +148,31 @@ declare class Catalog {
136
148
  * the page for the company id.
137
149
  * @param {string} [arg.marketplace] - The marketplace platform associated
138
150
  * with the company id.
151
+ * @returns {Promise<OptinCompanyBrandDetailsView>} - Success response
139
152
  * @summary: Get the Company Brand details of Optin.
140
153
  * @description: Get the details of the Brands associated with the given company_id passed.
141
154
  */
142
- getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace }?: {
155
+ getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, }?: {
143
156
  isActive?: boolean;
144
157
  q?: boolean;
145
158
  pageNo?: number;
146
159
  pageSize?: number;
147
160
  marketplace?: string;
148
- }): Promise<any>;
161
+ }): Promise<OptinCompanyBrandDetailsView>;
149
162
  /**
150
163
  * @param {Object} arg - Arg object.
164
+ * @returns {Promise<OptinCompanyMetrics>} - Success response
151
165
  * @summary: Get the Company metrics
152
166
  * @description: Get the Company metrics associated with the company ID passed.
153
167
  */
154
- getCompanyMetrics({}?: any): Promise<any>;
168
+ getCompanyMetrics({}?: any): Promise<OptinCompanyMetrics>;
155
169
  /**
156
170
  * @param {Object} arg - Arg object.
157
171
  * @param {string} [arg.q] - The search related the store for the company id.
158
172
  * @param {number} [arg.pageNo] - The number of page for the company id.
159
173
  * @param {number} [arg.pageSize] - Number of records that can be seen on
160
174
  * the page for the company id.
175
+ * @returns {Promise<OptinStoreDetails>} - Success response
161
176
  * @summary: Get the Store details.
162
177
  * @description: Get the details of the store associated with the company ID passed.
163
178
  */
@@ -165,34 +180,48 @@ declare class Catalog {
165
180
  q?: string;
166
181
  pageNo?: number;
167
182
  pageSize?: number;
168
- }): Promise<any>;
183
+ }): Promise<OptinStoreDetails>;
169
184
  /**
170
185
  * @param {Object} arg - Arg object.
171
186
  * @param {string} arg.attributeSlug - Slug of the attribute for which you
172
187
  * want to view the genders
188
+ * @returns {Promise<GenderDetail>} - Success response
173
189
  * @summary: Get gender attribute details
174
190
  * @description: This API allows to view the gender attribute details.
175
191
  */
176
192
  getGenderAttribute({ attributeSlug }?: {
177
193
  attributeSlug: string;
178
- }): Promise<any>;
194
+ }): Promise<GenderDetail>;
179
195
  /**
180
196
  * @param {Object} arg - Arg object.
181
197
  * @param {string} arg.departments - A `department` is name of a departments
182
198
  * whose category needs to be listed. Can specify multiple departments.
183
199
  * @param {string} arg.itemType - An `item_type` is the type of item, it can
184
200
  * be `set`, `standard`, `digital`, etc.
201
+ * @returns {Promise<ProdcutTemplateCategoriesResponse>} - Success response
185
202
  * @summary: List Department specifiec product categories
186
203
  * @description: Allows you to list all product categories values for the departments specified
187
204
  */
188
205
  listProductTemplateCategories({ departments, itemType }?: {
189
206
  departments: string;
190
207
  itemType: string;
191
- }): Promise<any>;
208
+ }): Promise<ProdcutTemplateCategoriesResponse>;
209
+ /**
210
+ * @param {Object} arg - Arg object.
211
+ * @param {DepartmentCreateUpdate} arg.body
212
+ * @returns {Promise<DepartmentCreateResponse>} - Success response
213
+ * @summary: Create the department.
214
+ * @description: Create departments using the API.
215
+ */
216
+ createDepartments({ body }?: {
217
+ body: DepartmentCreateUpdate;
218
+ }): Promise<DepartmentCreateResponse>;
192
219
  /**
193
220
  * @param {Object} arg - Arg object.
194
221
  * @param {number} [arg.pageNo] - The page number to navigate through the
195
222
  * given set of results
223
+ * @param {string} [arg.itemType] - A `item_type` is a type of product eg.
224
+ * set, standard, digital
196
225
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
197
226
  * page. Default is 10.
198
227
  * @param {string} [arg.name] - Can search departments by passing name.
@@ -200,116 +229,165 @@ declare class Catalog {
200
229
  * the department in search parameter.
201
230
  * @param {boolean} [arg.isActive] - Can query for departments based on
202
231
  * whether they are active or inactive.
232
+ * @returns {Promise<DepartmentsResponse>} - Success response
203
233
  * @summary: List all Departments.
204
234
  * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
205
235
  */
206
- listDepartmentsData({ pageNo, pageSize, name, search, isActive }?: {
236
+ listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, }?: {
207
237
  pageNo?: number;
238
+ itemType?: string;
208
239
  pageSize?: number;
209
240
  name?: string;
210
241
  search?: string;
211
242
  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: DepartmentCreateUpdate;
221
- }): Promise<any>;
243
+ }): Promise<DepartmentsResponse>;
222
244
  /**
223
245
  * @param {Object} arg - Arg object.
224
246
  * @param {string} arg.uid - A `uid` is a unique identifier of a department.
247
+ * @returns {Promise<DepartmentsResponse>} - Success response
225
248
  * @summary: Get specific departments details by passing in unique id of the department.
226
249
  * @description: Allows you to get department data, by uid.
227
250
  */
228
251
  getDepartmentData({ uid }?: {
229
252
  uid: string;
230
- }): Promise<any>;
253
+ }): Promise<DepartmentsResponse>;
231
254
  /**
232
255
  * @param {Object} arg - Arg object.
233
256
  * @param {string} arg.uid - A `uid` is a unique identifier of a department.
234
257
  * @param {DepartmentCreateUpdate} arg.body
258
+ * @returns {Promise<DepartmentModel>} - Success response
235
259
  * @summary: Update the department by their uid.
236
260
  * @description: Update the department by their uid using this API.
237
261
  */
238
262
  updateDepartment({ uid, body }?: {
239
263
  uid: string;
240
264
  body: DepartmentCreateUpdate;
241
- }): Promise<any>;
265
+ }): Promise<DepartmentModel>;
242
266
  /**
243
267
  * @param {Object} arg - Arg object.
244
268
  * @param {string} arg.department - A `department` is the name of a
245
269
  * particular department.
270
+ * @returns {Promise<TemplatesResponse>} - Success response
246
271
  * @summary: List all Templates
247
272
  * @description: Allows you to list all product templates, also can filter by department
248
273
  */
249
274
  listProductTemplate({ department }?: {
250
275
  department: string;
251
- }): Promise<any>;
276
+ }): Promise<TemplatesResponse>;
252
277
  /**
253
278
  * @param {Object} arg - Arg object.
254
279
  * @param {string} arg.slug - A `slug` is a unique identifier for a
255
280
  * particular template.
281
+ * @returns {Promise<TemplatesValidationResponse>} - Success response
256
282
  * @summary: Validate Product Template Schema
257
283
  * @description: Allows you to list all product templates validation values for all the fields present in the database
258
284
  */
259
285
  validateProductTemplate({ slug }?: {
260
286
  slug: string;
261
- }): Promise<any>;
287
+ }): Promise<TemplatesValidationResponse>;
262
288
  /**
263
289
  * @param {Object} arg - Arg object.
264
290
  * @param {string} arg.slug - A `slug` is a unique identifier for a
265
291
  * particular template.
292
+ * @returns {Promise<string>} - Success response
266
293
  * @summary: Download Product Template View
267
294
  * @description: Allows you to download product template data
268
295
  */
269
296
  downloadProductTemplateViews({ slug }?: {
270
297
  slug: string;
271
- }): Promise<any>;
298
+ }): Promise<string>;
272
299
  /**
273
300
  * @param {Object} arg - Arg object.
274
301
  * @param {string} arg.itemType - An `item_type` defines the type of item.
302
+ * @returns {Promise<string>} - Success response
275
303
  * @summary: Download Product Template View
276
304
  * @description: Allows you to download product template data
277
305
  */
278
306
  downloadInventoryTemplateView({ itemType }?: {
279
307
  itemType: string;
280
- }): Promise<any>;
308
+ }): Promise<string>;
281
309
  /**
282
310
  * @param {Object} arg - Arg object.
283
311
  * @param {string} arg.itemType - An `item_type` defines the type of item.
284
312
  * The default value is standard.
313
+ * @returns {Promise<InventoryValidationResponse>} - Success response
285
314
  * @summary: Validate Product Template Schema
286
315
  * @description: Allows you to list all product templates validation values for all the fields present in the database
287
316
  */
288
317
  validateProductTemplateSchema({ itemType }?: {
289
318
  itemType: string;
290
- }): Promise<any>;
319
+ }): Promise<InventoryValidationResponse>;
291
320
  /**
292
321
  * @param {Object} arg - Arg object.
322
+ * @returns {Promise<HSNCodesResponse>} - Success response
293
323
  * @summary: List HSN Codes
294
324
  * @description: Allows you to list all hsn Codes
295
325
  */
296
- listHSNCodes({}?: any): Promise<any>;
326
+ listHSNCodes({}?: any): Promise<HSNCodesResponse>;
327
+ /**
328
+ * @param {Object} arg - Arg object.
329
+ * @returns {Promise<ProductDownloadsResponse>} - Success response
330
+ * @summary: Allows you to list all product templates export list details
331
+ * @description: Can view details including trigger data, task id , etc.
332
+ */
333
+ listProductTemplateExportDetails({}?: any): Promise<ProductDownloadsResponse>;
334
+ /**
335
+ * @param {Object} arg - Arg object.
336
+ * @param {ProductTemplateDownloadsExport} arg.body
337
+ * @returns {Promise<ProductDownloadsResponse>} - Success response
338
+ * @summary: Create a product export job.
339
+ * @description: This API helps to create a Inventory export job.
340
+ */
341
+ createProductExportJob({ body }?: {
342
+ body: ProductTemplateDownloadsExport;
343
+ }): Promise<ProductDownloadsResponse>;
297
344
  /**
298
345
  * @param {Object} arg - Arg object.
346
+ * @param {string} [arg.status] - This is a parameter used to find all the
347
+ * jobs with the specified status.
348
+ * @param {string} [arg.fromDate] - This is a parameter used to find the job
349
+ * from the date specified to the current date.
350
+ * @param {string} [arg.toDate] - This is a parameter used to find the job
351
+ * from the from_date specified to the to_date.
352
+ * @param {string} [arg.q] - It is a query parameter to search the export
353
+ * job with the task ID.
354
+ * @returns {Promise<ProductDownloadsResponse>} - Success response
299
355
  * @summary: Allows you to list all product templates export list details
300
356
  * @description: Can view details including trigger data, task id , etc.
301
357
  */
302
- listProductTemplateExportDetails({}?: any): Promise<any>;
358
+ getProductExportJobs({ status, fromDate, toDate, q }?: {
359
+ status?: string;
360
+ fromDate?: string;
361
+ toDate?: string;
362
+ q?: string;
363
+ }): Promise<ProductDownloadsResponse>;
303
364
  /**
304
365
  * @param {Object} arg - Arg object.
305
366
  * @param {string} arg.filter - A `filter` is the unique identifier of the
306
367
  * type of value required.
368
+ * @param {string} [arg.templateTag] - A `template_tag` is the identifier of
369
+ * the type of template required.
370
+ * @param {string} [arg.itemType] - A `item_type` is the identifier of the
371
+ * type of template required.
372
+ * @returns {Promise<ProductConfigurationDownloads>} - Success response
307
373
  * @summary: Allows you to list all values for Templates, Brands or Type
308
374
  * @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
375
  */
310
- listTemplateBrandTypeValues({ filter }?: {
376
+ listTemplateBrandTypeValues({ filter, templateTag, itemType }?: {
311
377
  filter: string;
312
- }): Promise<any>;
378
+ templateTag?: string;
379
+ itemType?: string;
380
+ }): Promise<ProductConfigurationDownloads>;
381
+ /**
382
+ * @param {Object} arg - Arg object.
383
+ * @param {CategoryRequestBody} arg.body
384
+ * @returns {Promise<CategoryCreateResponse>} - Success response
385
+ * @summary: Create product categories
386
+ * @description: This API lets user create product categories
387
+ */
388
+ createCategories({ body }?: {
389
+ body: CategoryRequestBody;
390
+ }): Promise<CategoryCreateResponse>;
313
391
  /**
314
392
  * @param {Object} arg - Arg object.
315
393
  * @param {string} [arg.level] - Get category for multiple levels
@@ -319,6 +397,7 @@ declare class Catalog {
319
397
  * given set of results
320
398
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
321
399
  * page. Default is 10.
400
+ * @returns {Promise<CategoryResponse>} - Success response
322
401
  * @summary: Get product categories list
323
402
  * @description: This API gets meta associated to product categories.
324
403
  */
@@ -328,36 +407,39 @@ declare class Catalog {
328
407
  q?: string;
329
408
  pageNo?: number;
330
409
  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: CategoryRequestBody;
340
- }): Promise<any>;
410
+ }): Promise<CategoryResponse>;
341
411
  /**
342
412
  * @param {Object} arg - Arg object.
343
413
  * @param {string} arg.uid - Category unique id
414
+ * @returns {Promise<SingleCategoryResponse>} - Success response
344
415
  * @summary: Get product category by uid
345
416
  * @description: This API gets meta associated to product categories.
346
417
  */
347
418
  getCategoryData({ uid }?: {
348
419
  uid: string;
349
- }): Promise<any>;
420
+ }): Promise<SingleCategoryResponse>;
350
421
  /**
351
422
  * @param {Object} arg - Arg object.
352
423
  * @param {string} arg.uid - Category unique id
353
424
  * @param {CategoryRequestBody} arg.body
425
+ * @returns {Promise<CategoryUpdateResponse>} - Success response
354
426
  * @summary: Update product categories
355
427
  * @description: Update a product category using this apu
356
428
  */
357
429
  updateCategory({ uid, body }?: {
358
430
  uid: string;
359
431
  body: CategoryRequestBody;
360
- }): Promise<any>;
432
+ }): Promise<CategoryUpdateResponse>;
433
+ /**
434
+ * @param {Object} arg - Arg object.
435
+ * @param {ProductCreateUpdateSchemaV2} arg.body
436
+ * @returns {Promise<SuccessResponse>} - Success response
437
+ * @summary: Create a product.
438
+ * @description: This API allows to create product.
439
+ */
440
+ createProduct({ body }?: {
441
+ body: ProductCreateUpdateSchemaV2;
442
+ }): Promise<SuccessResponse>;
361
443
  /**
362
444
  * @param {Object} arg - Arg object.
363
445
  * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
@@ -373,6 +455,7 @@ declare class Catalog {
373
455
  * given set of results
374
456
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
375
457
  * page. Default is 10.
458
+ * @returns {Promise<ProductListingResponseV2>} - Success response
376
459
  * @summary: Get product list
377
460
  * @description: This API gets meta associated to products.
378
461
  */
@@ -386,16 +469,7 @@ declare class Catalog {
386
469
  tags?: string[];
387
470
  pageNo?: number;
388
471
  pageSize?: number;
389
- }): Promise<any>;
390
- /**
391
- * @param {Object} arg - Arg object.
392
- * @param {ProductCreateUpdateSchemaV2} arg.body
393
- * @summary: Create a product.
394
- * @description: This API allows to create product.
395
- */
396
- createProduct({ body }?: {
397
- body: ProductCreateUpdateSchemaV2;
398
- }): Promise<any>;
472
+ }): Promise<ProductListingResponseV2>;
399
473
  /**
400
474
  * @param {Object} arg - Arg object.
401
475
  * @param {number} arg.itemId - Get list of variants of item Id
@@ -404,6 +478,7 @@ declare class Catalog {
404
478
  * given set of results
405
479
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
406
480
  * page. Default is 10.
481
+ * @returns {Promise<ProductVariantsResponse>} - Success response
407
482
  * @summary: Get product list
408
483
  * @description: This API gets meta associated to products.
409
484
  */
@@ -412,24 +487,26 @@ declare class Catalog {
412
487
  variantType: string;
413
488
  pageNo?: number;
414
489
  pageSize?: number;
415
- }): Promise<any>;
490
+ }): Promise<ProductVariantsResponse>;
416
491
  /**
417
492
  * @param {Object} arg - Arg object.
418
493
  * @param {string} arg.category - It is the name of the l3 cateogry
419
494
  * @param {boolean} [arg.filter] - If true, returns filtered values, else
420
495
  * returns all the attributes
496
+ * @returns {Promise<ProductAttributesResponse>} - Success response
421
497
  * @summary: Get list of all the attributes by their l3_categories
422
498
  * @description: This API allows to list all the attributes by their l3_categories.
423
499
  */
424
500
  getProductAttributes({ category, filter }?: {
425
501
  category: string;
426
502
  filter?: boolean;
427
- }): Promise<any>;
503
+ }): Promise<ProductAttributesResponse>;
428
504
  /**
429
505
  * @param {Object} arg - Arg object.
430
506
  * @param {number} arg.itemId - Item Id of the product.
431
507
  * @param {number} [arg.brandUid] - Brand Id of the product.
432
508
  * @param {string} [arg.itemCode] - Item code of the product.
509
+ * @returns {Promise<SingleProductResponse>} - Success response
433
510
  * @summary: Get a single product.
434
511
  * @description: This API helps to get data associated to a particular product.
435
512
  */
@@ -437,48 +514,53 @@ declare class Catalog {
437
514
  itemId: number;
438
515
  brandUid?: number;
439
516
  itemCode?: string;
440
- }): Promise<any>;
517
+ }): Promise<SingleProductResponse>;
441
518
  /**
442
519
  * @param {Object} arg - Arg object.
443
520
  * @param {number} arg.itemId - Id of the product to be updated.
444
521
  * @param {ProductCreateUpdateSchemaV2} arg.body
522
+ * @returns {Promise<SuccessResponse>} - Success response
445
523
  * @summary: Edit a product.
446
524
  * @description: This API allows to edit product.
447
525
  */
448
526
  editProduct({ itemId, body }?: {
449
527
  itemId: number;
450
528
  body: ProductCreateUpdateSchemaV2;
451
- }): Promise<any>;
529
+ }): Promise<SuccessResponse>;
452
530
  /**
453
531
  * @param {Object} arg - Arg object.
454
532
  * @param {number} arg.itemId - Id of the product to be updated.
533
+ * @returns {Promise<SuccessResponse>} - Success response
455
534
  * @summary: Delete a product.
456
535
  * @description: This API allows to delete product.
457
536
  */
458
537
  deleteProduct({ itemId }?: {
459
538
  itemId: number;
460
- }): Promise<any>;
539
+ }): Promise<SuccessResponse>;
461
540
  /**
462
541
  * @param {Object} arg - Arg object.
463
542
  * @param {number} arg.itemId - Id of the product to be updated.
543
+ * @returns {Promise<GetAllSizes>} - Success response
464
544
  * @summary: All Sizes for a given Product
465
545
  * @description: This API allows to get All Sizes for a given Product.
466
546
  */
467
547
  allSizes({ itemId }?: {
468
548
  itemId: number;
469
- }): Promise<any>;
549
+ }): Promise<GetAllSizes>;
470
550
  /**
471
551
  * @param {Object} arg - Arg object.
552
+ * @returns {Promise<ValidateProduct>} - Success response
472
553
  * @summary: Validate product/size data
473
554
  * @description: This API validates product data.
474
555
  */
475
- getProductValidation({}?: any): Promise<any>;
556
+ getProductValidation({}?: any): Promise<ValidateProduct>;
476
557
  /**
477
558
  * @param {Object} arg - Arg object.
478
559
  * @param {string} [arg.itemCode] - Item code of the product size.
479
560
  * @param {number} arg.itemId - Item Id of the product size.
480
561
  * @param {number} [arg.brandUid] - Brand Id of the product size.
481
562
  * @param {number} [arg.uid] - Id of the product size.
563
+ * @returns {Promise<ProductListingResponse>} - Success response
482
564
  * @summary: Get a single product size.
483
565
  * @description: This API helps to get data associated to a particular product size.
484
566
  */
@@ -487,7 +569,17 @@ declare class Catalog {
487
569
  itemId: number;
488
570
  brandUid?: number;
489
571
  uid?: number;
490
- }): Promise<any>;
572
+ }): Promise<ProductListingResponse>;
573
+ /**
574
+ * @param {Object} arg - Arg object.
575
+ * @param {BulkJob} arg.body
576
+ * @returns {Promise<BulkResponse>} - Success response
577
+ * @summary: Create a Bulk product to upload job.
578
+ * @description: This API helps to create a bulk products upload job.
579
+ */
580
+ createBulkProductUploadJob({ body }?: {
581
+ body: BulkJob;
582
+ }): Promise<BulkResponse>;
491
583
  /**
492
584
  * @param {Object} arg - Arg object.
493
585
  * @param {string} [arg.search] - Search string to filter the results by batch id
@@ -495,6 +587,7 @@ declare class Catalog {
495
587
  * given set of results
496
588
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
497
589
  * page. Default is 12.
590
+ * @returns {Promise<ProductBulkRequestList>} - Success response
498
591
  * @summary: Get a list of all bulk product upload jobs.
499
592
  * @description: This API helps to get bulk product upload jobs data.
500
593
  */
@@ -502,22 +595,14 @@ declare class Catalog {
502
595
  search?: string;
503
596
  pageNo?: number;
504
597
  pageSize?: number;
505
- }): Promise<any>;
506
- /**
507
- * @param {Object} arg - Arg object.
508
- * @param {BulkJob} arg.body
509
- * @summary: Create a Bulk product to upload job.
510
- * @description: This API helps to create a bulk products upload job.
511
- */
512
- createBulkProductUploadJob({ body }?: {
513
- body: BulkJob;
514
- }): Promise<any>;
598
+ }): Promise<ProductBulkRequestList>;
515
599
  /**
516
600
  * @param {Object} arg - Arg object.
517
601
  * @param {string} arg.department - Department of the product to be uploaded.
518
602
  * @param {string} arg.productType - Product type of the product to be
519
603
  * uploaded i.e. set, standard , digital.
520
604
  * @param {BulkJob} arg.body
605
+ * @returns {Promise<BulkResponse>} - Success response
521
606
  * @summary: Create a Bulk product to upload job.
522
607
  * @description: This API helps to create a bulk products upload job.
523
608
  */
@@ -525,70 +610,90 @@ declare class Catalog {
525
610
  department: string;
526
611
  productType: string;
527
612
  body: BulkJob;
528
- }): Promise<any>;
529
- /**
530
- * @param {Object} arg - Arg object.
531
- * @param {number} arg.batchId - Batch Id of the bulk product job to be deleted.
532
- * @summary: Delete Bulk product job.
533
- * @description: This API allows to delete bulk product job associated with company.
534
- */
535
- deleteProductBulkJob({ batchId }?: {
536
- batchId: number;
537
- }): Promise<any>;
613
+ }): Promise<BulkResponse>;
538
614
  /**
539
615
  * @param {Object} arg - Arg object.
540
616
  * @param {string} arg.batchId - Batch Id in which assets to be uploaded.
541
617
  * @param {BulkProductRequest} arg.body
618
+ * @returns {Promise<SuccessResponse>} - Success response
542
619
  * @summary: Create products in bulk associated with given batch Id.
543
620
  * @description: This API helps to create products in bulk push to kafka for approval/creation.
544
621
  */
545
622
  createProductsInBulk({ batchId, body }?: {
546
623
  batchId: string;
547
624
  body: BulkProductRequest;
548
- }): Promise<any>;
625
+ }): Promise<SuccessResponse>;
626
+ /**
627
+ * @param {Object} arg - Arg object.
628
+ * @param {number} arg.batchId - Batch Id of the bulk product job to be deleted.
629
+ * @returns {Promise<SuccessResponse>} - Success response
630
+ * @summary: Delete Bulk product job.
631
+ * @description: This API allows to delete bulk product job associated with company.
632
+ */
633
+ deleteProductBulkJob({ batchId }?: {
634
+ batchId: number;
635
+ }): Promise<SuccessResponse>;
549
636
  /**
550
637
  * @param {Object} arg - Arg object.
638
+ * @returns {Promise<ProductTagsViewResponse>} - Success response
551
639
  * @summary: Get a list of all tags associated with company.
552
640
  * @description: This API helps to get tags data associated to a particular company.
553
641
  */
554
- getProductTags({}?: any): Promise<any>;
642
+ getProductTags({}?: any): Promise<ProductTagsViewResponse>;
643
+ /**
644
+ * @param {Object} arg - Arg object.
645
+ * @param {ProductBulkAssets} arg.body
646
+ * @returns {Promise<SuccessResponse>} - Success response
647
+ * @summary: Create a Bulk asset upload Job.
648
+ * @description: This API helps to create a bulk asset upload job.
649
+ */
650
+ createProductAssetsInBulk({ body }?: {
651
+ body: ProductBulkAssets;
652
+ }): Promise<SuccessResponse>;
555
653
  /**
556
654
  * @param {Object} arg - Arg object.
557
655
  * @param {number} [arg.pageNo] - The page number to navigate through the
558
656
  * given set of results
559
657
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
560
658
  * page. Default is 12.
659
+ * @returns {Promise<BulkAssetResponse>} - Success response
561
660
  * @summary: Get a list of all bulk asset jobs.
562
661
  * @description: This API helps to get bulk asset jobs data associated to a particular company.
563
662
  */
564
663
  getProductAssetsInBulk({ pageNo, pageSize }?: {
565
664
  pageNo?: number;
566
665
  pageSize?: number;
567
- }): Promise<any>;
568
- /**
569
- * @param {Object} arg - Arg object.
570
- * @param {ProductBulkAssets} arg.body
571
- * @summary: Create a Bulk asset upload Job.
572
- * @description: This API helps to create a bulk asset upload job.
573
- */
574
- createProductAssetsInBulk({ body }?: {
575
- body: ProductBulkAssets;
576
- }): Promise<any>;
666
+ }): Promise<BulkAssetResponse>;
577
667
  /**
578
668
  * @param {Object} arg - Arg object.
579
669
  * @param {number} arg.itemId - Item Id of the product associated with size
580
670
  * to be deleted.
581
671
  * @param {string} arg.size - Size to be deleted.
672
+ * @returns {Promise<ProductSizeDeleteResponse>} - Success response
582
673
  * @summary: Delete a Size associated with product.
583
674
  * @description: This API allows to delete size associated with product.
584
675
  */
585
676
  deleteSize({ itemId, size }?: {
586
677
  itemId: number;
587
678
  size: string;
588
- }): Promise<any>;
679
+ }): Promise<ProductSizeDeleteResponse>;
589
680
  /**
590
681
  * @param {Object} arg - Arg object.
591
- * @param {string} arg.itemId - Item code of the product of which size is to be get.
682
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
683
+ * @param {string} arg.size - Size in which inventory is to be added.
684
+ * @param {InventoryRequest} arg.body
685
+ * @returns {Promise<SuccessResponse>} - Success response
686
+ * @summary: Add Inventory for particular size and store.
687
+ * @description: This API allows add Inventory for particular size and store.
688
+ */
689
+ addInventory({ itemId, size, body }?: {
690
+ itemId: number;
691
+ size: string;
692
+ body: InventoryRequest;
693
+ }): Promise<SuccessResponse>;
694
+ /**
695
+ * @param {Object} arg - Arg object.
696
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
592
697
  * @param {string} arg.size - Size of which inventory is to get.
593
698
  * @param {number} [arg.pageNo] - The page number to navigate through the
594
699
  * given set of results
@@ -596,33 +701,21 @@ declare class Catalog {
596
701
  * page. Default is 12.
597
702
  * @param {string} [arg.q] - Search with help of store code.
598
703
  * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
704
+ * @returns {Promise<InventoryResponsePaginated>} - Success response
599
705
  * @summary: Get Inventory for company
600
706
  * @description: This API allows get Inventory data for particular company grouped by size and store.
601
707
  */
602
- getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable }?: {
603
- itemId: string;
708
+ getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, }?: {
709
+ itemId: number;
604
710
  size: string;
605
711
  pageNo?: number;
606
712
  pageSize?: number;
607
713
  q?: string;
608
714
  sellable?: boolean;
609
- }): Promise<any>;
715
+ }): Promise<InventoryResponsePaginated>;
610
716
  /**
611
717
  * @param {Object} arg - Arg object.
612
718
  * @param {number} arg.itemId - Item code of the product of which size is to be get.
613
- * @param {string} arg.size - Size in which inventory is to be added.
614
- * @param {InventoryRequest} arg.body
615
- * @summary: Add Inventory for particular size and store.
616
- * @description: This API allows add Inventory for particular size and store.
617
- */
618
- addInventory({ itemId, size, body }?: {
619
- itemId: number;
620
- size: string;
621
- body: InventoryRequest;
622
- }): Promise<any>;
623
- /**
624
- * @param {Object} arg - Arg object.
625
- * @param {string} arg.itemId - Item code of the product of which size is to be get.
626
719
  * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
627
720
  * or Primary Identifier) of which inventory is to get.
628
721
  * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -631,17 +724,18 @@ declare class Catalog {
631
724
  * page. Default is 12.
632
725
  * @param {string} [arg.q] - Search with help of store code.
633
726
  * @param {number[]} [arg.locationIds] - Search by store ids.
727
+ * @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
634
728
  * @summary: Get Inventory for company
635
729
  * @description: This API allows get Inventory data for particular company grouped by size and store.
636
730
  */
637
731
  getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
638
- itemId: string;
732
+ itemId: number;
639
733
  sizeIdentifier: string;
640
734
  pageNo?: number;
641
735
  pageSize?: number;
642
736
  q?: string;
643
737
  locationIds?: number[];
644
- }): Promise<any>;
738
+ }): Promise<InventorySellerIdentifierResponsePaginated>;
645
739
  /**
646
740
  * @param {Object} arg - Arg object.
647
741
  * @param {string} [arg.itemId] - Item code of the product of which size is to be get.
@@ -655,6 +749,7 @@ declare class Catalog {
655
749
  * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
656
750
  * @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
657
751
  * or Primary Identifier) of which inventory is to get.
752
+ * @returns {Promise<GetInventoriesResponse>} - Success response
658
753
  * @summary: Get Inventory for company
659
754
  * @description: This API allows get Inventories data for particular company.
660
755
  */
@@ -667,7 +762,7 @@ declare class Catalog {
667
762
  sellable?: boolean;
668
763
  storeIds?: number[];
669
764
  sizeIdentifier?: string;
670
- }): Promise<any>;
765
+ }): Promise<GetInventoriesResponse>;
671
766
  /**
672
767
  * @param {Object} arg - Arg object.
673
768
  * @param {string} arg.size - Size that is to be deleted.
@@ -675,6 +770,7 @@ declare class Catalog {
675
770
  * to be deleted.
676
771
  * @param {number} arg.locationId - Location ID of store of which inventory
677
772
  * is to be deleted.
773
+ * @returns {Promise<SuccessResponse>} - Success response
678
774
  * @summary: Delete a Inventory.
679
775
  * @description: This API allows to delete inventory of a particular product for particular company.
680
776
  */
@@ -682,168 +778,188 @@ declare class Catalog {
682
778
  size: string;
683
779
  itemId: number;
684
780
  locationId: number;
685
- }): Promise<any>;
781
+ }): Promise<SuccessResponse>;
782
+ /**
783
+ * @param {Object} arg - Arg object.
784
+ * @param {BulkJob} arg.body
785
+ * @returns {Promise<BulkResponse>} - Success response
786
+ * @summary: Create a Bulk Inventory upload Job.
787
+ * @description: This API helps to create a bulk Inventory upload job.
788
+ */
789
+ createBulkInventoryJob({ body }?: {
790
+ body: BulkJob;
791
+ }): Promise<BulkResponse>;
686
792
  /**
687
793
  * @param {Object} arg - Arg object.
688
794
  * @param {number} [arg.pageNo] - The page number to navigate through the
689
795
  * given set of results
690
796
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
691
797
  * page. Default is 12.
798
+ * @returns {Promise<BulkInventoryGet>} - Success response
692
799
  * @summary: Get a list of all bulk Inventory upload jobs.
693
800
  * @description: This API helps to get bulk Inventory upload jobs data.
694
801
  */
695
802
  getInventoryBulkUploadHistory({ pageNo, pageSize }?: {
696
803
  pageNo?: number;
697
804
  pageSize?: number;
698
- }): Promise<any>;
805
+ }): Promise<BulkInventoryGet>;
699
806
  /**
700
807
  * @param {Object} arg - Arg object.
701
- * @param {BulkJob} arg.body
702
- * @summary: Create a Bulk Inventory upload Job.
703
- * @description: This API helps to create a bulk Inventory upload job.
808
+ * @param {string} arg.batchId - Batch Id of the bulk create job.
809
+ * @param {InventoryBulkRequest} arg.body
810
+ * @returns {Promise<SuccessResponse>} - Success response
811
+ * @summary: Create products in bulk associated with given batch Id.
812
+ * @description: This API helps to create products in bulk push to kafka for approval/creation.
704
813
  */
705
- createBulkInventoryJob({ body }?: {
706
- body: BulkJob;
707
- }): Promise<any>;
814
+ createBulkInventory({ batchId, body }?: {
815
+ batchId: string;
816
+ body: InventoryBulkRequest;
817
+ }): Promise<SuccessResponse>;
708
818
  /**
709
819
  * @param {Object} arg - Arg object.
710
820
  * @param {string} arg.batchId - Batch Id of the bulk delete job.
821
+ * @returns {Promise<SuccessResponse>} - Success response
711
822
  * @summary: Delete Bulk Inventory job.
712
823
  * @description: This API allows to delete bulk Inventory job associated with company.
713
824
  */
714
825
  deleteBulkInventoryJob({ batchId }?: {
715
826
  batchId: string;
716
- }): Promise<any>;
827
+ }): Promise<SuccessResponse>;
717
828
  /**
718
829
  * @param {Object} arg - Arg object.
719
- * @param {string} arg.batchId - Batch Id of the bulk create job.
720
- * @param {InventoryBulkRequest} arg.body
721
- * @summary: Create products in bulk associated with given batch Id.
722
- * @description: This API helps to create products in bulk push to kafka for approval/creation.
830
+ * @param {InventoryExportRequest} arg.body
831
+ * @returns {Promise<InventoryExportResponse>} - Success response
832
+ * @summary: Create a Inventory export Job.
833
+ * @description: This API helps to create a Inventory export job.
723
834
  */
724
- createBulkInventory({ batchId, body }?: {
725
- batchId: string;
726
- body: InventoryBulkRequest;
727
- }): Promise<any>;
835
+ createInventoryExportJob({ body }?: {
836
+ body: InventoryExportRequest;
837
+ }): Promise<InventoryExportResponse>;
728
838
  /**
729
839
  * @param {Object} arg - Arg object.
840
+ * @returns {Promise<InventoryExportJob>} - Success response
730
841
  * @summary: Get Inventory export history.
731
842
  * @description: This API helps to get Inventory export history.
732
843
  */
733
- getInventoryExport({}?: any): Promise<any>;
844
+ getInventoryExport({}?: any): Promise<InventoryExportJob>;
734
845
  /**
735
846
  * @param {Object} arg - Arg object.
736
- * @param {InventoryExportRequest} arg.body
737
- * @summary: Create a Inventory export Job.
847
+ * @param {InventoryCreateRequest} arg.body
848
+ * @returns {Promise<InventoryExportResponse>} - Success response
849
+ * @summary: Create an inventory export job.
738
850
  * @description: This API helps to create a Inventory export job.
739
851
  */
740
- createInventoryExportJob({ body }?: {
741
- body: InventoryExportRequest;
742
- }): Promise<any>;
852
+ createInventoryExport({ body }?: {
853
+ body: InventoryCreateRequest;
854
+ }): Promise<InventoryExportResponse>;
855
+ /**
856
+ * @param {Object} arg - Arg object.
857
+ * @param {string} [arg.status] - Status of the export job.
858
+ * @param {string} [arg.fromDate] - Inventory export history filtered
859
+ * according to from_date.
860
+ * @param {string} [arg.toDate] - Inventory export history filtered
861
+ * according to from_date.
862
+ * @param {string} [arg.q] - Inventory export history filtered according to task ID.
863
+ * @returns {Promise<InventoryExportJobListResponse>} - Success response
864
+ * @summary: Get the history of the inventory export.
865
+ * @description: This API helps you the get the history of inventory jobs depending on the filtered criteria.
866
+ */
867
+ listInventoryExport({ status, fromDate, toDate, q }?: {
868
+ status?: string;
869
+ fromDate?: string;
870
+ toDate?: string;
871
+ q?: string;
872
+ }): Promise<InventoryExportJobListResponse>;
743
873
  /**
744
874
  * @param {Object} arg - Arg object.
745
875
  * @param {string} [arg.filterType] - Filter type from any one of ['brand',
746
876
  * 'store', 'type']
877
+ * @returns {Promise<InventoryConfig>} - Success response
747
878
  * @summary: Get List of different filters for inventory export
748
879
  * @description: This API allows get List of different filters like brand, store, and type for inventory export.
749
880
  */
750
881
  exportInventoryConfig({ filterType }?: {
751
882
  filterType?: string;
752
- }): Promise<any>;
883
+ }): Promise<InventoryConfig>;
753
884
  /**
754
885
  * @param {Object} arg - Arg object.
755
886
  * @param {number} arg.itemId - Item code of the product of which size is to be get.
756
887
  * @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
757
888
  * or Primary Identifier) of which inventory is to get.
758
889
  * @param {InventoryRequestSchemaV2} arg.body
890
+ * @returns {Promise<InventoryUpdateResponse>} - Success response
759
891
  * @summary: Add Inventory for particular size and store.
760
892
  * @description: This API allows add Inventory for particular size and store.
761
893
  */
762
- deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: {
894
+ updateRealtimeInventory({ itemId, sellerIdentifier, body }?: {
763
895
  itemId: number;
764
896
  sellerIdentifier: string;
765
897
  body: InventoryRequestSchemaV2;
766
- }): Promise<any>;
898
+ }): Promise<InventoryUpdateResponse>;
767
899
  /**
768
900
  * @param {Object} arg - Arg object.
769
901
  * @param {number} arg.itemId - Item code of the product of which size is to be get.
770
902
  * @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
771
903
  * or Primary Identifier) of which inventory is to get.
772
904
  * @param {InventoryRequestSchemaV2} arg.body
905
+ * @returns {Promise<InventoryUpdateResponse>} - Success response
773
906
  * @summary: Add Inventory for particular size and store.
774
907
  * @description: This API allows add Inventory for particular size and store.
775
908
  */
776
- updateRealtimeInventory({ itemId, sellerIdentifier, body }?: {
909
+ deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: {
777
910
  itemId: number;
778
911
  sellerIdentifier: string;
779
912
  body: InventoryRequestSchemaV2;
780
- }): Promise<any>;
913
+ }): Promise<InventoryUpdateResponse>;
781
914
  /**
782
915
  * @param {Object} arg - Arg object.
783
916
  * @param {InventoryRequestSchemaV2} arg.body
917
+ * @returns {Promise<InventoryUpdateResponse>} - Success response
784
918
  * @summary: Add Inventory for particular size and store.
785
919
  * @description: This API allows add Inventory for particular size and store.
786
920
  */
787
921
  updateInventories({ body }?: {
788
922
  body: InventoryRequestSchemaV2;
789
- }): Promise<any>;
790
- /**
791
- * @param {Object} arg - Arg object.
792
- * @param {number} [arg.pageNo] - Page no
793
- * @param {number} [arg.pageSize] - Page size
794
- * @param {string} [arg.q] - Search using hsn code.
795
- * @summary: Hsn Code List.
796
- * @description: Hsn Code List.
797
- */
798
- getAllHsnCodes({ pageNo, pageSize, q }?: {
799
- pageNo?: number;
800
- pageSize?: number;
801
- q?: string;
802
- }): Promise<any>;
803
- /**
804
- * @param {Object} arg - Arg object.
805
- * @param {HsnUpsert} arg.body
806
- * @summary: Create Hsn Code.
807
- * @description: Create Hsn Code.
808
- */
809
- createHsnCode({ body }?: {
810
- body: HsnUpsert;
811
- }): Promise<any>;
923
+ }): Promise<InventoryUpdateResponse>;
812
924
  /**
813
925
  * @param {Object} arg - Arg object.
814
926
  * @param {string} arg.id - Unique id
927
+ * @returns {Promise<HsnCode>} - Success response
815
928
  * @summary: Fetch Hsn Code.
816
929
  * @description: Fetch Hsn Code.
817
930
  */
818
931
  getHsnCode({ id }?: {
819
932
  id: string;
820
- }): Promise<any>;
933
+ }): Promise<HsnCode>;
821
934
  /**
822
935
  * @param {Object} arg - Arg object.
823
936
  * @param {string} arg.id - Unique id
824
937
  * @param {HsnUpsert} arg.body
938
+ * @returns {Promise<HsnCode>} - Success response
825
939
  * @summary: Update Hsn Code.
826
940
  * @description: Update Hsn Code.
827
941
  */
828
942
  updateHsnCode({ id, body }?: {
829
943
  id: string;
830
944
  body: HsnUpsert;
831
- }): Promise<any>;
945
+ }): Promise<HsnCode>;
832
946
  /**
833
947
  * @param {Object} arg - Arg object.
834
948
  * @param {BulkHsnUpsert} arg.body
949
+ * @returns {Promise<BulkHsnResponse>} - Success response
835
950
  * @summary: Bulk Create or Update Hsn Code.
836
951
  * @description: Bulk Create or Update Hsn Code.
837
952
  */
838
953
  bulkHsnCode({ body }?: {
839
954
  body: BulkHsnUpsert;
840
- }): Promise<any>;
955
+ }): Promise<BulkHsnResponse>;
841
956
  /**
842
957
  * @param {Object} arg - Arg object.
843
958
  * @param {number} [arg.pageNo] - Page no
844
959
  * @param {number} [arg.pageSize] - Page size
845
960
  * @param {string} [arg.q] - Search using hsn code, description, reporting_hsn
846
961
  * @param {string} [arg.type] - Search using type
962
+ * @returns {Promise<HsnCodesListingResponseSchemaV2>} - Success response
847
963
  * @summary: Hsn Code List.
848
964
  * @description: Hsn Code List.
849
965
  */
@@ -852,23 +968,25 @@ declare class Catalog {
852
968
  pageSize?: number;
853
969
  q?: string;
854
970
  type?: string;
855
- }): Promise<any>;
971
+ }): Promise<HsnCodesListingResponseSchemaV2>;
856
972
  /**
857
973
  * @param {Object} arg - Arg object.
858
974
  * @param {string} arg.reportingHsn - Reporting_hsn
975
+ * @returns {Promise<HSNDataInsertV2>} - Success response
859
976
  * @summary: Hsn Code List.
860
977
  * @description: Hsn Code List.
861
978
  */
862
979
  getSingleProductHSNCode({ reportingHsn }?: {
863
980
  reportingHsn: string;
864
- }): Promise<any>;
981
+ }): Promise<HSNDataInsertV2>;
865
982
  /**
866
983
  * @param {Object} arg - Arg object.
867
984
  * @param {AssignStore} arg.body
985
+ * @returns {Promise<StoreAssignResponse>} - Success response
868
986
  * @summary: Location Reassignment
869
987
  * @description:
870
988
  */
871
989
  getOptimalLocations({ body }?: {
872
990
  body: AssignStore;
873
- }): Promise<any>;
991
+ }): Promise<StoreAssignResponse>;
874
992
  }