@gofynd/fdk-client-javascript 1.0.0 → 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 (156) hide show
  1. package/documentation/application/CART.md +251 -251
  2. package/documentation/application/CATALOG.md +393 -393
  3. package/documentation/application/CONTENT.md +15 -1
  4. package/documentation/application/ORDER.md +268 -268
  5. package/documentation/application/PAYMENT.md +249 -249
  6. package/documentation/application/POSCART.md +297 -297
  7. package/documentation/platform/CART.md +499 -499
  8. package/documentation/platform/CATALOG.md +3497 -3097
  9. package/documentation/platform/COMPANYPROFILE.md +207 -207
  10. package/documentation/platform/CONTENT.md +123 -1
  11. package/documentation/platform/ORDER.md +1518 -1324
  12. package/documentation/platform/PARTNER.md +7 -7
  13. package/documentation/platform/PAYMENT.md +96 -96
  14. package/index.js +7 -1
  15. package/package.json +1 -1
  16. package/sdk/application/ApplicationConfig.js +1 -1
  17. package/sdk/application/Cart/CartApplicationClient.js +865 -52
  18. package/sdk/application/Cart/CartApplicationModel.d.ts +7 -7
  19. package/sdk/application/Cart/CartApplicationModel.js +335 -335
  20. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  21. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
  22. package/sdk/application/Catalog/CatalogApplicationClient.js +1034 -60
  23. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +19 -19
  24. package/sdk/application/Catalog/CatalogApplicationModel.js +532 -532
  25. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  26. package/sdk/application/Common/CommonApplicationClient.js +66 -4
  27. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  28. package/sdk/application/Communication/CommunicationApplicationClient.js +108 -6
  29. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  30. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +1 -1
  31. package/sdk/application/Configuration/ConfigurationApplicationClient.js +558 -32
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  33. package/sdk/application/Content/ContentApplicationClient.js +621 -38
  34. package/sdk/application/Content/ContentApplicationModel.d.ts +1 -0
  35. package/sdk/application/Content/ContentApplicationModel.js +11 -1
  36. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  37. package/sdk/application/FileStorage/FileStorageApplicationClient.js +101 -6
  38. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  39. package/sdk/application/Lead/LeadApplicationClient.js +229 -14
  40. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  41. package/sdk/application/Logistic/LogisticApplicationClient.js +134 -8
  42. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  44. package/sdk/application/Order/OrderApplicationClient.js +403 -24
  45. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  46. package/sdk/application/Order/OrderApplicationModel.js +334 -334
  47. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  48. package/sdk/application/Payment/PaymentApplicationClient.js +1381 -78
  49. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2 -2
  50. package/sdk/application/Payment/PaymentApplicationModel.js +350 -350
  51. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  52. package/sdk/application/PosCart/PosCartApplicationClient.js +914 -54
  53. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +15 -15
  54. package/sdk/application/PosCart/PosCartApplicationModel.js +389 -389
  55. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  56. package/sdk/application/Rewards/RewardsApplicationClient.js +235 -14
  57. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  58. package/sdk/application/Share/ShareApplicationClient.js +226 -14
  59. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  60. package/sdk/application/Theme/ThemeApplicationClient.js +130 -8
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  62. package/sdk/application/User/UserApplicationClient.js +1133 -70
  63. package/sdk/application/User/UserApplicationValidator.js +1 -0
  64. package/sdk/common/AxiosHelper.js +1 -1
  65. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +16 -8
  66. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +287 -16
  67. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  68. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +153 -8
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +141 -8
  71. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -12
  72. package/sdk/platform/Billing/BillingPlatformClient.js +429 -24
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -17
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +617 -34
  75. package/sdk/platform/Cart/CartPlatformModel.d.ts +35 -35
  76. package/sdk/platform/Cart/CartPlatformModel.js +617 -617
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +191 -138
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2202 -302
  79. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +11 -11
  80. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +45 -45
  81. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +344 -226
  82. package/sdk/platform/Catalog/CatalogPlatformClient.js +3282 -488
  83. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +110 -100
  84. package/sdk/platform/Catalog/CatalogPlatformModel.js +2073 -1795
  85. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +23 -21
  86. package/sdk/platform/Catalog/CatalogPlatformValidator.js +103 -84
  87. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -2
  88. package/sdk/platform/Common/CommonPlatformClient.js +73 -4
  89. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -40
  90. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1499 -80
  91. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  92. package/sdk/platform/Communication/CommunicationPlatformClient.js +41 -2
  93. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -14
  94. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +486 -26
  95. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +9 -9
  96. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +274 -274
  97. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +56 -28
  98. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1022 -56
  99. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  100. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +693 -36
  101. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +148 -67
  102. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2446 -140
  103. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -0
  104. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -0
  105. package/sdk/platform/Content/ContentPlatformModel.d.ts +4 -0
  106. package/sdk/platform/Content/ContentPlatformModel.js +43 -1
  107. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +21 -10
  108. package/sdk/platform/Discount/DiscountPlatformClient.js +400 -22
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +8 -4
  110. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +148 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +214 -12
  113. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +27 -14
  114. package/sdk/platform/Inventory/InventoryPlatformClient.js +449 -24
  115. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +26 -13
  116. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +447 -26
  117. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -11
  118. package/sdk/platform/Lead/LeadPlatformClient.js +384 -22
  119. package/sdk/platform/OAuthClient.js +8 -8
  120. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -3
  121. package/sdk/platform/Order/OrderPlatformApplicationClient.js +125 -6
  122. package/sdk/platform/Order/OrderPlatformClient.d.ts +108 -47
  123. package/sdk/platform/Order/OrderPlatformClient.js +1641 -100
  124. package/sdk/platform/Order/OrderPlatformModel.d.ts +69 -58
  125. package/sdk/platform/Order/OrderPlatformModel.js +1485 -1493
  126. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  127. package/sdk/platform/Order/OrderPlatformValidator.js +15 -4
  128. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  129. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +74 -4
  130. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  131. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  132. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -11
  133. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +418 -22
  134. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +21 -11
  135. package/sdk/platform/Payment/PaymentPlatformClient.js +374 -20
  136. package/sdk/platform/Payment/PaymentPlatformModel.js +139 -139
  137. package/sdk/platform/PlatformApplicationClient.d.ts +2973 -2827
  138. package/sdk/platform/PlatformApplicationClient.js +3461 -3263
  139. package/sdk/platform/PlatformClient.d.ts +2973 -2827
  140. package/sdk/platform/PlatformClient.js +3461 -3263
  141. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +26 -13
  142. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +449 -26
  143. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +8 -4
  144. package/sdk/platform/Share/SharePlatformApplicationClient.js +139 -8
  145. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +47 -23
  146. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +816 -48
  147. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +24 -12
  148. package/sdk/platform/User/UserPlatformApplicationClient.js +417 -24
  149. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +12 -6
  150. package/sdk/platform/Webhook/WebhookPlatformClient.js +229 -12
  151. package/sdk/public/Configuration/ConfigurationPublicClient.js +72 -4
  152. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  153. package/sdk/public/Inventory/InventoryPublicClient.js +210 -12
  154. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  155. package/sdk/public/Webhook/WebhookPublicClient.js +74 -4
  156. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -3,133 +3,159 @@ declare class Catalog {
3
3
  constructor(config: any, applicationId: any);
4
4
  config: any;
5
5
  applicationId: any;
6
+ /**
7
+ * @param {Object} arg - Arg object.
8
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
9
+ * detail. Pass the `id` of the keywords which you want to retrieve.
10
+ * @returns {Promise<GetSearchWordsDetailResponse>} - Success response
11
+ * @summary: Get a Search Keywords Details
12
+ * @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`
13
+ */
14
+ getSearchKeywords({ id }?: {
15
+ id: string;
16
+ }): Promise<GetSearchWordsDetailResponse>;
6
17
  /**
7
18
  * @param {Object} arg - Arg object.
8
19
  * @param {string} arg.id - A `id` is a unique identifier for a particular
9
20
  * detail. Pass the `id` of the keywords which you want to delete.
10
21
  * @param {CreateSearchKeyword} arg.body
22
+ * @returns {Promise<GetSearchWordsData>} - Success response
11
23
  * @summary: Update Search Keyword
12
24
  * @description: Update Search Keyword by its id. On successful request, returns the updated collection
13
25
  */
14
26
  updateSearchKeywords({ id, body }?: {
15
27
  id: string;
16
28
  body: CreateSearchKeyword;
17
- }): Promise<any>;
18
- /**
19
- * @param {Object} arg - Arg object.
20
- * @param {string} arg.id - A `id` is a unique identifier for a particular
21
- * detail. Pass the `id` of the keywords which you want to retrieve.
22
- * @summary: Get a Search Keywords Details
23
- * @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`
24
- */
25
- getSearchKeywords({ id }?: {
26
- id: string;
27
- }): Promise<any>;
29
+ }): Promise<GetSearchWordsData>;
28
30
  /**
29
31
  * @param {Object} arg - Arg object.
30
32
  * @param {string} arg.id - A `id` is a unique identifier for a particular
31
33
  * detail. Pass the `id` of the keywords which you want to delete.
34
+ * @returns {Promise<DeleteResponse>} - Success response
32
35
  * @summary: Delete a Search Keywords
33
36
  * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
34
37
  */
35
38
  deleteSearchKeywords({ id }?: {
36
39
  id: string;
37
- }): Promise<any>;
38
- /**
39
- * @param {Object} arg - Arg object.
40
- * @summary: List all Search Custom Keyword Listing
41
- * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
42
- */
43
- getAllSearchKeyword({}?: any): Promise<any>;
40
+ }): Promise<DeleteResponse>;
44
41
  /**
45
42
  * @param {Object} arg - Arg object.
46
43
  * @param {CreateSearchKeyword} arg.body
44
+ * @returns {Promise<GetSearchWordsData>} - Success response
47
45
  * @summary: Add a Custom Search Keywords
48
46
  * @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`
49
47
  */
50
48
  createCustomKeyword({ body }?: {
51
49
  body: CreateSearchKeyword;
52
- }): Promise<any>;
50
+ }): Promise<GetSearchWordsData>;
53
51
  /**
54
52
  * @param {Object} arg - Arg object.
55
- * @param {string} arg.id - A `id` is a unique identifier for a particular
56
- * detail. Pass the `id` of the keywords which you want to delete.
57
- * @param {CreateAutocompleteKeyword} arg.body
58
- * @summary: Create & Update Autocomplete Keyword
59
- * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
53
+ * @returns {Promise<GetSearchWordsResponse>} - Success response
54
+ * @summary: List all Search Custom Keyword Listing
55
+ * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
60
56
  */
61
- updateAutocompleteKeyword({ id, body }?: {
62
- id: string;
63
- body: CreateAutocompleteKeyword;
64
- }): Promise<any>;
57
+ getAllSearchKeyword({}?: any): Promise<GetSearchWordsResponse>;
65
58
  /**
66
59
  * @param {Object} arg - Arg object.
67
60
  * @param {string} arg.id - A `id` is a unique identifier for a particular
68
61
  * detail. Pass the `id` of the keywords which you want to retrieve.
62
+ * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
69
63
  * @summary: Get a Autocomplete Keywords Details
70
64
  * @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`
71
65
  */
72
66
  getAutocompleteKeywordDetail({ id }?: {
73
67
  id: string;
74
- }): Promise<any>;
68
+ }): Promise<GetAutocompleteWordsResponse>;
75
69
  /**
76
70
  * @param {Object} arg - Arg object.
77
71
  * @param {string} arg.id - A `id` is a unique identifier for a particular
78
72
  * detail. Pass the `id` of the keywords which you want to delete.
79
- * @summary: Delete a Autocomplete Keywords
80
- * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
73
+ * @param {CreateAutocompleteKeyword} arg.body
74
+ * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
75
+ * @summary: Create & Update Autocomplete Keyword
76
+ * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
81
77
  */
82
- deleteAutocompleteKeyword({ id }?: {
78
+ updateAutocompleteKeyword({ id, body }?: {
83
79
  id: string;
84
- }): Promise<any>;
80
+ body: CreateAutocompleteKeyword;
81
+ }): Promise<GetAutocompleteWordsResponse>;
85
82
  /**
86
83
  * @param {Object} arg - Arg object.
87
- * @summary: List all Autocomplete Keyword Listing
88
- * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
84
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
85
+ * detail. Pass the `id` of the keywords which you want to delete.
86
+ * @returns {Promise<DeleteResponse>} - Success response
87
+ * @summary: Delete a Autocomplete Keywords
88
+ * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
89
89
  */
90
- getAutocompleteConfig({}?: any): Promise<any>;
90
+ deleteAutocompleteKeyword({ id }?: {
91
+ id: string;
92
+ }): Promise<DeleteResponse>;
91
93
  /**
92
94
  * @param {Object} arg - Arg object.
93
95
  * @param {CreateAutocompleteKeyword} arg.body
96
+ * @returns {Promise<CreateAutocompleteWordsResponse>} - Success response
94
97
  * @summary: Add a Custom Autocomplete Keywords
95
98
  * @description: Create a Custom Autocomplete Keywords. See `CreateAutocompleteKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateAutocompleteKeywordSchema`
96
99
  */
97
100
  createCustomAutocompleteRule({ body }?: {
98
101
  body: CreateAutocompleteKeyword;
99
- }): Promise<any>;
102
+ }): Promise<CreateAutocompleteWordsResponse>;
100
103
  /**
101
104
  * @param {Object} arg - Arg object.
102
- * @param {string} arg.itemId - Product id for which the custom_meta is associated.
103
- * @param {ApplicationItemMeta} arg.body
104
- * @summary: Update a single custom meta.
105
- * @description: This API helps to update data associated to a item custom meta.
105
+ * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
106
+ * @summary: List all Autocomplete Keyword Listing
107
+ * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
106
108
  */
107
- updateAppProduct({ itemId, body }?: {
108
- itemId: string;
109
- body: ApplicationItemMeta;
110
- }): Promise<any>;
109
+ getAutocompleteConfig({}?: any): Promise<GetAutocompleteWordsResponse>;
111
110
  /**
112
111
  * @param {Object} arg - Arg object.
113
112
  * @param {string} arg.itemId - Product id for a particular product.
113
+ * @returns {Promise<OwnerAppItemResponse>} - Success response
114
114
  * @summary: Get company application product data.
115
115
  * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
116
116
  */
117
117
  getAppProduct({ itemId }?: {
118
118
  itemId: string;
119
- }): Promise<any>;
119
+ }): Promise<OwnerAppItemResponse>;
120
+ /**
121
+ * @param {Object} arg - Arg object.
122
+ * @param {string} arg.itemId - Product id for which the custom_meta is associated.
123
+ * @param {ApplicationItemMeta} arg.body
124
+ * @returns {Promise<SuccessResponse1>} - Success response
125
+ * @summary: Update a single custom meta.
126
+ * @description: This API helps to update data associated to a item custom meta.
127
+ */
128
+ updateAppProduct({ itemId, body }?: {
129
+ itemId: string;
130
+ body: ApplicationItemMeta;
131
+ }): Promise<SuccessResponse1>;
120
132
  /**
121
133
  * @param {Object} arg - Arg object.
122
134
  * @param {string} arg.configType - A `config_type` is an identifier that
123
135
  * defines a specific type of configuration.
124
136
  * @param {string} [arg.templateSlug] - Get configuration list filtered by
125
137
  * `template_slug` string. This is for the details and comparision groups.
138
+ * @returns {Promise<GetConfigMetadataResponse>} - Success response
126
139
  * @summary: Get configuration metadata details for catalog for admin panel
127
140
  * @description: Get the configuraion metadata details for catalog.
128
141
  */
129
142
  getConfigurationMetadata({ configType, templateSlug }?: {
130
143
  configType: string;
131
144
  templateSlug?: string;
132
- }): Promise<any>;
145
+ }): Promise<GetConfigMetadataResponse>;
146
+ /**
147
+ * @param {Object} arg - Arg object.
148
+ * @param {string} arg.configType - A `config_type` is a unique identifier
149
+ * for a particular group configuration type.
150
+ * @param {AppConfigurationDetail} arg.body
151
+ * @returns {Promise<AppConfigurationDetail>} - Success response
152
+ * @summary: Create configuration for Group config types.
153
+ * @description: Create configuration for Group config types.
154
+ */
155
+ createGroupConfiguration({ configType, body }?: {
156
+ configType: string;
157
+ body: AppConfigurationDetail;
158
+ }): Promise<AppConfigurationDetail>;
133
159
  /**
134
160
  * @param {Object} arg - Arg object.
135
161
  * @param {string} arg.configType - A `config_type` is an identifier that
@@ -141,6 +167,7 @@ declare class Catalog {
141
167
  * @param {string} [arg.search] - Get configuration list filtered by `search` string.
142
168
  * @param {string} [arg.templateSlug] - Get configuration list filtered by
143
169
  * `template_slug` string. This is for the details and comparision groups.
170
+ * @returns {Promise<GetConfigResponse>} - Success response
144
171
  * @summary: Get the details of the application configured configurations of group config types.
145
172
  * @description: Get the details of the application configured configurations of group config types.
146
173
  */
@@ -150,19 +177,7 @@ declare class Catalog {
150
177
  pageSize?: number;
151
178
  search?: string;
152
179
  templateSlug?: string;
153
- }): Promise<any>;
154
- /**
155
- * @param {Object} arg - Arg object.
156
- * @param {string} arg.configType - A `config_type` is a unique identifier
157
- * for a particular group configuration type.
158
- * @param {AppConfigurationDetail} arg.body
159
- * @summary: Create configuration for Group config types.
160
- * @description: Create configuration for Group config types.
161
- */
162
- createGroupConfiguration({ configType, body }?: {
163
- configType: string;
164
- body: AppConfigurationDetail;
165
- }): Promise<any>;
180
+ }): Promise<GetConfigResponse>;
166
181
  /**
167
182
  * @param {Object} arg - Arg object.
168
183
  * @param {string} arg.configType - A `config_type` is a unique identifier
@@ -170,6 +185,7 @@ declare class Catalog {
170
185
  * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
171
186
  * a particular configuration.
172
187
  * @param {AppConfigurationDetail} arg.body
188
+ * @returns {Promise<AppConfigurationDetail>} - Success response
173
189
  * @summary: Update the group configurations for the application.
174
190
  * @description: Update the group configurations for the application.
175
191
  */
@@ -177,20 +193,34 @@ declare class Catalog {
177
193
  configType: string;
178
194
  groupSlug: string;
179
195
  body: AppConfigurationDetail;
180
- }): Promise<any>;
196
+ }): Promise<AppConfigurationDetail>;
181
197
  /**
182
198
  * @param {Object} arg - Arg object.
183
199
  * @param {string} arg.configType - A `config_type` is a unique identifier
184
200
  * for a particular group configuration type.
185
201
  * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
186
202
  * a particular configuration.
203
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
187
204
  * @summary: Delete configuration of the product config type of the application.
188
205
  * @description: Delete configuration of the product config type of the application.
189
206
  */
190
207
  deleteGroupConfiguration({ configType, groupSlug }?: {
191
208
  configType: string;
192
209
  groupSlug: string;
193
- }): Promise<any>;
210
+ }): Promise<ConfigSuccessResponse>;
211
+ /**
212
+ * @param {Object} arg - Arg object.
213
+ * @param {string} arg.configType - A `config_type` is a unique identifier
214
+ * for a particular listing configuration type.
215
+ * @param {AppConfigurationsSort} arg.body
216
+ * @returns {Promise<AppConfigurationsSort>} - Success response
217
+ * @summary: Add configuration for listings
218
+ * @description: Add configuration for listing.
219
+ */
220
+ createListingConfiguration({ configType, body }?: {
221
+ configType: string;
222
+ body: AppConfigurationsSort;
223
+ }): Promise<AppConfigurationsSort>;
194
224
  /**
195
225
  * @param {Object} arg - Arg object.
196
226
  * @param {string} arg.configType - A `config_type` is an identifier that
@@ -200,27 +230,16 @@ declare class Catalog {
200
230
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
201
231
  * page. Default is 12.
202
232
  * @param {string} [arg.search] - Get configuration list filtered by `search` string.
233
+ * @returns {Promise<GetConfigResponse>} - Success response
203
234
  * @summary: Get the details of the application configured configurations of listing config types.
204
235
  * @description: Get the details of the application configured configurations of listing config types.
205
236
  */
206
- getListingConfigurations({ configType, pageNo, pageSize, search }?: {
237
+ getListingConfigurations({ configType, pageNo, pageSize, search, }?: {
207
238
  configType: string;
208
239
  pageNo?: number;
209
240
  pageSize?: number;
210
241
  search?: string;
211
- }): Promise<any>;
212
- /**
213
- * @param {Object} arg - Arg object.
214
- * @param {string} arg.configType - A `config_type` is a unique identifier
215
- * for a particular listing configuration type.
216
- * @param {AppConfigurationsSort} arg.body
217
- * @summary: Add configuration for listings
218
- * @description: Add configuration for listing.
219
- */
220
- createListingConfiguration({ configType, body }?: {
221
- configType: string;
222
- body: AppConfigurationsSort;
223
- }): Promise<any>;
242
+ }): Promise<GetConfigResponse>;
224
243
  /**
225
244
  * @param {Object} arg - Arg object.
226
245
  * @param {string} arg.configType - A `config_type` is a unique identifier
@@ -228,6 +247,7 @@ declare class Catalog {
228
247
  * @param {string} arg.configId - A `config_id` is a unique identifier of a
229
248
  * particular configuration.
230
249
  * @param {AppConfigurationsSort} arg.body
250
+ * @returns {Promise<AppConfigurationsSort>} - Success response
231
251
  * @summary: Update configuration for listings
232
252
  * @description: Update configuration for listing.
233
253
  */
@@ -235,85 +255,104 @@ declare class Catalog {
235
255
  configType: string;
236
256
  configId: string;
237
257
  body: AppConfigurationsSort;
238
- }): Promise<any>;
258
+ }): Promise<AppConfigurationsSort>;
239
259
  /**
240
260
  * @param {Object} arg - Arg object.
241
261
  * @param {string} arg.configType - A `config_type` is a unique identifier
242
262
  * for a particular listing configuration type.
243
263
  * @param {string} arg.configId - A `config_id` is a unique identifier of a
244
264
  * particular configuration.
265
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
245
266
  * @summary: Delete configuration for listings
246
267
  * @description: Delete configuration for listing.
247
268
  */
248
269
  deleteListingConfiguration({ configType, configId }?: {
249
270
  configType: string;
250
271
  configId: string;
251
- }): Promise<any>;
272
+ }): Promise<ConfigSuccessResponse>;
252
273
  /**
253
274
  * @param {Object} arg - Arg object.
254
275
  * @param {AllowSingleRequest} arg.body
276
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
255
277
  * @summary: Update allow single flag for filters of the application.
256
278
  * @description: Update allow single flag for filters of the application.
257
279
  */
258
280
  updateAllowSingle({ body }?: {
259
281
  body: AllowSingleRequest;
260
- }): Promise<any>;
282
+ }): Promise<ConfigSuccessResponse>;
261
283
  /**
262
284
  * @param {Object} arg - Arg object.
263
285
  * @param {DefaultKeyRequest} arg.body
286
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
264
287
  * @summary: Update the default sort key configuration for the application.
265
288
  * @description: Update the default sort key configuration for the application.
266
289
  */
267
290
  updateDefaultSort({ body }?: {
268
291
  body: DefaultKeyRequest;
269
- }): Promise<any>;
292
+ }): Promise<ConfigSuccessResponse>;
270
293
  /**
271
294
  * @param {Object} arg - Arg object.
295
+ * @returns {Promise<GetCatalogConfigurationMetaData>} - Success response
272
296
  * @summary: Get configuration meta details for catalog for admin panel
273
297
  * @description: configuration meta details for catalog.
274
298
  */
275
- getCatalogConfiguration({}?: any): Promise<any>;
276
- /**
277
- * @param {Object} arg - Arg object.
278
- * @summary: Get configured details for catalog
279
- * @description: configured details for catalog.
280
- */
281
- getConfigurations({}?: any): Promise<any>;
299
+ getCatalogConfiguration({}?: any): Promise<GetCatalogConfigurationMetaData>;
282
300
  /**
283
301
  * @param {Object} arg - Arg object.
284
302
  * @param {AppConfiguration} arg.body
303
+ * @returns {Promise<GetAppCatalogConfiguration>} - Success response
285
304
  * @summary: Add configuration for products & listings
286
305
  * @description: Add configuration for products & listing.
287
306
  */
288
307
  createConfigurationProductListing({ body }?: {
289
308
  body: AppConfiguration;
290
- }): Promise<any>;
309
+ }): Promise<GetAppCatalogConfiguration>;
291
310
  /**
292
311
  * @param {Object} arg - Arg object.
293
- * @param {string} arg.type - Type can be brands, categories etc.
312
+ * @returns {Promise<GetAppCatalogConfiguration>} - Success response
294
313
  * @summary: Get configured details for catalog
295
314
  * @description: configured details for catalog.
296
315
  */
297
- getConfigurationByType({ type }?: {
298
- type: string;
299
- }): Promise<any>;
316
+ getConfigurations({}?: any): Promise<GetAppCatalogConfiguration>;
300
317
  /**
301
318
  * @param {Object} arg - Arg object.
302
319
  * @param {string} arg.type - Type can be brands, categories etc.
303
320
  * @param {AppConfiguration} arg.body
321
+ * @returns {Promise<GetAppCatalogConfiguration>} - Success response
304
322
  * @summary: Add configuration for categories and brands
305
323
  * @description: Add configuration for categories & brands.
306
324
  */
307
325
  createConfigurationByType({ type, body }?: {
308
326
  type: string;
309
327
  body: AppConfiguration;
310
- }): Promise<any>;
328
+ }): Promise<GetAppCatalogConfiguration>;
311
329
  /**
312
330
  * @param {Object} arg - Arg object.
331
+ * @param {string} arg.type - Type can be brands, categories etc.
332
+ * @returns {Promise<GetAppCatalogEntityConfiguration>} - Success response
333
+ * @summary: Get configured details for catalog
334
+ * @description: configured details for catalog.
335
+ */
336
+ getConfigurationByType({ type }?: {
337
+ type: string;
338
+ }): Promise<GetAppCatalogEntityConfiguration>;
339
+ /**
340
+ * @param {Object} arg - Arg object.
341
+ * @returns {Promise<GetCollectionQueryOptionResponse>} - Success response
313
342
  * @summary: Get query filters to configure a collection
314
343
  * @description: Get query filters to configure a collection
315
344
  */
316
- getQueryFilters({}?: any): Promise<any>;
345
+ getQueryFilters({}?: any): Promise<GetCollectionQueryOptionResponse>;
346
+ /**
347
+ * @param {Object} arg - Arg object.
348
+ * @param {CreateCollection} arg.body
349
+ * @returns {Promise<CollectionCreateResponse>} - Success response
350
+ * @summary: Add a Collection
351
+ * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
352
+ */
353
+ createCollection({ body }?: {
354
+ body: CreateCollection;
355
+ }): Promise<CollectionCreateResponse>;
317
356
  /**
318
357
  * @param {Object} arg - Arg object.
319
358
  * @param {string} [arg.q] - Get collection list filtered by q string,
@@ -327,6 +366,7 @@ declare class Catalog {
327
366
  * given set of results.
328
367
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
329
368
  * page. Default is 12.
369
+ * @returns {Promise<GetCollectionListingResponse>} - Success response
330
370
  * @summary: List all the collections
331
371
  * @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema`
332
372
  */
@@ -338,47 +378,53 @@ declare class Catalog {
338
378
  isActive?: boolean;
339
379
  pageNo?: number;
340
380
  pageSize?: number;
341
- }): Promise<any>;
342
- /**
343
- * @param {Object} arg - Arg object.
344
- * @param {CreateCollection} arg.body
345
- * @summary: Add a Collection
346
- * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
347
- */
348
- createCollection({ body }?: {
349
- body: CreateCollection;
350
- }): Promise<any>;
381
+ }): Promise<GetCollectionListingResponse>;
351
382
  /**
352
383
  * @param {Object} arg - Arg object.
353
384
  * @param {string} arg.slug - A `slug` is a human readable, URL friendly
354
385
  * unique identifier of an object. Pass the `slug` of the collection which
355
386
  * you want to retrieve.
387
+ * @returns {Promise<CollectionDetailResponse>} - Success response
356
388
  * @summary: Get a particular collection
357
389
  * @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`
358
390
  */
359
391
  getCollectionDetail({ slug }?: {
360
392
  slug: string;
361
- }): Promise<any>;
393
+ }): Promise<CollectionDetailResponse>;
362
394
  /**
363
395
  * @param {Object} arg - Arg object.
364
396
  * @param {string} arg.id - A `id` is a unique identifier of a collection.
365
397
  * @param {UpdateCollection} arg.body
398
+ * @returns {Promise<UpdateCollection>} - Success response
366
399
  * @summary: Update a collection
367
400
  * @description: Update a collection by it's id. On successful request, returns the updated collection
368
401
  */
369
402
  updateCollection({ id, body }?: {
370
403
  id: string;
371
404
  body: UpdateCollection;
372
- }): Promise<any>;
405
+ }): Promise<UpdateCollection>;
373
406
  /**
374
407
  * @param {Object} arg - Arg object.
375
408
  * @param {string} arg.id - A `id` is a unique identifier of a collection.
409
+ * @returns {Promise<DeleteResponse>} - Success response
376
410
  * @summary: Delete a Collection
377
411
  * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
378
412
  */
379
413
  deleteCollection({ id }?: {
380
414
  id: string;
381
- }): Promise<any>;
415
+ }): Promise<DeleteResponse>;
416
+ /**
417
+ * @param {Object} arg - Arg object.
418
+ * @param {string} arg.id - A `id` is a unique identifier of a collection.
419
+ * @param {CollectionItemUpdate} arg.body
420
+ * @returns {Promise<UpdatedResponse>} - Success response
421
+ * @summary: Add items to a collection
422
+ * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
423
+ */
424
+ addCollectionItems({ id, body }?: {
425
+ id: string;
426
+ body: CollectionItemUpdate;
427
+ }): Promise<UpdatedResponse>;
382
428
  /**
383
429
  * @param {Object} arg - Arg object.
384
430
  * @param {string} arg.id - A `id` is a unique identifier of a collection.
@@ -388,6 +434,7 @@ declare class Catalog {
388
434
  * which should be sent back to make pagination work.
389
435
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
390
436
  * page. Default is 12.
437
+ * @returns {Promise<GetCollectionItemsResponse>} - Success response
391
438
  * @summary: Get the items for a collection
392
439
  * @description: Get items from a collection specified by its `id`.
393
440
  */
@@ -396,27 +443,17 @@ declare class Catalog {
396
443
  sortOn?: string;
397
444
  pageId?: string;
398
445
  pageSize?: number;
399
- }): Promise<any>;
400
- /**
401
- * @param {Object} arg - Arg object.
402
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
403
- * @param {CollectionItemRequest} arg.body
404
- * @summary: Add items to a collection
405
- * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
406
- */
407
- addCollectionItems({ id, body }?: {
408
- id: string;
409
- body: CollectionItemRequest;
410
- }): Promise<any>;
446
+ }): Promise<GetCollectionItemsResponse>;
411
447
  /**
412
448
  * @param {Object} arg - Arg object.
413
449
  * @param {string} [arg.brand] - Brand slug
450
+ * @returns {Promise<CatalogInsightResponse>} - Success response
414
451
  * @summary: Analytics data of catalog and inventory.
415
452
  * @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app.
416
453
  */
417
454
  getCatalogInsights({ brand }?: {
418
455
  brand?: string;
419
- }): Promise<any>;
456
+ }): Promise<CatalogInsightResponse>;
420
457
  /**
421
458
  * @param {Object} arg - Arg object.
422
459
  * @param {number} arg.itemId - Item code of the product of which size is to be get.
@@ -428,6 +465,7 @@ declare class Catalog {
428
465
  * page. Default is 12.
429
466
  * @param {string} [arg.q] - Search with help of store code.
430
467
  * @param {number[]} [arg.locationIds] - Search by store ids.
468
+ * @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
431
469
  * @summary: Get Inventory for company
432
470
  * @description: This API allows get Inventory data for particular company grouped by size and store.
433
471
  */
@@ -438,7 +476,7 @@ declare class Catalog {
438
476
  pageSize?: number;
439
477
  q?: string;
440
478
  locationIds?: number[];
441
- }): Promise<any>;
479
+ }): Promise<InventorySellerIdentifierResponsePaginated>;
442
480
  /**
443
481
  * @param {Object} arg - Arg object.
444
482
  * @param {string} [arg.department] - The name of the department. Use this
@@ -453,16 +491,17 @@ declare class Catalog {
453
491
  * to search brands by brand name.
454
492
  * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
455
493
  * basis of uid list.
494
+ * @returns {Promise<BrandListingResponse>} - Success response
456
495
  * @summary: List all the brands
457
496
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
458
497
  */
459
- getApplicationBrands({ department, pageNo, pageSize, q, brandId }?: {
498
+ getApplicationBrands({ department, pageNo, pageSize, q, brandId, }?: {
460
499
  department?: string;
461
500
  pageNo?: number;
462
501
  pageSize?: number;
463
502
  q?: string;
464
503
  brandId?: number[];
465
- }): Promise<any>;
504
+ }): Promise<BrandListingResponse>;
466
505
  /**
467
506
  * @param {Object} arg - Arg object.
468
507
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -492,22 +531,24 @@ declare class Catalog {
492
531
  }): Paginator;
493
532
  /**
494
533
  * @param {Object} arg - Arg object.
534
+ * @returns {Promise<DepartmentResponse>} - Success response
495
535
  * @summary: List all the departments
496
536
  * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
497
537
  */
498
- getDepartments({}?: any): Promise<any>;
538
+ getDepartments({}?: any): Promise<DepartmentResponse>;
499
539
  /**
500
540
  * @param {Object} arg - Arg object.
501
541
  * @param {string} [arg.department] - The name of the department. Use this
502
542
  * parameter to filter products by a particular department. See below the
503
543
  * list of available departments. You can retrieve available departments
504
544
  * from the **v1.0/departments/** API
545
+ * @returns {Promise<CategoryListingResponse>} - Success response
505
546
  * @summary: List all the categories
506
547
  * @description: List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse`
507
548
  */
508
549
  getCategories({ department }?: {
509
550
  department?: string;
510
- }): Promise<any>;
551
+ }): Promise<CategoryListingResponse>;
511
552
  /**
512
553
  * @param {Object} arg - Arg object.
513
554
  * @param {string} [arg.q] - The search query. This can be a partial or
@@ -534,6 +575,7 @@ declare class Catalog {
534
575
  * @param {string} [arg.pageType] - For pagination type should be cursor or
535
576
  * number. Default is cursor.
536
577
  * @param {number[]} [arg.itemIds] - Item Ids of product
578
+ * @returns {Promise<ApplicationProductListingResponse>} - Success response
537
579
  * @summary: List the products
538
580
  * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
539
581
  */
@@ -548,7 +590,7 @@ declare class Catalog {
548
590
  pageNo?: number;
549
591
  pageType?: string;
550
592
  itemIds?: number[];
551
- }): Promise<any>;
593
+ }): Promise<ApplicationProductListingResponse>;
552
594
  /**
553
595
  * @param {Object} arg - Arg object.
554
596
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -592,12 +634,13 @@ declare class Catalog {
592
634
  * @param {string} arg.slug - The unique identifier of a product. i.e;
593
635
  * `slug` of a product. You can retrieve these from the APIs that list
594
636
  * products like **v1.0/products/**
637
+ * @returns {Promise<ProductDetail>} - Success response
595
638
  * @summary: Get a product
596
639
  * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail`
597
640
  */
598
641
  getProductDetailBySlug({ slug }?: {
599
642
  slug: string;
600
- }): Promise<any>;
643
+ }): Promise<ProductDetail>;
601
644
  /**
602
645
  * @param {Object} arg - Arg object.
603
646
  * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
@@ -611,6 +654,7 @@ declare class Catalog {
611
654
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
612
655
  * page. Default is 10.
613
656
  * @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
657
+ * @returns {Promise<ProductListingResponse>} - Success response
614
658
  * @summary: Get applicationwise products
615
659
  * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`
616
660
  */
@@ -622,7 +666,7 @@ declare class Catalog {
622
666
  pageNo?: number;
623
667
  pageSize?: number;
624
668
  q?: string;
625
- }): Promise<any>;
669
+ }): Promise<ProductListingResponse>;
626
670
  /**
627
671
  * @param {Object} arg - Arg object.
628
672
  * @param {number[]} [arg.itemIds] - The Item Id of the product.
@@ -633,6 +677,7 @@ declare class Catalog {
633
677
  * @param {string} [arg.timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
634
678
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
635
679
  * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
680
+ * @returns {Promise<InventoryStockResponse>} - Success response
636
681
  * @summary: Get the stock of a product
637
682
  * @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination
638
683
  */
@@ -644,7 +689,7 @@ declare class Catalog {
644
689
  timestamp?: string;
645
690
  pageSize?: number;
646
691
  pageId?: string;
647
- }): Promise<any>;
692
+ }): Promise<InventoryStockResponse>;
648
693
  /**
649
694
  * @param {Object} arg - Arg object.
650
695
  * @param {string} [arg.storeType] - Helps to sort the location list on the
@@ -658,6 +703,7 @@ declare class Catalog {
658
703
  * given set of results
659
704
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
660
705
  * page. Default is 20.
706
+ * @returns {Promise<LocationListSerializer>} - Success response
661
707
  * @summary: Get list of locations
662
708
  * @description: This API allows to view all the locations asscoiated to a application.
663
709
  */
@@ -668,7 +714,7 @@ declare class Catalog {
668
714
  stage?: string;
669
715
  pageNo?: number;
670
716
  pageSize?: number;
671
- }): Promise<any>;
717
+ }): Promise<LocationListSerializer>;
672
718
  /**
673
719
  * @param {Object} arg - Arg object.
674
720
  * @param {string} arg.companyId - Id of the company whose locations are to fetched
@@ -703,6 +749,7 @@ declare class Catalog {
703
749
  * page. Default is 12.
704
750
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
705
751
  * to search brands by brand name.
752
+ * @returns {Promise<BrandListingResponse>} - Success response
706
753
  * @summary: List all the brands for the application
707
754
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
708
755
  */
@@ -710,7 +757,7 @@ declare class Catalog {
710
757
  pageNo?: number;
711
758
  pageSize?: number;
712
759
  q?: string;
713
- }): Promise<any>;
760
+ }): Promise<BrandListingResponse>;
714
761
  /**
715
762
  * @param {Object} arg - Arg object.
716
763
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -734,13 +781,14 @@ declare class Catalog {
734
781
  * @param {Object} arg - Arg object.
735
782
  * @param {string} arg.brandUid - Brand id for which the custom_json is associated.
736
783
  * @param {ApplicationBrandJson} arg.body
784
+ * @returns {Promise<SuccessResponse1>} - Success response
737
785
  * @summary: Update a single custom json.
738
786
  * @description: This API helps to update data associated to a item custom meta.
739
787
  */
740
788
  updateAppBrand({ brandUid, body }?: {
741
789
  brandUid: string;
742
790
  body: ApplicationBrandJson;
743
- }): Promise<any>;
791
+ }): Promise<SuccessResponse1>;
744
792
  /**
745
793
  * @param {Object} arg - Arg object.
746
794
  * @param {number} [arg.departmentId] - A `department_id` is a unique
@@ -751,15 +799,16 @@ declare class Catalog {
751
799
  * page. Default is 12.
752
800
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
753
801
  * to search brands by brand name.
802
+ * @returns {Promise<BrandListingResponse>} - Success response
754
803
  * @summary: List all the brands for the application
755
804
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
756
805
  */
757
- getApplicationCategoryListing({ departmentId, pageNo, pageSize, q }?: {
806
+ getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, }?: {
758
807
  departmentId?: number;
759
808
  pageNo?: number;
760
809
  pageSize?: number;
761
810
  q?: string;
762
- }): Promise<any>;
811
+ }): Promise<BrandListingResponse>;
763
812
  /**
764
813
  * @param {Object} arg - Arg object.
765
814
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -787,13 +836,14 @@ declare class Catalog {
787
836
  * @param {string} arg.categoryUid - Category id for which the custom_json
788
837
  * is associated.
789
838
  * @param {ApplicationCategoryJson} arg.body
839
+ * @returns {Promise<SuccessResponse1>} - Success response
790
840
  * @summary: Update a single custom json.
791
841
  * @description: This API helps to update data associated to a item custom meta.
792
842
  */
793
843
  updateAppCategory({ categoryUid, body }?: {
794
844
  categoryUid: string;
795
845
  body: ApplicationCategoryJson;
796
- }): Promise<any>;
846
+ }): Promise<SuccessResponse1>;
797
847
  /**
798
848
  * @param {Object} arg - Arg object.
799
849
  * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -802,6 +852,7 @@ declare class Catalog {
802
852
  * page. Default is 12.
803
853
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
804
854
  * to search department by name.
855
+ * @returns {Promise<ApplicationDepartmentListingResponse>} - Success response
805
856
  * @summary: List all the departments for the application
806
857
  * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
807
858
  */
@@ -809,7 +860,7 @@ declare class Catalog {
809
860
  pageNo?: number;
810
861
  pageSize?: number;
811
862
  q?: string;
812
- }): Promise<any>;
863
+ }): Promise<ApplicationDepartmentListingResponse>;
813
864
  /**
814
865
  * @param {Object} arg - Arg object.
815
866
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -834,23 +885,25 @@ declare class Catalog {
834
885
  * @param {string} arg.departmentUid - Department id for which the
835
886
  * custom_json is associated.
836
887
  * @param {ApplicationDepartmentJson} arg.body
888
+ * @returns {Promise<SuccessResponse1>} - Success response
837
889
  * @summary: Update a single custom json.
838
890
  * @description: This API helps to update data associated to a item custom meta.
839
891
  */
840
892
  updateAppDepartment({ departmentUid, body }?: {
841
893
  departmentUid: string;
842
894
  body: ApplicationDepartmentJson;
843
- }): Promise<any>;
895
+ }): Promise<SuccessResponse1>;
844
896
  /**
845
897
  * @param {Object} arg - Arg object.
846
898
  * @param {string} arg.storeUid - Store id for which the custom_json is associated.
847
899
  * @param {ApplicationStoreJson} arg.body
900
+ * @returns {Promise<SuccessResponse1>} - Success response
848
901
  * @summary: Update a single custom json.
849
902
  * @description: This API helps to update data associated to a item custom meta.
850
903
  */
851
904
  updateAppLocation({ storeUid, body }?: {
852
905
  storeUid: string;
853
906
  body: ApplicationStoreJson;
854
- }): Promise<any>;
907
+ }): Promise<SuccessResponse1>;
855
908
  }
856
909
  import Paginator = require("../../common/Paginator");