@algolia/client-insights 5.55.1 → 5.56.0
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.
- package/README.md +4 -4
- package/dist/browser.d.ts +74 -3
- package/dist/builds/browser.js +148 -1
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +5 -5
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +7 -7
- package/dist/builds/fetch.js +148 -1
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +148 -1
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +148 -1
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +148 -1
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +74 -3
- package/dist/node.d.cts +74 -3
- package/dist/node.d.ts +74 -3
- package/dist/src/insightsClient.cjs +148 -1
- package/dist/src/insightsClient.cjs.map +1 -1
- package/dist/src/insightsClient.js +148 -1
- package/dist/src/insightsClient.js.map +1 -1
- package/dist/worker.d.ts +74 -3
- package/package.json +9 -9
package/dist/fetch.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _algolia_client_common from '@algolia/client-common';
|
|
2
|
-
import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
|
|
2
|
+
import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* The response of the Insights API.
|
|
@@ -574,14 +574,14 @@ type DeleteUserTokenProps = {
|
|
|
574
574
|
userToken: string;
|
|
575
575
|
};
|
|
576
576
|
|
|
577
|
-
declare const apiClientVersion = "5.
|
|
577
|
+
declare const apiClientVersion = "5.56.0";
|
|
578
578
|
declare const REGIONS: readonly ["de", "us"];
|
|
579
579
|
type Region = (typeof REGIONS)[number];
|
|
580
580
|
type RegionOptions = {
|
|
581
581
|
region?: Region | undefined;
|
|
582
582
|
};
|
|
583
583
|
declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
|
|
584
|
-
transporter: _algolia_client_common.
|
|
584
|
+
transporter: _algolia_client_common.TransporterWithHttpInfo;
|
|
585
585
|
/**
|
|
586
586
|
* The `appId` currently in use.
|
|
587
587
|
*/
|
|
@@ -622,6 +622,17 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
622
622
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
623
623
|
*/
|
|
624
624
|
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
625
|
+
/**
|
|
626
|
+
* This method lets you send requests to the Algolia REST API.
|
|
627
|
+
*
|
|
628
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
629
|
+
* @param customDelete - The customDelete object.
|
|
630
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
631
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
632
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
633
|
+
* @see customDelete for the plain version.
|
|
634
|
+
*/
|
|
635
|
+
customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
625
636
|
/**
|
|
626
637
|
* This method lets you send requests to the Algolia REST API.
|
|
627
638
|
* @param customGet - The customGet object.
|
|
@@ -630,6 +641,17 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
630
641
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
631
642
|
*/
|
|
632
643
|
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
644
|
+
/**
|
|
645
|
+
* This method lets you send requests to the Algolia REST API.
|
|
646
|
+
*
|
|
647
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
648
|
+
* @param customGet - The customGet object.
|
|
649
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
650
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
651
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
652
|
+
* @see customGet for the plain version.
|
|
653
|
+
*/
|
|
654
|
+
customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
633
655
|
/**
|
|
634
656
|
* This method lets you send requests to the Algolia REST API.
|
|
635
657
|
* @param customPost - The customPost object.
|
|
@@ -639,6 +661,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
639
661
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
640
662
|
*/
|
|
641
663
|
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
664
|
+
/**
|
|
665
|
+
* This method lets you send requests to the Algolia REST API.
|
|
666
|
+
*
|
|
667
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
668
|
+
* @param customPost - The customPost object.
|
|
669
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
670
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
671
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
672
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
673
|
+
* @see customPost for the plain version.
|
|
674
|
+
*/
|
|
675
|
+
customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
642
676
|
/**
|
|
643
677
|
* This method lets you send requests to the Algolia REST API.
|
|
644
678
|
* @param customPut - The customPut object.
|
|
@@ -648,6 +682,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
648
682
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
649
683
|
*/
|
|
650
684
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
685
|
+
/**
|
|
686
|
+
* This method lets you send requests to the Algolia REST API.
|
|
687
|
+
*
|
|
688
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
689
|
+
* @param customPut - The customPut object.
|
|
690
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
691
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
692
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
693
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
694
|
+
* @see customPut for the plain version.
|
|
695
|
+
*/
|
|
696
|
+
customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
651
697
|
/**
|
|
652
698
|
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
653
699
|
*
|
|
@@ -658,6 +704,19 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
658
704
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
659
705
|
*/
|
|
660
706
|
deleteUserToken({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<void>;
|
|
707
|
+
/**
|
|
708
|
+
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
709
|
+
*
|
|
710
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
711
|
+
*
|
|
712
|
+
* Required API Key ACLs:
|
|
713
|
+
* - deleteObject
|
|
714
|
+
* @param deleteUserToken - The deleteUserToken object.
|
|
715
|
+
* @param deleteUserToken.userToken - User token for which to delete all associated events.
|
|
716
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
717
|
+
* @see deleteUserToken for the plain version.
|
|
718
|
+
*/
|
|
719
|
+
deleteUserTokenWithHTTPInfo({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<void>>;
|
|
661
720
|
/**
|
|
662
721
|
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
663
722
|
*
|
|
@@ -667,6 +726,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
667
726
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
668
727
|
*/
|
|
669
728
|
pushEvents(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<EventsResponse>;
|
|
729
|
+
/**
|
|
730
|
+
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
731
|
+
*
|
|
732
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
733
|
+
*
|
|
734
|
+
* Required API Key ACLs:
|
|
735
|
+
* - search
|
|
736
|
+
* @param insightsEvents - The insightsEvents object.
|
|
737
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
738
|
+
* @see pushEvents for the plain version.
|
|
739
|
+
*/
|
|
740
|
+
pushEventsWithHTTPInfo(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<EventsResponse>>;
|
|
670
741
|
};
|
|
671
742
|
|
|
672
743
|
/**
|
package/dist/node.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _algolia_client_common from '@algolia/client-common';
|
|
2
|
-
import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
|
|
2
|
+
import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* The response of the Insights API.
|
|
@@ -574,14 +574,14 @@ type DeleteUserTokenProps = {
|
|
|
574
574
|
userToken: string;
|
|
575
575
|
};
|
|
576
576
|
|
|
577
|
-
declare const apiClientVersion = "5.
|
|
577
|
+
declare const apiClientVersion = "5.56.0";
|
|
578
578
|
declare const REGIONS: readonly ["de", "us"];
|
|
579
579
|
type Region = (typeof REGIONS)[number];
|
|
580
580
|
type RegionOptions = {
|
|
581
581
|
region?: Region | undefined;
|
|
582
582
|
};
|
|
583
583
|
declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
|
|
584
|
-
transporter: _algolia_client_common.
|
|
584
|
+
transporter: _algolia_client_common.TransporterWithHttpInfo;
|
|
585
585
|
/**
|
|
586
586
|
* The `appId` currently in use.
|
|
587
587
|
*/
|
|
@@ -622,6 +622,17 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
622
622
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
623
623
|
*/
|
|
624
624
|
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
625
|
+
/**
|
|
626
|
+
* This method lets you send requests to the Algolia REST API.
|
|
627
|
+
*
|
|
628
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
629
|
+
* @param customDelete - The customDelete object.
|
|
630
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
631
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
632
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
633
|
+
* @see customDelete for the plain version.
|
|
634
|
+
*/
|
|
635
|
+
customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
625
636
|
/**
|
|
626
637
|
* This method lets you send requests to the Algolia REST API.
|
|
627
638
|
* @param customGet - The customGet object.
|
|
@@ -630,6 +641,17 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
630
641
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
631
642
|
*/
|
|
632
643
|
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
644
|
+
/**
|
|
645
|
+
* This method lets you send requests to the Algolia REST API.
|
|
646
|
+
*
|
|
647
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
648
|
+
* @param customGet - The customGet object.
|
|
649
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
650
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
651
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
652
|
+
* @see customGet for the plain version.
|
|
653
|
+
*/
|
|
654
|
+
customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
633
655
|
/**
|
|
634
656
|
* This method lets you send requests to the Algolia REST API.
|
|
635
657
|
* @param customPost - The customPost object.
|
|
@@ -639,6 +661,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
639
661
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
640
662
|
*/
|
|
641
663
|
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
664
|
+
/**
|
|
665
|
+
* This method lets you send requests to the Algolia REST API.
|
|
666
|
+
*
|
|
667
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
668
|
+
* @param customPost - The customPost object.
|
|
669
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
670
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
671
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
672
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
673
|
+
* @see customPost for the plain version.
|
|
674
|
+
*/
|
|
675
|
+
customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
642
676
|
/**
|
|
643
677
|
* This method lets you send requests to the Algolia REST API.
|
|
644
678
|
* @param customPut - The customPut object.
|
|
@@ -648,6 +682,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
648
682
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
649
683
|
*/
|
|
650
684
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
685
|
+
/**
|
|
686
|
+
* This method lets you send requests to the Algolia REST API.
|
|
687
|
+
*
|
|
688
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
689
|
+
* @param customPut - The customPut object.
|
|
690
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
691
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
692
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
693
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
694
|
+
* @see customPut for the plain version.
|
|
695
|
+
*/
|
|
696
|
+
customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
651
697
|
/**
|
|
652
698
|
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
653
699
|
*
|
|
@@ -658,6 +704,19 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
658
704
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
659
705
|
*/
|
|
660
706
|
deleteUserToken({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<void>;
|
|
707
|
+
/**
|
|
708
|
+
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
709
|
+
*
|
|
710
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
711
|
+
*
|
|
712
|
+
* Required API Key ACLs:
|
|
713
|
+
* - deleteObject
|
|
714
|
+
* @param deleteUserToken - The deleteUserToken object.
|
|
715
|
+
* @param deleteUserToken.userToken - User token for which to delete all associated events.
|
|
716
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
717
|
+
* @see deleteUserToken for the plain version.
|
|
718
|
+
*/
|
|
719
|
+
deleteUserTokenWithHTTPInfo({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<void>>;
|
|
661
720
|
/**
|
|
662
721
|
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
663
722
|
*
|
|
@@ -667,6 +726,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
667
726
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
668
727
|
*/
|
|
669
728
|
pushEvents(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<EventsResponse>;
|
|
729
|
+
/**
|
|
730
|
+
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
731
|
+
*
|
|
732
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
733
|
+
*
|
|
734
|
+
* Required API Key ACLs:
|
|
735
|
+
* - search
|
|
736
|
+
* @param insightsEvents - The insightsEvents object.
|
|
737
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
738
|
+
* @see pushEvents for the plain version.
|
|
739
|
+
*/
|
|
740
|
+
pushEventsWithHTTPInfo(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<EventsResponse>>;
|
|
670
741
|
};
|
|
671
742
|
|
|
672
743
|
/**
|
package/dist/node.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _algolia_client_common from '@algolia/client-common';
|
|
2
|
-
import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
|
|
2
|
+
import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* The response of the Insights API.
|
|
@@ -574,14 +574,14 @@ type DeleteUserTokenProps = {
|
|
|
574
574
|
userToken: string;
|
|
575
575
|
};
|
|
576
576
|
|
|
577
|
-
declare const apiClientVersion = "5.
|
|
577
|
+
declare const apiClientVersion = "5.56.0";
|
|
578
578
|
declare const REGIONS: readonly ["de", "us"];
|
|
579
579
|
type Region = (typeof REGIONS)[number];
|
|
580
580
|
type RegionOptions = {
|
|
581
581
|
region?: Region | undefined;
|
|
582
582
|
};
|
|
583
583
|
declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
|
|
584
|
-
transporter: _algolia_client_common.
|
|
584
|
+
transporter: _algolia_client_common.TransporterWithHttpInfo;
|
|
585
585
|
/**
|
|
586
586
|
* The `appId` currently in use.
|
|
587
587
|
*/
|
|
@@ -622,6 +622,17 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
622
622
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
623
623
|
*/
|
|
624
624
|
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
625
|
+
/**
|
|
626
|
+
* This method lets you send requests to the Algolia REST API.
|
|
627
|
+
*
|
|
628
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
629
|
+
* @param customDelete - The customDelete object.
|
|
630
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
631
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
632
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
633
|
+
* @see customDelete for the plain version.
|
|
634
|
+
*/
|
|
635
|
+
customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
625
636
|
/**
|
|
626
637
|
* This method lets you send requests to the Algolia REST API.
|
|
627
638
|
* @param customGet - The customGet object.
|
|
@@ -630,6 +641,17 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
630
641
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
631
642
|
*/
|
|
632
643
|
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
644
|
+
/**
|
|
645
|
+
* This method lets you send requests to the Algolia REST API.
|
|
646
|
+
*
|
|
647
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
648
|
+
* @param customGet - The customGet object.
|
|
649
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
650
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
651
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
652
|
+
* @see customGet for the plain version.
|
|
653
|
+
*/
|
|
654
|
+
customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
633
655
|
/**
|
|
634
656
|
* This method lets you send requests to the Algolia REST API.
|
|
635
657
|
* @param customPost - The customPost object.
|
|
@@ -639,6 +661,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
639
661
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
640
662
|
*/
|
|
641
663
|
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
664
|
+
/**
|
|
665
|
+
* This method lets you send requests to the Algolia REST API.
|
|
666
|
+
*
|
|
667
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
668
|
+
* @param customPost - The customPost object.
|
|
669
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
670
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
671
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
672
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
673
|
+
* @see customPost for the plain version.
|
|
674
|
+
*/
|
|
675
|
+
customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
642
676
|
/**
|
|
643
677
|
* This method lets you send requests to the Algolia REST API.
|
|
644
678
|
* @param customPut - The customPut object.
|
|
@@ -648,6 +682,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
648
682
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
649
683
|
*/
|
|
650
684
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
685
|
+
/**
|
|
686
|
+
* This method lets you send requests to the Algolia REST API.
|
|
687
|
+
*
|
|
688
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
689
|
+
* @param customPut - The customPut object.
|
|
690
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
691
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
692
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
693
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
694
|
+
* @see customPut for the plain version.
|
|
695
|
+
*/
|
|
696
|
+
customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
651
697
|
/**
|
|
652
698
|
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
653
699
|
*
|
|
@@ -658,6 +704,19 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
658
704
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
659
705
|
*/
|
|
660
706
|
deleteUserToken({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<void>;
|
|
707
|
+
/**
|
|
708
|
+
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
709
|
+
*
|
|
710
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
711
|
+
*
|
|
712
|
+
* Required API Key ACLs:
|
|
713
|
+
* - deleteObject
|
|
714
|
+
* @param deleteUserToken - The deleteUserToken object.
|
|
715
|
+
* @param deleteUserToken.userToken - User token for which to delete all associated events.
|
|
716
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
717
|
+
* @see deleteUserToken for the plain version.
|
|
718
|
+
*/
|
|
719
|
+
deleteUserTokenWithHTTPInfo({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<void>>;
|
|
661
720
|
/**
|
|
662
721
|
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
663
722
|
*
|
|
@@ -667,6 +726,18 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
|
|
|
667
726
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
668
727
|
*/
|
|
669
728
|
pushEvents(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<EventsResponse>;
|
|
729
|
+
/**
|
|
730
|
+
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
731
|
+
*
|
|
732
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
733
|
+
*
|
|
734
|
+
* Required API Key ACLs:
|
|
735
|
+
* - search
|
|
736
|
+
* @param insightsEvents - The insightsEvents object.
|
|
737
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
738
|
+
* @see pushEvents for the plain version.
|
|
739
|
+
*/
|
|
740
|
+
pushEventsWithHTTPInfo(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<EventsResponse>>;
|
|
670
741
|
};
|
|
671
742
|
|
|
672
743
|
/**
|
|
@@ -26,7 +26,7 @@ __export(insightsClient_exports, {
|
|
|
26
26
|
});
|
|
27
27
|
module.exports = __toCommonJS(insightsClient_exports);
|
|
28
28
|
var import_client_common = require("@algolia/client-common");
|
|
29
|
-
var apiClientVersion = "5.
|
|
29
|
+
var apiClientVersion = "5.56.0";
|
|
30
30
|
var REGIONS = ["de", "us"];
|
|
31
31
|
function getDefaultHosts(region) {
|
|
32
32
|
const url = !region ? "insights.algolia.io" : "insights.{region}.algolia.io".replace("{region}", region);
|
|
@@ -123,6 +123,29 @@ function createInsightsClient({
|
|
|
123
123
|
};
|
|
124
124
|
return transporter.request(request, requestOptions);
|
|
125
125
|
},
|
|
126
|
+
/**
|
|
127
|
+
* This method lets you send requests to the Algolia REST API.
|
|
128
|
+
*
|
|
129
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
130
|
+
* @param customDelete - The customDelete object.
|
|
131
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
132
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
133
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
134
|
+
* @see customDelete for the plain version.
|
|
135
|
+
*/
|
|
136
|
+
customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
137
|
+
(0, import_client_common.validateRequired)("path", "customDeleteWithHTTPInfo", path);
|
|
138
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
139
|
+
const headers = {};
|
|
140
|
+
const queryParameters = parameters ? parameters : {};
|
|
141
|
+
const request = {
|
|
142
|
+
method: "DELETE",
|
|
143
|
+
path: requestPath,
|
|
144
|
+
queryParameters,
|
|
145
|
+
headers
|
|
146
|
+
};
|
|
147
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
148
|
+
},
|
|
126
149
|
/**
|
|
127
150
|
* This method lets you send requests to the Algolia REST API.
|
|
128
151
|
* @param customGet - The customGet object.
|
|
@@ -143,6 +166,29 @@ function createInsightsClient({
|
|
|
143
166
|
};
|
|
144
167
|
return transporter.request(request, requestOptions);
|
|
145
168
|
},
|
|
169
|
+
/**
|
|
170
|
+
* This method lets you send requests to the Algolia REST API.
|
|
171
|
+
*
|
|
172
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
173
|
+
* @param customGet - The customGet object.
|
|
174
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
175
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
176
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
177
|
+
* @see customGet for the plain version.
|
|
178
|
+
*/
|
|
179
|
+
customGetWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
180
|
+
(0, import_client_common.validateRequired)("path", "customGetWithHTTPInfo", path);
|
|
181
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
182
|
+
const headers = {};
|
|
183
|
+
const queryParameters = parameters ? parameters : {};
|
|
184
|
+
const request = {
|
|
185
|
+
method: "GET",
|
|
186
|
+
path: requestPath,
|
|
187
|
+
queryParameters,
|
|
188
|
+
headers
|
|
189
|
+
};
|
|
190
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
191
|
+
},
|
|
146
192
|
/**
|
|
147
193
|
* This method lets you send requests to the Algolia REST API.
|
|
148
194
|
* @param customPost - The customPost object.
|
|
@@ -165,6 +211,31 @@ function createInsightsClient({
|
|
|
165
211
|
};
|
|
166
212
|
return transporter.request(request, requestOptions);
|
|
167
213
|
},
|
|
214
|
+
/**
|
|
215
|
+
* This method lets you send requests to the Algolia REST API.
|
|
216
|
+
*
|
|
217
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
218
|
+
* @param customPost - The customPost object.
|
|
219
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
220
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
221
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
222
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
223
|
+
* @see customPost for the plain version.
|
|
224
|
+
*/
|
|
225
|
+
customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
226
|
+
(0, import_client_common.validateRequired)("path", "customPostWithHTTPInfo", path);
|
|
227
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
228
|
+
const headers = {};
|
|
229
|
+
const queryParameters = parameters ? parameters : {};
|
|
230
|
+
const request = {
|
|
231
|
+
method: "POST",
|
|
232
|
+
path: requestPath,
|
|
233
|
+
queryParameters,
|
|
234
|
+
headers,
|
|
235
|
+
data: body ? body : {}
|
|
236
|
+
};
|
|
237
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
238
|
+
},
|
|
168
239
|
/**
|
|
169
240
|
* This method lets you send requests to the Algolia REST API.
|
|
170
241
|
* @param customPut - The customPut object.
|
|
@@ -187,6 +258,31 @@ function createInsightsClient({
|
|
|
187
258
|
};
|
|
188
259
|
return transporter.request(request, requestOptions);
|
|
189
260
|
},
|
|
261
|
+
/**
|
|
262
|
+
* This method lets you send requests to the Algolia REST API.
|
|
263
|
+
*
|
|
264
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
265
|
+
* @param customPut - The customPut object.
|
|
266
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
267
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
268
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
269
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
270
|
+
* @see customPut for the plain version.
|
|
271
|
+
*/
|
|
272
|
+
customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
273
|
+
(0, import_client_common.validateRequired)("path", "customPutWithHTTPInfo", path);
|
|
274
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
275
|
+
const headers = {};
|
|
276
|
+
const queryParameters = parameters ? parameters : {};
|
|
277
|
+
const request = {
|
|
278
|
+
method: "PUT",
|
|
279
|
+
path: requestPath,
|
|
280
|
+
queryParameters,
|
|
281
|
+
headers,
|
|
282
|
+
data: body ? body : {}
|
|
283
|
+
};
|
|
284
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
285
|
+
},
|
|
190
286
|
/**
|
|
191
287
|
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
192
288
|
*
|
|
@@ -209,6 +305,31 @@ function createInsightsClient({
|
|
|
209
305
|
};
|
|
210
306
|
return transporter.request(request, requestOptions);
|
|
211
307
|
},
|
|
308
|
+
/**
|
|
309
|
+
* Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
|
|
310
|
+
*
|
|
311
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
312
|
+
*
|
|
313
|
+
* Required API Key ACLs:
|
|
314
|
+
* - deleteObject
|
|
315
|
+
* @param deleteUserToken - The deleteUserToken object.
|
|
316
|
+
* @param deleteUserToken.userToken - User token for which to delete all associated events.
|
|
317
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
318
|
+
* @see deleteUserToken for the plain version.
|
|
319
|
+
*/
|
|
320
|
+
deleteUserTokenWithHTTPInfo({ userToken }, requestOptions) {
|
|
321
|
+
(0, import_client_common.validateRequired)("userToken", "deleteUserTokenWithHTTPInfo", userToken);
|
|
322
|
+
const requestPath = "/1/usertokens/{userToken}".replace("{userToken}", encodeURIComponent(userToken));
|
|
323
|
+
const headers = {};
|
|
324
|
+
const queryParameters = {};
|
|
325
|
+
const request = {
|
|
326
|
+
method: "DELETE",
|
|
327
|
+
path: requestPath,
|
|
328
|
+
queryParameters,
|
|
329
|
+
headers
|
|
330
|
+
};
|
|
331
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
332
|
+
},
|
|
212
333
|
/**
|
|
213
334
|
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
214
335
|
*
|
|
@@ -231,6 +352,32 @@ function createInsightsClient({
|
|
|
231
352
|
data: insightsEvents
|
|
232
353
|
};
|
|
233
354
|
return transporter.request(request, requestOptions);
|
|
355
|
+
},
|
|
356
|
+
/**
|
|
357
|
+
* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB.
|
|
358
|
+
*
|
|
359
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
360
|
+
*
|
|
361
|
+
* Required API Key ACLs:
|
|
362
|
+
* - search
|
|
363
|
+
* @param insightsEvents - The insightsEvents object.
|
|
364
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
365
|
+
* @see pushEvents for the plain version.
|
|
366
|
+
*/
|
|
367
|
+
pushEventsWithHTTPInfo(insightsEvents, requestOptions) {
|
|
368
|
+
(0, import_client_common.validateRequired)("insightsEvents", "pushEventsWithHTTPInfo", insightsEvents);
|
|
369
|
+
(0, import_client_common.validateRequired)("insightsEvents.events", "pushEventsWithHTTPInfo", insightsEvents.events);
|
|
370
|
+
const requestPath = "/1/events";
|
|
371
|
+
const headers = {};
|
|
372
|
+
const queryParameters = {};
|
|
373
|
+
const request = {
|
|
374
|
+
method: "POST",
|
|
375
|
+
path: requestPath,
|
|
376
|
+
queryParameters,
|
|
377
|
+
headers,
|
|
378
|
+
data: insightsEvents
|
|
379
|
+
};
|
|
380
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
234
381
|
}
|
|
235
382
|
};
|
|
236
383
|
}
|