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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-Present Algolia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/builds/browser.d.ts

@@ -1,6 +1,40 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { AnalyticsClient, Region } from '../src/analyticsClient';
-export { apiClientVersion, AnalyticsClient, Region, } from '../src/analyticsClient';
+import type { Region } from '../src/analyticsClient';
+export { apiClientVersion, Region } from '../src/analyticsClient';
 export * from '../model';
-export declare function analyticsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): AnalyticsClient;
+/**
+ * The client type.
+ */
+export type AnalyticsClient = ReturnType<typeof analyticsClient>;
+export declare function analyticsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    readonly _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    getAddToCartRate({ index, startDate, endDate, tags }: import("../model").GetAddToCartRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetAddToCartRateResponse>;
+    getAverageClickPosition({ index, startDate, endDate, tags }: import("../model").GetAverageClickPositionProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetAverageClickPositionResponse>;
+    getClickPositions({ index, startDate, endDate, tags }: import("../model").GetClickPositionsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetClickPositionsResponse>;
+    getClickThroughRate({ index, startDate, endDate, tags }: import("../model").GetClickThroughRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetClickThroughRateResponse>;
+    getConversionRate({ index, startDate, endDate, tags }: import("../model").GetConversionRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetConversionRateResponse>;
+    getNoClickRate({ index, startDate, endDate, tags }: import("../model").GetNoClickRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetNoClickRateResponse>;
+    getNoResultsRate({ index, startDate, endDate, tags }: import("../model").GetNoResultsRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetNoResultsRateResponse>;
+    getPurchaseRate({ index, startDate, endDate, tags }: import("../model").GetPurchaseRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetPurchaseRateResponse>;
+    getRevenue({ index, startDate, endDate, tags }: import("../model").GetRevenueProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetRevenue>;
+    getSearchesCount({ index, startDate, endDate, tags }: import("../model").GetSearchesCountProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetSearchesCountResponse>;
+    getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags, }: import("../model").GetSearchesNoClicksProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetSearchesNoClicksResponse>;
+    getSearchesNoResults({ index, startDate, endDate, limit, offset, tags, }: import("../model").GetSearchesNoResultsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetSearchesNoResultsResponse>;
+    getStatus({ index }: import("../model").GetStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetStatusResponse>;
+    getTopCountries({ index, startDate, endDate, limit, offset, tags }: import("../model").GetTopCountriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopCountriesResponse>;
+    getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags, }: import("../model").GetTopFilterAttributesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopFilterAttributesResponse>;
+    getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags, }: import("../model").GetTopFilterForAttributeProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopFilterForAttributeResponse>;
+    getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags, }: import("../model").GetTopFiltersNoResultsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopFiltersNoResultsResponse>;
+    getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags, }: import("../model").GetTopHitsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopHitsResponse>;
+    getTopSearches({ index, clickAnalytics, revenueAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }: import("../model").GetTopSearchesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopSearchesResponse>;
+    getUsersCount({ index, startDate, endDate, tags }: import("../model").GetUsersCountProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetUsersCountResponse>;
+};
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAOtE,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,MAAM,GACP,MAAM,wBAAwB,CAAC;AAChC,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CAqCjB"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAOrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAClE,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsCxB"}

package/dist/builds/node.d.ts

@@ -1,6 +1,40 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { AnalyticsClient, Region } from '../src/analyticsClient';
-export { apiClientVersion, AnalyticsClient, Region, } from '../src/analyticsClient';
+import type { Region } from '../src/analyticsClient';
+export { apiClientVersion, Region } from '../src/analyticsClient';
 export * from '../model';
-export declare function analyticsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): AnalyticsClient;
+/**
+ * The client type.
+ */
+export type AnalyticsClient = ReturnType<typeof analyticsClient>;
+export declare function analyticsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    getAddToCartRate({ index, startDate, endDate, tags }: import("../model").GetAddToCartRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetAddToCartRateResponse>;
+    getAverageClickPosition({ index, startDate, endDate, tags }: import("../model").GetAverageClickPositionProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetAverageClickPositionResponse>;
+    getClickPositions({ index, startDate, endDate, tags }: import("../model").GetClickPositionsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetClickPositionsResponse>;
+    getClickThroughRate({ index, startDate, endDate, tags }: import("../model").GetClickThroughRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetClickThroughRateResponse>;
+    getConversionRate({ index, startDate, endDate, tags }: import("../model").GetConversionRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetConversionRateResponse>;
+    getNoClickRate({ index, startDate, endDate, tags }: import("../model").GetNoClickRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetNoClickRateResponse>;
+    getNoResultsRate({ index, startDate, endDate, tags }: import("../model").GetNoResultsRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetNoResultsRateResponse>;
+    getPurchaseRate({ index, startDate, endDate, tags }: import("../model").GetPurchaseRateProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetPurchaseRateResponse>;
+    getRevenue({ index, startDate, endDate, tags }: import("../model").GetRevenueProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetRevenue>;
+    getSearchesCount({ index, startDate, endDate, tags }: import("../model").GetSearchesCountProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetSearchesCountResponse>;
+    getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags, }: import("../model").GetSearchesNoClicksProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetSearchesNoClicksResponse>;
+    getSearchesNoResults({ index, startDate, endDate, limit, offset, tags, }: import("../model").GetSearchesNoResultsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetSearchesNoResultsResponse>;
+    getStatus({ index }: import("../model").GetStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetStatusResponse>;
+    getTopCountries({ index, startDate, endDate, limit, offset, tags }: import("../model").GetTopCountriesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopCountriesResponse>;
+    getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags, }: import("../model").GetTopFilterAttributesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopFilterAttributesResponse>;
+    getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags, }: import("../model").GetTopFilterForAttributeProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopFilterForAttributeResponse>;
+    getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags, }: import("../model").GetTopFiltersNoResultsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopFiltersNoResultsResponse>;
+    getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags, }: import("../model").GetTopHitsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopHitsResponse>;
+    getTopSearches({ index, clickAnalytics, revenueAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }: import("../model").GetTopSearchesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetTopSearchesResponse>;
+    getUsersCount({ index, startDate, endDate, tags }: import("../model").GetUsersCountProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetUsersCountResponse>;
+};
 //# sourceMappingURL=node.d.ts.map

package/dist/builds/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGtE,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,MAAM,GACP,MAAM,wBAAwB,CAAC;AAChC,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CA+BjB"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAClE,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAGjE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkCxB"}