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

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 (49) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +1 -1
  3. package/dist/builds/browser.js +1 -1
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +1 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +1 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +1 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +1 -1
  15. package/dist/node.d.cts +1 -1
  16. package/dist/node.d.ts +1 -1
  17. package/dist/src/insightsClient.cjs +1 -1
  18. package/dist/src/insightsClient.cjs.map +1 -1
  19. package/dist/src/insightsClient.js +1 -1
  20. package/dist/src/insightsClient.js.map +1 -1
  21. package/package.json +6 -7
  22. package/model/addToCartEvent.ts +0 -3
  23. package/model/addedToCartObjectIDs.ts +0 -57
  24. package/model/addedToCartObjectIDsAfterSearch.ts +0 -62
  25. package/model/clickEvent.ts +0 -3
  26. package/model/clickedFilters.ts +0 -40
  27. package/model/clickedObjectIDs.ts +0 -40
  28. package/model/clickedObjectIDsAfterSearch.ts +0 -50
  29. package/model/clientMethodProps.ts +0 -75
  30. package/model/conversionEvent.ts +0 -3
  31. package/model/convertedFilters.ts +0 -37
  32. package/model/convertedObjectIDs.ts +0 -40
  33. package/model/convertedObjectIDsAfterSearch.ts +0 -45
  34. package/model/discount.ts +0 -6
  35. package/model/errorBase.ts +0 -8
  36. package/model/eventsItems.ts +0 -30
  37. package/model/eventsResponse.ts +0 -16
  38. package/model/index.ts +0 -29
  39. package/model/insightsEvents.ts +0 -10
  40. package/model/objectData.ts +0 -15
  41. package/model/objectDataAfterSearch.ts +0 -20
  42. package/model/price.ts +0 -6
  43. package/model/purchaseEvent.ts +0 -3
  44. package/model/purchasedObjectIDs.ts +0 -57
  45. package/model/purchasedObjectIDsAfterSearch.ts +0 -57
  46. package/model/value.ts +0 -6
  47. package/model/viewEvent.ts +0 -3
  48. package/model/viewedFilters.ts +0 -40
  49. package/model/viewedObjectIDs.ts +0 -40
@@ -1,57 +0,0 @@
1
- // 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.
2
-
3
- import type { ConversionEvent } from './conversionEvent';
4
- import type { ObjectDataAfterSearch } from './objectDataAfterSearch';
5
- import type { PurchaseEvent } from './purchaseEvent';
6
- import type { Value } from './value';
7
-
8
- /**
9
- * Use this event to track when users make a purchase after a previous Algolia request. If you\'re building your category pages with Algolia, you\'ll also use this event.
10
- */
11
- export type PurchasedObjectIDsAfterSearch = {
12
- /**
13
- * Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
14
- */
15
- eventName: string;
16
-
17
- eventType: ConversionEvent;
18
-
19
- eventSubtype: PurchaseEvent;
20
-
21
- /**
22
- * Index name (case-sensitive) to which the event\'s items belong.
23
- */
24
- index: string;
25
-
26
- /**
27
- * Object IDs of the records that are part of the event.
28
- */
29
- objectIDs: Array<string>;
30
-
31
- /**
32
- * Anonymous or pseudonymous user identifier. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
33
- */
34
- userToken: string;
35
-
36
- /**
37
- * Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
38
- */
39
- authenticatedUserToken?: string;
40
-
41
- /**
42
- * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
43
- */
44
- currency?: string;
45
-
46
- /**
47
- * Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`.
48
- */
49
- objectData: Array<ObjectDataAfterSearch>;
50
-
51
- /**
52
- * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
53
- */
54
- timestamp?: number;
55
-
56
- value?: Value;
57
- };
package/model/value.ts DELETED
@@ -1,6 +0,0 @@
1
- // 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.
2
-
3
- /**
4
- * Total monetary value of this event in units of `currency`.
5
- */
6
- export type Value = number | string;
@@ -1,3 +0,0 @@
1
- // 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.
2
-
3
- export type ViewEvent = 'view';
@@ -1,40 +0,0 @@
1
- // 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.
2
-
3
- import type { ViewEvent } from './viewEvent';
4
-
5
- /**
6
- * Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.
7
- */
8
- export type ViewedFilters = {
9
- /**
10
- * Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
11
- */
12
- eventName: string;
13
-
14
- eventType: ViewEvent;
15
-
16
- /**
17
- * Index name (case-sensitive) to which the event\'s items belong.
18
- */
19
- index: string;
20
-
21
- /**
22
- * Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
23
- */
24
- filters: Array<string>;
25
-
26
- /**
27
- * Anonymous or pseudonymous user identifier. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
28
- */
29
- userToken: string;
30
-
31
- /**
32
- * Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
33
- */
34
- authenticatedUserToken?: string;
35
-
36
- /**
37
- * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
38
- */
39
- timestamp?: number;
40
- };
@@ -1,40 +0,0 @@
1
- // 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.
2
-
3
- import type { ViewEvent } from './viewEvent';
4
-
5
- /**
6
- * Use this event to track when users viewed items in the search results.
7
- */
8
- export type ViewedObjectIDs = {
9
- /**
10
- * Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
11
- */
12
- eventName: string;
13
-
14
- eventType: ViewEvent;
15
-
16
- /**
17
- * Index name (case-sensitive) to which the event\'s items belong.
18
- */
19
- index: string;
20
-
21
- /**
22
- * Object IDs of the records that are part of the event.
23
- */
24
- objectIDs: Array<string>;
25
-
26
- /**
27
- * Anonymous or pseudonymous user identifier. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
28
- */
29
- userToken: string;
30
-
31
- /**
32
- * Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
33
- */
34
- authenticatedUserToken?: string;
35
-
36
- /**
37
- * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
38
- */
39
- timestamp?: number;
40
- };