@algolia/client-analytics 5.0.0-alpha.99 → 5.0.0-beta.10

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 (187) hide show
  1. package/LICENSE +21 -0
  2. package/dist/builds/browser.d.ts +37 -3
  3. package/dist/builds/browser.d.ts.map +1 -1
  4. package/dist/builds/node.d.ts +37 -3
  5. package/dist/builds/node.d.ts.map +1 -1
  6. package/dist/client-analytics.cjs +314 -153
  7. package/dist/client-analytics.esm.browser.js +309 -160
  8. package/dist/client-analytics.esm.node.js +314 -153
  9. package/dist/client-analytics.umd.js +2 -2
  10. package/dist/model/clickPositionsInner.d.ts +14 -0
  11. package/dist/model/clickPositionsInner.d.ts.map +1 -0
  12. package/dist/model/clientMethodProps.d.ts +161 -90
  13. package/dist/model/clientMethodProps.d.ts.map +1 -1
  14. package/dist/model/currenciesValue.d.ts +14 -0
  15. package/dist/model/currenciesValue.d.ts.map +1 -0
  16. package/dist/model/dailyAddToCartRates.d.ts +19 -0
  17. package/dist/model/dailyAddToCartRates.d.ts.map +1 -0
  18. package/dist/model/dailyAverageClicks.d.ts +15 -0
  19. package/dist/model/dailyAverageClicks.d.ts.map +1 -0
  20. package/dist/model/dailyClickThroughRates.d.ts +19 -0
  21. package/dist/model/dailyClickThroughRates.d.ts.map +1 -0
  22. package/dist/model/dailyConversionRates.d.ts +19 -0
  23. package/dist/model/dailyConversionRates.d.ts.map +1 -0
  24. package/dist/model/dailyNoClickRates.d.ts +19 -0
  25. package/dist/model/dailyNoClickRates.d.ts.map +1 -0
  26. package/dist/model/dailyNoResultsRates.d.ts +19 -0
  27. package/dist/model/dailyNoResultsRates.d.ts.map +1 -0
  28. package/dist/model/dailyPurchaseRates.d.ts +19 -0
  29. package/dist/model/dailyPurchaseRates.d.ts.map +1 -0
  30. package/dist/model/dailyRevenue.d.ts +12 -0
  31. package/dist/model/dailyRevenue.d.ts.map +1 -0
  32. package/dist/model/dailySearches.d.ts +11 -0
  33. package/dist/model/dailySearches.d.ts.map +1 -0
  34. package/dist/model/dailySearchesNoClicks.d.ts +15 -0
  35. package/dist/model/dailySearchesNoClicks.d.ts.map +1 -0
  36. package/dist/model/dailySearchesNoResults.d.ts +15 -0
  37. package/dist/model/dailySearchesNoResults.d.ts.map +1 -0
  38. package/dist/model/dailyUsers.d.ts +11 -0
  39. package/dist/model/dailyUsers.d.ts.map +1 -0
  40. package/dist/model/getAddToCartRateResponse.d.ts +20 -0
  41. package/dist/model/getAddToCartRateResponse.d.ts.map +1 -0
  42. package/dist/model/getAverageClickPositionResponse.d.ts +6 -6
  43. package/dist/model/getAverageClickPositionResponse.d.ts.map +1 -1
  44. package/dist/model/getClickPositionsResponse.d.ts +3 -3
  45. package/dist/model/getClickPositionsResponse.d.ts.map +1 -1
  46. package/dist/model/getClickThroughRateResponse.d.ts +7 -7
  47. package/dist/model/getClickThroughRateResponse.d.ts.map +1 -1
  48. package/dist/model/getConversionRateResponse.d.ts +20 -0
  49. package/dist/model/getConversionRateResponse.d.ts.map +1 -0
  50. package/dist/model/getNoClickRateResponse.d.ts +6 -6
  51. package/dist/model/getNoClickRateResponse.d.ts.map +1 -1
  52. package/dist/model/getNoResultsRateResponse.d.ts +6 -6
  53. package/dist/model/getNoResultsRateResponse.d.ts.map +1 -1
  54. package/dist/model/getPurchaseRateResponse.d.ts +20 -0
  55. package/dist/model/getPurchaseRateResponse.d.ts.map +1 -0
  56. package/dist/model/getRevenue.d.ts +13 -0
  57. package/dist/model/getRevenue.d.ts.map +1 -0
  58. package/dist/model/getSearchesCountResponse.d.ts +3 -3
  59. package/dist/model/getSearchesCountResponse.d.ts.map +1 -1
  60. package/dist/model/getSearchesNoClicksResponse.d.ts +3 -3
  61. package/dist/model/getSearchesNoClicksResponse.d.ts.map +1 -1
  62. package/dist/model/getSearchesNoResultsResponse.d.ts +3 -3
  63. package/dist/model/getSearchesNoResultsResponse.d.ts.map +1 -1
  64. package/dist/model/getStatusResponse.d.ts +2 -2
  65. package/dist/model/getStatusResponse.d.ts.map +1 -1
  66. package/dist/model/getTopCountriesResponse.d.ts +1 -1
  67. package/dist/model/getTopFilterAttributesResponse.d.ts +1 -1
  68. package/dist/model/getTopFilterForAttribute.d.ts +2 -4
  69. package/dist/model/getTopFilterForAttribute.d.ts.map +1 -1
  70. package/dist/model/getTopFiltersNoResultsResponse.d.ts +2 -2
  71. package/dist/model/getTopFiltersNoResultsResponse.d.ts.map +1 -1
  72. package/dist/model/getTopFiltersNoResultsValue.d.ts +2 -4
  73. package/dist/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
  74. package/dist/model/getTopHitsResponse.d.ts +2 -1
  75. package/dist/model/getTopHitsResponse.d.ts.map +1 -1
  76. package/dist/model/getTopSearchesResponse.d.ts +2 -1
  77. package/dist/model/getTopSearchesResponse.d.ts.map +1 -1
  78. package/dist/model/getUsersCountResponse.d.ts +4 -4
  79. package/dist/model/getUsersCountResponse.d.ts.map +1 -1
  80. package/dist/model/index.d.ts +23 -11
  81. package/dist/model/index.d.ts.map +1 -1
  82. package/dist/model/operator.d.ts +5 -0
  83. package/dist/model/operator.d.ts.map +1 -0
  84. package/dist/model/orderBy.d.ts +1 -1
  85. package/dist/model/topCountry.d.ts +1 -1
  86. package/dist/model/topHit.d.ts +1 -1
  87. package/dist/model/topHitWithAnalytics.d.ts +9 -9
  88. package/dist/model/topHitWithAnalytics.d.ts.map +1 -1
  89. package/dist/model/topHitWithRevenueAnalytics.d.ts +52 -0
  90. package/dist/model/topHitWithRevenueAnalytics.d.ts.map +1 -0
  91. package/dist/model/topHitsResponse.d.ts +1 -1
  92. package/dist/model/topHitsResponseWithAnalytics.d.ts +1 -1
  93. package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts +8 -0
  94. package/dist/model/topHitsResponseWithRevenueAnalytics.d.ts.map +1 -0
  95. package/dist/model/topSearch.d.ts +3 -3
  96. package/dist/model/topSearchWithAnalytics.d.ts +17 -12
  97. package/dist/model/topSearchWithAnalytics.d.ts.map +1 -1
  98. package/dist/model/topSearchWithRevenueAnalytics.d.ts +65 -0
  99. package/dist/model/topSearchWithRevenueAnalytics.d.ts.map +1 -0
  100. package/dist/model/topSearchesResponse.d.ts +1 -1
  101. package/dist/model/topSearchesResponseWithAnalytics.d.ts +1 -1
  102. package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts +8 -0
  103. package/dist/model/topSearchesResponseWithRevenueAnalytics.d.ts.map +1 -0
  104. package/dist/src/analyticsClient.d.ts +211 -138
  105. package/dist/src/analyticsClient.d.ts.map +1 -1
  106. package/model/clickPositionsInner.ts +16 -0
  107. package/model/clientMethodProps.ts +164 -90
  108. package/model/currenciesValue.ts +16 -0
  109. package/model/dailyAddToCartRates.ts +23 -0
  110. package/model/dailyAverageClicks.ts +18 -0
  111. package/model/dailyClickThroughRates.ts +23 -0
  112. package/model/dailyConversionRates.ts +23 -0
  113. package/model/dailyNoClickRates.ts +23 -0
  114. package/model/dailyNoResultsRates.ts +23 -0
  115. package/model/dailyPurchaseRates.ts +23 -0
  116. package/model/dailyRevenue.ts +15 -0
  117. package/model/{searchEvent.ts → dailySearches.ts} +2 -2
  118. package/model/{searchNoResultEvent.ts → dailySearchesNoClicks.ts} +4 -4
  119. package/model/{searchNoClickEvent.ts → dailySearchesNoResults.ts} +3 -3
  120. package/model/{userWithDate.ts → dailyUsers.ts} +3 -3
  121. package/model/getAddToCartRateResponse.ts +25 -0
  122. package/model/getAverageClickPositionResponse.ts +6 -6
  123. package/model/getClickPositionsResponse.ts +3 -3
  124. package/model/getClickThroughRateResponse.ts +7 -7
  125. package/model/getConversionRateResponse.ts +25 -0
  126. package/model/getNoClickRateResponse.ts +6 -6
  127. package/model/getNoResultsRateResponse.ts +6 -6
  128. package/model/getPurchaseRateResponse.ts +25 -0
  129. package/model/getRevenue.ts +16 -0
  130. package/model/getSearchesCountResponse.ts +3 -3
  131. package/model/getSearchesNoClicksResponse.ts +3 -3
  132. package/model/getSearchesNoResultsResponse.ts +3 -3
  133. package/model/getStatusResponse.ts +2 -2
  134. package/model/getTopCountriesResponse.ts +1 -1
  135. package/model/getTopFilterAttributesResponse.ts +1 -1
  136. package/model/getTopFilterForAttribute.ts +3 -4
  137. package/model/getTopFiltersNoResultsResponse.ts +2 -2
  138. package/model/getTopFiltersNoResultsValue.ts +3 -4
  139. package/model/getTopHitsResponse.ts +5 -1
  140. package/model/getTopSearchesResponse.ts +3 -1
  141. package/model/getUsersCountResponse.ts +4 -4
  142. package/model/index.ts +23 -11
  143. package/model/operator.ts +6 -0
  144. package/model/orderBy.ts +1 -1
  145. package/model/topCountry.ts +1 -1
  146. package/model/topHit.ts +1 -1
  147. package/model/topHitWithAnalytics.ts +9 -9
  148. package/model/topHitWithRevenueAnalytics.ts +65 -0
  149. package/model/topHitsResponse.ts +1 -1
  150. package/model/topHitsResponseWithAnalytics.ts +1 -1
  151. package/model/topHitsResponseWithRevenueAnalytics.ts +10 -0
  152. package/model/topSearch.ts +3 -3
  153. package/model/topSearchWithAnalytics.ts +19 -12
  154. package/model/topSearchWithRevenueAnalytics.ts +81 -0
  155. package/model/topSearchesResponse.ts +1 -1
  156. package/model/topSearchesResponseWithAnalytics.ts +1 -1
  157. package/model/topSearchesResponseWithRevenueAnalytics.ts +10 -0
  158. package/package.json +11 -8
  159. package/dist/model/averageClickEvent.d.ts +0 -15
  160. package/dist/model/averageClickEvent.d.ts.map +0 -1
  161. package/dist/model/clickPosition.d.ts +0 -11
  162. package/dist/model/clickPosition.d.ts.map +0 -1
  163. package/dist/model/clickThroughRateEvent.d.ts +0 -19
  164. package/dist/model/clickThroughRateEvent.d.ts.map +0 -1
  165. package/dist/model/conversionRateEvent.d.ts +0 -19
  166. package/dist/model/conversionRateEvent.d.ts.map +0 -1
  167. package/dist/model/getConversationRateResponse.d.ts +0 -20
  168. package/dist/model/getConversationRateResponse.d.ts.map +0 -1
  169. package/dist/model/noClickRateEvent.d.ts +0 -19
  170. package/dist/model/noClickRateEvent.d.ts.map +0 -1
  171. package/dist/model/noResultsRateEvent.d.ts +0 -19
  172. package/dist/model/noResultsRateEvent.d.ts.map +0 -1
  173. package/dist/model/searchEvent.d.ts +0 -11
  174. package/dist/model/searchEvent.d.ts.map +0 -1
  175. package/dist/model/searchNoClickEvent.d.ts +0 -15
  176. package/dist/model/searchNoClickEvent.d.ts.map +0 -1
  177. package/dist/model/searchNoResultEvent.d.ts +0 -15
  178. package/dist/model/searchNoResultEvent.d.ts.map +0 -1
  179. package/dist/model/userWithDate.d.ts +0 -11
  180. package/dist/model/userWithDate.d.ts.map +0 -1
  181. package/model/averageClickEvent.ts +0 -18
  182. package/model/clickPosition.ts +0 -13
  183. package/model/clickThroughRateEvent.ts +0 -23
  184. package/model/conversionRateEvent.ts +0 -23
  185. package/model/getConversationRateResponse.ts +0 -25
  186. package/model/noClickRateEvent.ts +0 -23
  187. package/model/noResultsRateEvent.ts +0 -23
@@ -60,24 +60,45 @@ export type CustomPutProps = {
60
60
  */
61
61
  body?: Record<string, any>;
62
62
  };
63
+ /**
64
+ * Properties for the `getAddToCartRate` method.
65
+ */
66
+ export type GetAddToCartRateProps = {
67
+ /**
68
+ * Index name.
69
+ */
70
+ index: string;
71
+ /**
72
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
73
+ */
74
+ startDate?: string;
75
+ /**
76
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
77
+ */
78
+ endDate?: string;
79
+ /**
80
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
81
+ */
82
+ tags?: string;
83
+ };
63
84
  /**
64
85
  * Properties for the `getAverageClickPosition` method.
65
86
  */
66
87
  export type GetAverageClickPositionProps = {
67
88
  /**
68
- * Index name to target.
89
+ * Index name.
69
90
  */
70
91
  index: string;
71
92
  /**
72
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
93
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
73
94
  */
74
95
  startDate?: string;
75
96
  /**
76
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
97
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
77
98
  */
78
99
  endDate?: string;
79
100
  /**
80
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
101
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
81
102
  */
82
103
  tags?: string;
83
104
  };
@@ -86,19 +107,19 @@ export type GetAverageClickPositionProps = {
86
107
  */
87
108
  export type GetClickPositionsProps = {
88
109
  /**
89
- * Index name to target.
110
+ * Index name.
90
111
  */
91
112
  index: string;
92
113
  /**
93
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
114
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
94
115
  */
95
116
  startDate?: string;
96
117
  /**
97
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
118
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
98
119
  */
99
120
  endDate?: string;
100
121
  /**
101
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
122
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
102
123
  */
103
124
  tags?: string;
104
125
  };
@@ -107,40 +128,40 @@ export type GetClickPositionsProps = {
107
128
  */
108
129
  export type GetClickThroughRateProps = {
109
130
  /**
110
- * Index name to target.
131
+ * Index name.
111
132
  */
112
133
  index: string;
113
134
  /**
114
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
135
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
115
136
  */
116
137
  startDate?: string;
117
138
  /**
118
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
139
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
119
140
  */
120
141
  endDate?: string;
121
142
  /**
122
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
143
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
123
144
  */
124
145
  tags?: string;
125
146
  };
126
147
  /**
127
- * Properties for the `getConversationRate` method.
148
+ * Properties for the `getConversionRate` method.
128
149
  */
129
- export type GetConversationRateProps = {
150
+ export type GetConversionRateProps = {
130
151
  /**
131
- * Index name to target.
152
+ * Index name.
132
153
  */
133
154
  index: string;
134
155
  /**
135
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
156
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
136
157
  */
137
158
  startDate?: string;
138
159
  /**
139
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
160
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
140
161
  */
141
162
  endDate?: string;
142
163
  /**
143
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
164
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
144
165
  */
145
166
  tags?: string;
146
167
  };
@@ -149,19 +170,19 @@ export type GetConversationRateProps = {
149
170
  */
150
171
  export type GetNoClickRateProps = {
151
172
  /**
152
- * Index name to target.
173
+ * Index name.
153
174
  */
154
175
  index: string;
155
176
  /**
156
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
177
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
157
178
  */
158
179
  startDate?: string;
159
180
  /**
160
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
181
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
161
182
  */
162
183
  endDate?: string;
163
184
  /**
164
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
185
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
165
186
  */
166
187
  tags?: string;
167
188
  };
@@ -170,19 +191,61 @@ export type GetNoClickRateProps = {
170
191
  */
171
192
  export type GetNoResultsRateProps = {
172
193
  /**
173
- * Index name to target.
194
+ * Index name.
174
195
  */
175
196
  index: string;
176
197
  /**
177
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
198
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
178
199
  */
179
200
  startDate?: string;
180
201
  /**
181
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
202
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
182
203
  */
183
204
  endDate?: string;
184
205
  /**
185
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
206
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
207
+ */
208
+ tags?: string;
209
+ };
210
+ /**
211
+ * Properties for the `getPurchaseRate` method.
212
+ */
213
+ export type GetPurchaseRateProps = {
214
+ /**
215
+ * Index name.
216
+ */
217
+ index: string;
218
+ /**
219
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
220
+ */
221
+ startDate?: string;
222
+ /**
223
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
224
+ */
225
+ endDate?: string;
226
+ /**
227
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
228
+ */
229
+ tags?: string;
230
+ };
231
+ /**
232
+ * Properties for the `getRevenue` method.
233
+ */
234
+ export type GetRevenueProps = {
235
+ /**
236
+ * Index name.
237
+ */
238
+ index: string;
239
+ /**
240
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
241
+ */
242
+ startDate?: string;
243
+ /**
244
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
245
+ */
246
+ endDate?: string;
247
+ /**
248
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
186
249
  */
187
250
  tags?: string;
188
251
  };
@@ -191,19 +254,19 @@ export type GetNoResultsRateProps = {
191
254
  */
192
255
  export type GetSearchesCountProps = {
193
256
  /**
194
- * Index name to target.
257
+ * Index name.
195
258
  */
196
259
  index: string;
197
260
  /**
198
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
261
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
199
262
  */
200
263
  startDate?: string;
201
264
  /**
202
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
265
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
203
266
  */
204
267
  endDate?: string;
205
268
  /**
206
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
269
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
207
270
  */
208
271
  tags?: string;
209
272
  };
@@ -212,27 +275,27 @@ export type GetSearchesCountProps = {
212
275
  */
213
276
  export type GetSearchesNoClicksProps = {
214
277
  /**
215
- * Index name to target.
278
+ * Index name.
216
279
  */
217
280
  index: string;
218
281
  /**
219
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
282
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
220
283
  */
221
284
  startDate?: string;
222
285
  /**
223
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
286
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
224
287
  */
225
288
  endDate?: string;
226
289
  /**
227
- * Number of records to return (page size).
290
+ * Number of items to return.
228
291
  */
229
292
  limit?: number;
230
293
  /**
231
- * Position of the starting record. Used for paging. 0 is the first record.
294
+ * Position of the first item to return.
232
295
  */
233
296
  offset?: number;
234
297
  /**
235
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
298
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
236
299
  */
237
300
  tags?: string;
238
301
  };
@@ -241,27 +304,27 @@ export type GetSearchesNoClicksProps = {
241
304
  */
242
305
  export type GetSearchesNoResultsProps = {
243
306
  /**
244
- * Index name to target.
307
+ * Index name.
245
308
  */
246
309
  index: string;
247
310
  /**
248
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
311
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
249
312
  */
250
313
  startDate?: string;
251
314
  /**
252
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
315
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
253
316
  */
254
317
  endDate?: string;
255
318
  /**
256
- * Number of records to return (page size).
319
+ * Number of items to return.
257
320
  */
258
321
  limit?: number;
259
322
  /**
260
- * Position of the starting record. Used for paging. 0 is the first record.
323
+ * Position of the first item to return.
261
324
  */
262
325
  offset?: number;
263
326
  /**
264
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
327
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
265
328
  */
266
329
  tags?: string;
267
330
  };
@@ -270,7 +333,7 @@ export type GetSearchesNoResultsProps = {
270
333
  */
271
334
  export type GetStatusProps = {
272
335
  /**
273
- * Index name to target.
336
+ * Index name.
274
337
  */
275
338
  index: string;
276
339
  };
@@ -279,27 +342,27 @@ export type GetStatusProps = {
279
342
  */
280
343
  export type GetTopCountriesProps = {
281
344
  /**
282
- * Index name to target.
345
+ * Index name.
283
346
  */
284
347
  index: string;
285
348
  /**
286
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
349
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
287
350
  */
288
351
  startDate?: string;
289
352
  /**
290
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
353
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
291
354
  */
292
355
  endDate?: string;
293
356
  /**
294
- * Number of records to return (page size).
357
+ * Number of items to return.
295
358
  */
296
359
  limit?: number;
297
360
  /**
298
- * Position of the starting record. Used for paging. 0 is the first record.
361
+ * Position of the first item to return.
299
362
  */
300
363
  offset?: number;
301
364
  /**
302
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
365
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
303
366
  */
304
367
  tags?: string;
305
368
  };
@@ -308,31 +371,31 @@ export type GetTopCountriesProps = {
308
371
  */
309
372
  export type GetTopFilterAttributesProps = {
310
373
  /**
311
- * Index name to target.
374
+ * Index name.
312
375
  */
313
376
  index: string;
314
377
  /**
315
- * User query.
378
+ * Search query.
316
379
  */
317
380
  search?: string;
318
381
  /**
319
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
382
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
320
383
  */
321
384
  startDate?: string;
322
385
  /**
323
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
386
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
324
387
  */
325
388
  endDate?: string;
326
389
  /**
327
- * Number of records to return (page size).
390
+ * Number of items to return.
328
391
  */
329
392
  limit?: number;
330
393
  /**
331
- * Position of the starting record. Used for paging. 0 is the first record.
394
+ * Position of the first item to return.
332
395
  */
333
396
  offset?: number;
334
397
  /**
335
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
398
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
336
399
  */
337
400
  tags?: string;
338
401
  };
@@ -345,31 +408,31 @@ export type GetTopFilterForAttributeProps = {
345
408
  */
346
409
  attribute: string;
347
410
  /**
348
- * Index name to target.
411
+ * Index name.
349
412
  */
350
413
  index: string;
351
414
  /**
352
- * User query.
415
+ * Search query.
353
416
  */
354
417
  search?: string;
355
418
  /**
356
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
419
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
357
420
  */
358
421
  startDate?: string;
359
422
  /**
360
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
423
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
361
424
  */
362
425
  endDate?: string;
363
426
  /**
364
- * Number of records to return (page size).
427
+ * Number of items to return.
365
428
  */
366
429
  limit?: number;
367
430
  /**
368
- * Position of the starting record. Used for paging. 0 is the first record.
431
+ * Position of the first item to return.
369
432
  */
370
433
  offset?: number;
371
434
  /**
372
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
435
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
373
436
  */
374
437
  tags?: string;
375
438
  };
@@ -378,31 +441,31 @@ export type GetTopFilterForAttributeProps = {
378
441
  */
379
442
  export type GetTopFiltersNoResultsProps = {
380
443
  /**
381
- * Index name to target.
444
+ * Index name.
382
445
  */
383
446
  index: string;
384
447
  /**
385
- * User query.
448
+ * Search query.
386
449
  */
387
450
  search?: string;
388
451
  /**
389
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
452
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
390
453
  */
391
454
  startDate?: string;
392
455
  /**
393
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
456
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
394
457
  */
395
458
  endDate?: string;
396
459
  /**
397
- * Number of records to return (page size).
460
+ * Number of items to return.
398
461
  */
399
462
  limit?: number;
400
463
  /**
401
- * Position of the starting record. Used for paging. 0 is the first record.
464
+ * Position of the first item to return.
402
465
  */
403
466
  offset?: number;
404
467
  /**
405
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
468
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
406
469
  */
407
470
  tags?: string;
408
471
  };
@@ -411,35 +474,39 @@ export type GetTopFiltersNoResultsProps = {
411
474
  */
412
475
  export type GetTopHitsProps = {
413
476
  /**
414
- * Index name to target.
477
+ * Index name.
415
478
  */
416
479
  index: string;
417
480
  /**
418
- * User query.
481
+ * Search query.
419
482
  */
420
483
  search?: string;
421
484
  /**
422
- * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
485
+ * Whether to include metrics related to click and conversion events in the response.
423
486
  */
424
487
  clickAnalytics?: boolean;
425
488
  /**
426
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
489
+ * Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
490
+ */
491
+ revenueAnalytics?: boolean;
492
+ /**
493
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
427
494
  */
428
495
  startDate?: string;
429
496
  /**
430
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
497
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
431
498
  */
432
499
  endDate?: string;
433
500
  /**
434
- * Number of records to return (page size).
501
+ * Number of items to return.
435
502
  */
436
503
  limit?: number;
437
504
  /**
438
- * Position of the starting record. Used for paging. 0 is the first record.
505
+ * Position of the first item to return.
439
506
  */
440
507
  offset?: number;
441
508
  /**
442
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
509
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
443
510
  */
444
511
  tags?: string;
445
512
  };
@@ -448,23 +515,27 @@ export type GetTopHitsProps = {
448
515
  */
449
516
  export type GetTopSearchesProps = {
450
517
  /**
451
- * Index name to target.
518
+ * Index name.
452
519
  */
453
520
  index: string;
454
521
  /**
455
- * Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
522
+ * Whether to include metrics related to click and conversion events in the response.
456
523
  */
457
524
  clickAnalytics?: boolean;
458
525
  /**
459
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
526
+ * Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
527
+ */
528
+ revenueAnalytics?: boolean;
529
+ /**
530
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
460
531
  */
461
532
  startDate?: string;
462
533
  /**
463
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
534
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
464
535
  */
465
536
  endDate?: string;
466
537
  /**
467
- * Reorder the results.
538
+ * Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
468
539
  */
469
540
  orderBy?: OrderBy;
470
541
  /**
@@ -472,15 +543,15 @@ export type GetTopSearchesProps = {
472
543
  */
473
544
  direction?: Direction;
474
545
  /**
475
- * Number of records to return (page size).
546
+ * Number of items to return.
476
547
  */
477
548
  limit?: number;
478
549
  /**
479
- * Position of the starting record. Used for paging. 0 is the first record.
550
+ * Position of the first item to return.
480
551
  */
481
552
  offset?: number;
482
553
  /**
483
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
554
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
484
555
  */
485
556
  tags?: string;
486
557
  };
@@ -489,19 +560,19 @@ export type GetTopSearchesProps = {
489
560
  */
490
561
  export type GetUsersCountProps = {
491
562
  /**
492
- * Index name to target.
563
+ * Index name.
493
564
  */
494
565
  index: string;
495
566
  /**
496
- * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
567
+ * Start date of the period to analyze, in `YYYY-MM-DD` format.
497
568
  */
498
569
  startDate?: string;
499
570
  /**
500
- * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
571
+ * End date of the period to analyze, in `YYYY-MM-DD` format.
501
572
  */
502
573
  endDate?: string;
503
574
  /**
504
- * Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
575
+ * Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
505
576
  */
506
577
  tags?: string;
507
578
  };
@@ -1 +1 @@
1
- {"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Currency code.
3
+ */
4
+ export type CurrenciesValue = {
5
+ /**
6
+ * Currency code.
7
+ */
8
+ currency?: string;
9
+ /**
10
+ * Revenue associated with this search in this currency.
11
+ */
12
+ revenue?: number;
13
+ };
14
+ //# sourceMappingURL=currenciesValue.d.ts.map