@algolia/client-analytics 5.9.0 → 5.10.0-beta.1

package/model/dailyNoClickRates.ts

@@ -1,23 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type DailyNoClickRates = {
-  /**
-   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
-   */
-  rate: number;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  count: number;
-
-  /**
-   * Number of times this search was returned as a result without any click.
-   */
-  noClickCount: number;
-
-  /**
-   * Date in the format YYYY-MM-DD.
-   */
-  date: string;
-};

package/model/dailyNoResultsRates.ts

@@ -1,23 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type DailyNoResultsRates = {
-  /**
-   * Date in the format YYYY-MM-DD.
-   */
-  date: string;
-
-  /**
-   * Number of searches without any results.
-   */
-  noResultCount: number;
-
-  /**
-   * Number of searches.
-   */
-  count: number;
-
-  /**
-   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
-   */
-  rate: number;
-};

package/model/dailyPurchaseRates.ts

@@ -1,23 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type DailyPurchaseRates = {
-  /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  rate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount: number;
-
-  /**
-   * Number of purchase events from this search.
-   */
-  purchaseCount: number;
-
-  /**
-   * Date in the format YYYY-MM-DD.
-   */
-  date: string;
-};

package/model/dailyRevenue.ts

@@ -1,15 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { CurrencyCode } from './currencyCode';
-
-export type DailyRevenue = {
-  /**
-   * Revenue associated with this search, broken-down by currencies.
-   */
-  currencies: { [key: string]: CurrencyCode };
-
-  /**
-   * Date in the format YYYY-MM-DD.
-   */
-  date: string;
-};

package/model/dailySearches.ts

@@ -1,13 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type DailySearches = {
-  /**
-   * Date in the format YYYY-MM-DD.
-   */
-  date: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-};

package/model/dailySearchesNoClicks.ts

@@ -1,18 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type DailySearchesNoClicks = {
-  /**
-   * Search query.
-   */
-  search: string;
-
-  /**
-   * Number of tracked searches.
-   */
-  count: number;
-
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-};

package/model/dailySearchesNoResults.ts

@@ -1,18 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type DailySearchesNoResults = {
-  /**
-   * Search query.
-   */
-  search: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-
-  /**
-   * Number of searches for this term with applied filters.
-   */
-  withFilterCount: number;
-};

package/model/dailyUsers.ts

@@ -1,13 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type DailyUsers = {
-  /**
-   * Date in the format YYYY-MM-DD.
-   */
-  date: string;
-
-  /**
-   * Number of unique users.
-   */
-  count: number;
-};

package/model/direction.ts

@@ -1,3 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type Direction = 'asc' | 'desc';

package/model/errorBase.ts

@@ -1,8 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-/**
- * Error.
- */
-export type ErrorBase = Record<string, any> & {
-  message?: string;
-};

package/model/getAddToCartRateResponse.ts

@@ -1,25 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyAddToCartRates } from './dailyAddToCartRates';
-
-export type GetAddToCartRateResponse = {
-  /**
-   * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  rate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount: number;
-
-  /**
-   * Number of add-to-cart events from this search.
-   */
-  addToCartCount: number;
-
-  /**
-   * Daily add-to-cart rates.
-   */
-  dates: Array<DailyAddToCartRates>;
-};

package/model/getAverageClickPositionResponse.ts

@@ -1,20 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyAverageClicks } from './dailyAverageClicks';
-
-export type GetAverageClickPositionResponse = {
-  /**
-   * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  average: number | null;
-
-  /**
-   * Number of clicks associated with this search.
-   */
-  clickCount: number;
-
-  /**
-   * Daily average click positions.
-   */
-  dates: Array<DailyAverageClicks>;
-};

package/model/getClickPositionsResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ClickPosition } from './clickPosition';
-
-export type GetClickPositionsResponse = {
-  /**
-   * List of positions in the search results and clicks associated with this search.
-   */
-  positions: Array<ClickPosition>;
-};

package/model/getClickThroughRateResponse.ts

@@ -1,25 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyClickThroughRates } from './dailyClickThroughRates';
-
-export type GetClickThroughRateResponse = {
-  /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  rate: number | null;
-
-  /**
-   * Number of clicks associated with this search.
-   */
-  clickCount: number;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount: number;
-
-  /**
-   * Daily click-through rates.
-   */
-  dates: Array<DailyClickThroughRates>;
-};

package/model/getConversionRateResponse.ts

@@ -1,25 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyConversionRates } from './dailyConversionRates';
-
-export type GetConversionRateResponse = {
-  /**
-   * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  rate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount: number;
-
-  /**
-   * Number of conversions from this search.
-   */
-  conversionCount: number;
-
-  /**
-   * Daily conversion rates.
-   */
-  dates: Array<DailyConversionRates>;
-};

package/model/getNoClickRateResponse.ts

@@ -1,25 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyNoClickRates } from './dailyNoClickRates';
-
-export type GetNoClickRateResponse = {
-  /**
-   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
-   */
-  rate: number;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  count: number;
-
-  /**
-   * Number of times this search was returned as a result without any click.
-   */
-  noClickCount: number;
-
-  /**
-   * Daily no click rates.
-   */
-  dates: Array<DailyNoClickRates>;
-};

package/model/getNoResultsRateResponse.ts

@@ -1,25 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyNoResultsRates } from './dailyNoResultsRates';
-
-export type GetNoResultsRateResponse = {
-  /**
-   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
-   */
-  rate: number;
-
-  /**
-   * Number of searches.
-   */
-  count: number;
-
-  /**
-   * Number of searches without any results.
-   */
-  noResultCount: number;
-
-  /**
-   * Daily no results rates.
-   */
-  dates: Array<DailyNoResultsRates>;
-};

package/model/getPurchaseRateResponse.ts

@@ -1,25 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyPurchaseRates } from './dailyPurchaseRates';
-
-export type GetPurchaseRateResponse = {
-  /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
-   */
-  rate: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount: number;
-
-  /**
-   * Number of purchase events from this search.
-   */
-  purchaseCount: number;
-
-  /**
-   * Daily purchase rates.
-   */
-  dates: Array<DailyPurchaseRates>;
-};

package/model/getRevenue.ts

@@ -1,16 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { CurrencyCode } from './currencyCode';
-import type { DailyRevenue } from './dailyRevenue';
-
-export type GetRevenue = {
-  /**
-   * Revenue associated with this search, broken-down by currencies.
-   */
-  currencies: { [key: string]: CurrencyCode };
-
-  /**
-   * Daily revenue.
-   */
-  dates: Array<DailyRevenue>;
-};

package/model/getSearchesCountResponse.ts

@@ -1,15 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailySearches } from './dailySearches';
-
-export type GetSearchesCountResponse = {
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-
-  /**
-   * Daily number of searches.
-   */
-  dates: Array<DailySearches>;
-};

package/model/getSearchesNoClicksResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailySearchesNoClicks } from './dailySearchesNoClicks';
-
-export type GetSearchesNoClicksResponse = {
-  /**
-   * Searches without any clicks.
-   */
-  searches: Array<DailySearchesNoClicks>;
-};

package/model/getSearchesNoResultsResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailySearchesNoResults } from './dailySearchesNoResults';
-
-export type GetSearchesNoResultsResponse = {
-  /**
-   * Searches without results.
-   */
-  searches: Array<DailySearchesNoResults>;
-};

package/model/getStatusResponse.ts

@@ -1,8 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type GetStatusResponse = {
-  /**
-   * Date and time when the object was updated, in RFC 3339 format.
-   */
-  updatedAt: string | null;
-};

package/model/getTopCountriesResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { TopCountry } from './topCountry';
-
-export type GetTopCountriesResponse = {
-  /**
-   * Countries and number of searches.
-   */
-  countries: Array<TopCountry>;
-};

package/model/getTopFilterAttribute.ts

@@ -1,13 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type GetTopFilterAttribute = {
-  /**
-   * Attribute name.
-   */
-  attribute: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-};

package/model/getTopFilterAttributesResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { GetTopFilterAttribute } from './getTopFilterAttribute';
-
-export type GetTopFilterAttributesResponse = {
-  /**
-   * Most frequent filters.
-   */
-  attributes: Array<GetTopFilterAttribute>;
-};

package/model/getTopFilterForAttribute.ts

@@ -1,22 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { Operator } from './operator';
-
-export type GetTopFilterForAttribute = {
-  /**
-   * Attribute name.
-   */
-  attribute: string;
-
-  operator: Operator;
-
-  /**
-   * Attribute value.
-   */
-  value: string;
-
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-};

package/model/getTopFilterForAttributeResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { GetTopFilterForAttribute } from './getTopFilterForAttribute';
-
-export type GetTopFilterForAttributeResponse = {
-  /**
-   * Filter values for an attribute.
-   */
-  values: Array<GetTopFilterForAttribute>;
-};

package/model/getTopFiltersNoResultsResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValues';
-
-export type GetTopFiltersNoResultsResponse = {
-  /**
-   * Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
-   */
-  values: Array<GetTopFiltersNoResultsValues> | null;
-};

package/model/getTopFiltersNoResultsValue.ts

@@ -1,17 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { Operator } from './operator';
-
-export type GetTopFiltersNoResultsValue = {
-  /**
-   * Attribute name.
-   */
-  attribute: string;
-
-  operator: Operator;
-
-  /**
-   * Attribute value.
-   */
-  value: string;
-};

package/model/getTopFiltersNoResultsValues.ts

@@ -1,15 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { GetTopFiltersNoResultsValue } from './getTopFiltersNoResultsValue';
-
-export type GetTopFiltersNoResultsValues = {
-  /**
-   * Number of occurrences.
-   */
-  count: number;
-
-  /**
-   * Filters with no results.
-   */
-  values: Array<GetTopFiltersNoResultsValue>;
-};

package/model/getTopHitsResponse.ts

@@ -1,7 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { TopHitsResponse } from './topHitsResponse';
-import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
-import type { TopHitsResponseWithRevenueAnalytics } from './topHitsResponseWithRevenueAnalytics';
-
-export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics | TopHitsResponseWithRevenueAnalytics;

package/model/getTopSearchesResponse.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { TopSearchesResponse } from './topSearchesResponse';
-import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
-import type { TopSearchesResponseWithRevenueAnalytics } from './topSearchesResponseWithRevenueAnalytics';
-
-export type GetTopSearchesResponse =
-  | TopSearchesResponse
-  | TopSearchesResponseWithAnalytics
-  | TopSearchesResponseWithRevenueAnalytics;

package/model/getUsersCountResponse.ts

@@ -1,15 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { DailyUsers } from './dailyUsers';
-
-export type GetUsersCountResponse = {
-  /**
-   * Number of unique users.
-   */
-  count: number;
-
-  /**
-   * Daily number of unique users.
-   */
-  dates: Array<DailyUsers>;
-};

package/model/index.ts

@@ -1,58 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export * from './clickPosition';
-export * from './clientMethodProps';
-export * from './currencyCode';
-export * from './dailyAddToCartRates';
-export * from './dailyAverageClicks';
-export * from './dailyClickThroughRates';
-export * from './dailyConversionRates';
-export * from './dailyNoClickRates';
-export * from './dailyNoResultsRates';
-export * from './dailyPurchaseRates';
-export * from './dailyRevenue';
-export * from './dailySearches';
-export * from './dailySearchesNoClicks';
-export * from './dailySearchesNoResults';
-export * from './dailyUsers';
-export * from './direction';
-export * from './errorBase';
-export * from './getAddToCartRateResponse';
-export * from './getAverageClickPositionResponse';
-export * from './getClickPositionsResponse';
-export * from './getClickThroughRateResponse';
-export * from './getConversionRateResponse';
-export * from './getNoClickRateResponse';
-export * from './getNoResultsRateResponse';
-export * from './getPurchaseRateResponse';
-export * from './getRevenue';
-export * from './getSearchesCountResponse';
-export * from './getSearchesNoClicksResponse';
-export * from './getSearchesNoResultsResponse';
-export * from './getStatusResponse';
-export * from './getTopCountriesResponse';
-export * from './getTopFilterAttribute';
-export * from './getTopFilterAttributesResponse';
-export * from './getTopFilterForAttribute';
-export * from './getTopFilterForAttributeResponse';
-export * from './getTopFiltersNoResultsResponse';
-export * from './getTopFiltersNoResultsValue';
-export * from './getTopFiltersNoResultsValues';
-export * from './getTopHitsResponse';
-export * from './getTopSearchesResponse';
-export * from './getUsersCountResponse';
-export * from './operator';
-export * from './orderBy';
-export * from './topCountry';
-export * from './topHit';
-export * from './topHitsResponse';
-export * from './topHitsResponseWithAnalytics';
-export * from './topHitsResponseWithRevenueAnalytics';
-export * from './topHitWithAnalytics';
-export * from './topHitWithRevenueAnalytics';
-export * from './topSearch';
-export * from './topSearchesResponse';
-export * from './topSearchesResponseWithAnalytics';
-export * from './topSearchesResponseWithRevenueAnalytics';
-export * from './topSearchWithAnalytics';
-export * from './topSearchWithRevenueAnalytics';

package/model/operator.ts

@@ -1,6 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-/**
- * Character that characterizes how the filter is applied.  For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
- */
-export type Operator = ':' | '<' | '<=' | '=' | '!=' | '>' | '>=';