diff --git a/.github/ISSUE_TEMPLATE/Bug_report.yml b/.github/ISSUE_TEMPLATE/Bug_report.yml
index e919fd952..ecf2dfdbd 100644
--- a/.github/ISSUE_TEMPLATE/Bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/Bug_report.yml
@@ -39,7 +39,6 @@ body:
- Query-Suggestions
- Recommend
- Search
- - Usage
- Crawler
validations:
required: true
diff --git a/packages/client-usage/LICENSE b/packages/client-usage/LICENSE
deleted file mode 100644
index fddf416f9..000000000
--- a/packages/client-usage/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-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.
diff --git a/packages/client-usage/README.md b/packages/client-usage/README.md
deleted file mode 100644
index 90d75fdec..000000000
--- a/packages/client-usage/README.md
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-
-
The perfect starting point to integrate Algolia within your JavaScript project
-
-
-
-
-
-
-
-
-
-
- Documentation •
- InstantSearch •
- Community Forum •
- Stack Overflow •
- Report a bug •
- FAQ •
- Support
-
-
-## ✨ Features
-
-- Thin & **minimal low-level HTTP client** to interact with Algolia's API
-- Works both on the **browser** and **node.js**
-- **UMD and ESM compatible**, you can use it with any module loader
-- Built with TypeScript
-
-## 💡 Getting Started
-
-To get started, you first need to install @algolia/client-usage (or any other available API client package).
-
-All of our clients comes with type definition, and are available for both browser and node environments.
-
-```bash
-yarn add @algolia/client-usage
-# or
-npm install @algolia/client-usage
-```
-
-Without a package manager
-
-Add the following JavaScript snippet to the of your website:
-
-```html
-
-```
-
-You can now import the Algolia API client in your project and play with it.
-
-```js
-import { usageClient } from '@algolia/client-usage';
-
-const client = usageClient('YOUR_APP_ID', 'YOUR_API_KEY');
-```
-
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
-
-## ❓ Troubleshooting
-
-Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
-
-## 📄 License
-
-The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).
\ No newline at end of file
diff --git a/packages/client-usage/builds/browser.ts b/packages/client-usage/builds/browser.ts
deleted file mode 100644
index e29efe755..000000000
--- a/packages/client-usage/builds/browser.ts
+++ /dev/null
@@ -1,48 +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 { ClientOptions } from '@algolia/client-common';
-import {
- createMemoryCache,
- createFallbackableCache,
- createBrowserLocalStorageCache,
- DEFAULT_CONNECT_TIMEOUT_BROWSER,
- DEFAULT_READ_TIMEOUT_BROWSER,
- DEFAULT_WRITE_TIMEOUT_BROWSER,
-} from '@algolia/client-common';
-import { createXhrRequester } from '@algolia/requester-browser-xhr';
-
-import { createUsageClient, apiClientVersion } from '../src/usageClient';
-
-export type UsageClient = ReturnType;
-
-export { apiClientVersion } from '../src/usageClient';
-export * from '../model';
-
-export function usageClient(appId: string, apiKey: string, options?: ClientOptions): UsageClient {
- if (!appId || typeof appId !== 'string') {
- throw new Error('`appId` is missing.');
- }
-
- if (!apiKey || typeof apiKey !== 'string') {
- throw new Error('`apiKey` is missing.');
- }
-
- return createUsageClient({
- appId,
- apiKey,
- timeouts: {
- connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
- read: DEFAULT_READ_TIMEOUT_BROWSER,
- write: DEFAULT_WRITE_TIMEOUT_BROWSER,
- },
- requester: createXhrRequester(),
- algoliaAgents: [{ segment: 'Browser' }],
- authMode: 'WithinQueryParameters',
- responsesCache: createMemoryCache(),
- requestsCache: createMemoryCache({ serializable: false }),
- hostsCache: createFallbackableCache({
- caches: [createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }), createMemoryCache()],
- }),
- ...options,
- });
-}
diff --git a/packages/client-usage/builds/fetch.ts b/packages/client-usage/builds/fetch.ts
deleted file mode 100644
index 57a1e679f..000000000
--- a/packages/client-usage/builds/fetch.ts
+++ /dev/null
@@ -1,46 +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 { ClientOptions } from '@algolia/client-common';
-import {
- createMemoryCache,
- createNullCache,
- DEFAULT_CONNECT_TIMEOUT_NODE,
- DEFAULT_READ_TIMEOUT_NODE,
- DEFAULT_WRITE_TIMEOUT_NODE,
-} from '@algolia/client-common';
-import { createFetchRequester } from '@algolia/requester-fetch';
-
-import { createUsageClient } from '../src/usageClient';
-
-export type UsageClient = ReturnType;
-
-export { apiClientVersion } from '../src/usageClient';
-export * from '../model';
-
-export function usageClient(appId: string, apiKey: string, options?: ClientOptions): UsageClient {
- if (!appId || typeof appId !== 'string') {
- throw new Error('`appId` is missing.');
- }
-
- if (!apiKey || typeof apiKey !== 'string') {
- throw new Error('`apiKey` is missing.');
- }
-
- return {
- ...createUsageClient({
- appId,
- apiKey,
- timeouts: {
- connect: DEFAULT_CONNECT_TIMEOUT_NODE,
- read: DEFAULT_READ_TIMEOUT_NODE,
- write: DEFAULT_WRITE_TIMEOUT_NODE,
- },
- algoliaAgents: [{ segment: 'Fetch' }],
- requester: createFetchRequester(),
- responsesCache: createNullCache(),
- requestsCache: createNullCache(),
- hostsCache: createMemoryCache(),
- ...options,
- }),
- };
-}
diff --git a/packages/client-usage/builds/node.ts b/packages/client-usage/builds/node.ts
deleted file mode 100644
index a94eef922..000000000
--- a/packages/client-usage/builds/node.ts
+++ /dev/null
@@ -1,46 +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 { ClientOptions } from '@algolia/client-common';
-import {
- createMemoryCache,
- createNullCache,
- DEFAULT_CONNECT_TIMEOUT_NODE,
- DEFAULT_READ_TIMEOUT_NODE,
- DEFAULT_WRITE_TIMEOUT_NODE,
-} from '@algolia/client-common';
-import { createHttpRequester } from '@algolia/requester-node-http';
-
-import { createUsageClient } from '../src/usageClient';
-
-export type UsageClient = ReturnType;
-
-export { apiClientVersion } from '../src/usageClient';
-export * from '../model';
-
-export function usageClient(appId: string, apiKey: string, options?: ClientOptions): UsageClient {
- if (!appId || typeof appId !== 'string') {
- throw new Error('`appId` is missing.');
- }
-
- if (!apiKey || typeof apiKey !== 'string') {
- throw new Error('`apiKey` is missing.');
- }
-
- return {
- ...createUsageClient({
- appId,
- apiKey,
- timeouts: {
- connect: DEFAULT_CONNECT_TIMEOUT_NODE,
- read: DEFAULT_READ_TIMEOUT_NODE,
- write: DEFAULT_WRITE_TIMEOUT_NODE,
- },
- requester: createHttpRequester(),
- algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
- responsesCache: createNullCache(),
- requestsCache: createNullCache(),
- hostsCache: createMemoryCache(),
- ...options,
- }),
- };
-}
diff --git a/packages/client-usage/index.d.ts b/packages/client-usage/index.d.ts
deleted file mode 100644
index 23eac31bd..000000000
--- a/packages/client-usage/index.d.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-// eslint-disable-next-line import/no-unresolved
-export * from './dist/node';
diff --git a/packages/client-usage/index.js b/packages/client-usage/index.js
deleted file mode 100644
index 5ae95ae01..000000000
--- a/packages/client-usage/index.js
+++ /dev/null
@@ -1,2 +0,0 @@
-// eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/builds/node.cjs');
\ No newline at end of file
diff --git a/packages/client-usage/model/clientMethodProps.ts b/packages/client-usage/model/clientMethodProps.ts
deleted file mode 100644
index 349aa8ee0..000000000
--- a/packages/client-usage/model/clientMethodProps.ts
+++ /dev/null
@@ -1,116 +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 { Granularity } from './granularity';
-import type { Statistic } from './statistic';
-
-/**
- * Properties for the `customDelete` method.
- */
-export type CustomDeleteProps = {
- /**
- * Path of the endpoint, anything after \"/1\" must be specified.
- */
- path: string;
- /**
- * Query parameters to apply to the current query.
- */
- parameters?: Record;
-};
-
-/**
- * Properties for the `customGet` method.
- */
-export type CustomGetProps = {
- /**
- * Path of the endpoint, anything after \"/1\" must be specified.
- */
- path: string;
- /**
- * Query parameters to apply to the current query.
- */
- parameters?: Record;
-};
-
-/**
- * Properties for the `customPost` method.
- */
-export type CustomPostProps = {
- /**
- * Path of the endpoint, anything after \"/1\" must be specified.
- */
- path: string;
- /**
- * Query parameters to apply to the current query.
- */
- parameters?: Record;
- /**
- * Parameters to send with the custom request.
- */
- body?: Record;
-};
-
-/**
- * Properties for the `customPut` method.
- */
-export type CustomPutProps = {
- /**
- * Path of the endpoint, anything after \"/1\" must be specified.
- */
- path: string;
- /**
- * Query parameters to apply to the current query.
- */
- parameters?: Record;
- /**
- * Parameters to send with the custom request.
- */
- body?: Record;
-};
-
-/**
- * Properties for the `getIndexUsage` method.
- */
-export type GetIndexUsageProps = {
- /**
- * Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server\'s SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries.
- */
- statistic: Statistic;
- /**
- * Name of the index on which to perform the operation.
- */
- indexName: string;
- /**
- * Start date of the period to analyze, in RFC 3339 format.
- */
- startDate: string;
- /**
- * End date of the period to analyze, in RFC 3339 format.
- */
- endDate: string;
- /**
- * Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days.
- */
- granularity?: Granularity;
-};
-
-/**
- * Properties for the `getUsage` method.
- */
-export type GetUsageProps = {
- /**
- * Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server\'s SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries.
- */
- statistic: Statistic;
- /**
- * Start date of the period to analyze, in RFC 3339 format.
- */
- startDate: string;
- /**
- * End date of the period to analyze, in RFC 3339 format.
- */
- endDate: string;
- /**
- * Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days.
- */
- granularity?: Granularity;
-};
diff --git a/packages/client-usage/model/errorBase.ts b/packages/client-usage/model/errorBase.ts
deleted file mode 100644
index 960e509cb..000000000
--- a/packages/client-usage/model/errorBase.ts
+++ /dev/null
@@ -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 & {
- message?: string;
-};
diff --git a/packages/client-usage/model/errorItem.ts b/packages/client-usage/model/errorItem.ts
deleted file mode 100644
index b53f82dec..000000000
--- a/packages/client-usage/model/errorItem.ts
+++ /dev/null
@@ -1,11 +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 ErrorItem = {
- code?: string;
-
- message: string;
-
- line?: number;
-
- position?: number;
-};
diff --git a/packages/client-usage/model/forbidden.ts b/packages/client-usage/model/forbidden.ts
deleted file mode 100644
index 5ff3b64e6..000000000
--- a/packages/client-usage/model/forbidden.ts
+++ /dev/null
@@ -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 { ForbiddenError } from './forbiddenError';
-
-export type Forbidden = {
- error: ForbiddenError;
-};
diff --git a/packages/client-usage/model/forbiddenError.ts b/packages/client-usage/model/forbiddenError.ts
deleted file mode 100644
index 0100f7375..000000000
--- a/packages/client-usage/model/forbiddenError.ts
+++ /dev/null
@@ -1,11 +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 { ErrorItem } from './errorItem';
-
-export type ForbiddenError = {
- code?: string;
-
- message?: string;
-
- errors?: ErrorItem[];
-};
diff --git a/packages/client-usage/model/granularity.ts b/packages/client-usage/model/granularity.ts
deleted file mode 100644
index 4bdf841d2..000000000
--- a/packages/client-usage/model/granularity.ts
+++ /dev/null
@@ -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 Granularity = 'daily' | 'hourly';
diff --git a/packages/client-usage/model/index.ts b/packages/client-usage/model/index.ts
deleted file mode 100644
index 3bae42d10..000000000
--- a/packages/client-usage/model/index.ts
+++ /dev/null
@@ -1,14 +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 './errorBase';
-export * from './errorItem';
-export * from './forbidden';
-export * from './forbiddenError';
-export * from './granularity';
-export * from './indexUsage';
-export * from './invalidRequest';
-export * from './invalidRequestError';
-export * from './statistic';
-export * from './statisticEntry';
-export * from './statisticValue';
-export * from './clientMethodProps';
diff --git a/packages/client-usage/model/indexUsage.ts b/packages/client-usage/model/indexUsage.ts
deleted file mode 100644
index d1bb3c81f..000000000
--- a/packages/client-usage/model/indexUsage.ts
+++ /dev/null
@@ -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 { StatisticEntry } from './statisticEntry';
-
-export type IndexUsage = {
- statistics?: StatisticEntry[];
-};
diff --git a/packages/client-usage/model/invalidRequest.ts b/packages/client-usage/model/invalidRequest.ts
deleted file mode 100644
index 4f39387b3..000000000
--- a/packages/client-usage/model/invalidRequest.ts
+++ /dev/null
@@ -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 { InvalidRequestError } from './invalidRequestError';
-
-export type InvalidRequest = {
- error: InvalidRequestError;
-};
diff --git a/packages/client-usage/model/invalidRequestError.ts b/packages/client-usage/model/invalidRequestError.ts
deleted file mode 100644
index 6f96df12e..000000000
--- a/packages/client-usage/model/invalidRequestError.ts
+++ /dev/null
@@ -1,11 +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 { ErrorItem } from './errorItem';
-
-export type InvalidRequestError = {
- code?: string;
-
- message?: string;
-
- errors?: ErrorItem[];
-};
diff --git a/packages/client-usage/model/statistic.ts b/packages/client-usage/model/statistic.ts
deleted file mode 100644
index f9a6e1855..000000000
--- a/packages/client-usage/model/statistic.ts
+++ /dev/null
@@ -1,87 +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 Statistic =
- | '*'
- | '90p_processing_time'
- | '99p_processing_time'
- | 'acl_operations'
- | 'add_api_key_operations'
- | 'add_record_operations'
- | 'avg_processing_time'
- | 'avg_used_search_capacity'
- | 'batch_operations'
- | 'batch_rules_operations'
- | 'batch_synonym_operations'
- | 'browse_operations'
- | 'clear_index_operations'
- | 'clear_rules_operations'
- | 'clear_synonym_operations'
- | 'copy_move_operations'
- | 'data_size'
- | 'degraded_queries_max_capacity_queries_impacted'
- | 'degraded_queries_max_capacity_seconds_impacted'
- | 'degraded_queries_ssd_used_queries_impacted'
- | 'degraded_queries_ssd_used_seconds_impacted'
- | 'delete_api_key_operations'
- | 'delete_by_query_operations'
- | 'delete_index_operations'
- | 'delete_record_operations'
- | 'delete_rules_operations'
- | 'delete_synonym_operations'
- | 'file_size'
- | 'get_api_key_operations'
- | 'get_api_keys_operations'
- | 'get_log_operations'
- | 'get_record_operations'
- | 'get_rules_operations'
- | 'get_settings_operations'
- | 'get_synonym_operations'
- | 'indexing_operations'
- | 'list_api_key_operations'
- | 'list_indices_operations'
- | 'max_qps'
- | 'multi_queries_operations'
- | 'partial_update_record_operations'
- | 'queries_above_last_ms_processing_time'
- | 'queries_operations'
- | 'query_synonym_operations'
- | 'querysuggestions_total_acl_operations'
- | 'querysuggestions_total_indexing_operations'
- | 'querysuggestions_total_operations'
- | 'querysuggestions_total_read_operations'
- | 'querysuggestions_total_records_operations'
- | 'querysuggestions_total_rules_operations'
- | 'querysuggestions_total_search_operations'
- | 'querysuggestions_total_search_requests'
- | 'querysuggestions_total_synonym_operations'
- | 'querysuggestions_total_write_operations'
- | 'record_operations'
- | 'records'
- | 'region_avg_used_search_capacity'
- | 'region_max_qps'
- | 'region_used_search_capacity'
- | 'rule_operations'
- | 'save_rules_operations'
- | 'search_operations'
- | 'search_rules_operations'
- | 'set_settings_operations'
- | 'synonym_operations'
- | 'total_acl_operations'
- | 'total_avg_used_search_capacity'
- | 'total_indexing_operations'
- | 'total_max_qps'
- | 'total_operations'
- | 'total_read_operations'
- | 'total_recommend_requests'
- | 'total_records_operations'
- | 'total_rules_operations'
- | 'total_search_operations'
- | 'total_search_requests'
- | 'total_synonym_operations'
- | 'total_used_search_capacity'
- | 'total_write_operations'
- | 'update_api_key_operations'
- | 'update_record_operations'
- | 'update_synonym_operations'
- | 'used_search_capacity'
- | 'wait_task_operations';
diff --git a/packages/client-usage/model/statisticEntry.ts b/packages/client-usage/model/statisticEntry.ts
deleted file mode 100644
index 5ed9a0476..000000000
--- a/packages/client-usage/model/statisticEntry.ts
+++ /dev/null
@@ -1,12 +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 { StatisticValue } from './statisticValue';
-
-export type StatisticEntry = {
- /**
- * Timestamp, measured in milliseconds since the Unix epoch.
- */
- t?: number;
-
- v?: StatisticValue;
-};
diff --git a/packages/client-usage/model/statisticValue.ts b/packages/client-usage/model/statisticValue.ts
deleted file mode 100644
index a4280d065..000000000
--- a/packages/client-usage/model/statisticValue.ts
+++ /dev/null
@@ -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 StatisticValue = Record | number;
diff --git a/packages/client-usage/package.json b/packages/client-usage/package.json
deleted file mode 100644
index 3b09ca1b0..000000000
--- a/packages/client-usage/package.json
+++ /dev/null
@@ -1,67 +0,0 @@
-{
- "version": "1.4.0",
- "repository": {
- "type": "git",
- "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
- },
- "type": "module",
- "license": "MIT",
- "author": "Algolia",
- "scripts": {
- "build": "yarn clean && yarn tsup && yarn rollup -c rollup.config.js",
- "clean": "rm -rf ./dist || true",
- "test:bundle": "publint . && attw --pack ."
- },
- "name": "@algolia/client-usage",
- "description": "JavaScript client for client-usage",
- "exports": {
- ".": {
- "node": {
- "types": {
- "import": "./dist/node.d.ts",
- "module": "./dist/node.d.ts",
- "require": "./dist/node.d.cts"
- },
- "import": "./dist/builds/node.js",
- "module": "./dist/builds/node.js",
- "require": "./dist/builds/node.cjs"
- },
- "worker": {
- "types": "./dist/fetch.d.ts",
- "default": "./dist/builds/fetch.js"
- },
- "default": {
- "types": "./dist/browser.d.ts",
- "module": "./dist/builds/browser.js",
- "import": "./dist/builds/browser.js",
- "default": "./dist/builds/browser.umd.js"
- }
- },
- "./src/*": "./src/*.ts"
- },
- "jsdelivr": "./dist/builds/browser.umd.js",
- "unpkg": "./dist/builds/browser.umd.js",
- "files": [
- "dist",
- "model",
- "index.js",
- "index.d.ts"
- ],
- "dependencies": {
- "@algolia/client-common": "5.4.0",
- "@algolia/requester-browser-xhr": "5.4.0",
- "@algolia/requester-fetch": "5.4.0",
- "@algolia/requester-node-http": "5.4.0"
- },
- "devDependencies": {
- "@arethetypeswrong/cli": "0.15.4",
- "@types/node": "22.5.1",
- "publint": "0.2.10",
- "rollup": "4.21.2",
- "tsup": "8.2.4",
- "typescript": "5.5.4"
- },
- "engines": {
- "node": ">= 14.0.0"
- }
-}
diff --git a/packages/client-usage/rollup.config.js b/packages/client-usage/rollup.config.js
deleted file mode 100644
index 5d6d945ba..000000000
--- a/packages/client-usage/rollup.config.js
+++ /dev/null
@@ -1,16 +0,0 @@
-export default [
- {
- input: 'dist/builds/browser.min.js',
- external: ['dom'],
- output: {
- esModule: false,
- file: 'dist/builds/browser.umd.js',
- name: 'usageClient',
- format: 'umd',
- sourcemap: false,
- globals: {
- ['usageClient']: 'usageClient',
- },
- },
- },
-]
\ No newline at end of file
diff --git a/packages/client-usage/src/usageClient.ts b/packages/client-usage/src/usageClient.ts
deleted file mode 100644
index a35a09dff..000000000
--- a/packages/client-usage/src/usageClient.ts
+++ /dev/null
@@ -1,330 +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 { createAuth, createTransporter, getAlgoliaAgent } from '@algolia/client-common';
-import type {
- CreateClientOptions,
- Headers,
- Host,
- QueryParameters,
- Request,
- RequestOptions,
-} from '@algolia/client-common';
-
-import type {
- CustomDeleteProps,
- CustomGetProps,
- CustomPostProps,
- CustomPutProps,
- GetIndexUsageProps,
- GetUsageProps,
-} from '../model/clientMethodProps';
-import type { IndexUsage } from '../model/indexUsage';
-
-export const apiClientVersion = '1.4.0';
-
-function getDefaultHosts(): Host[] {
- return [{ url: 'usage.algolia.com', accept: 'readWrite', protocol: 'https' }];
-}
-
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export function createUsageClient({
- appId: appIdOption,
- apiKey: apiKeyOption,
- authMode,
- algoliaAgents,
- ...options
-}: CreateClientOptions) {
- const auth = createAuth(appIdOption, apiKeyOption, authMode);
- const transporter = createTransporter({
- hosts: getDefaultHosts(),
- ...options,
- algoliaAgent: getAlgoliaAgent({
- algoliaAgents,
- client: 'Usage',
- version: apiClientVersion,
- }),
- baseHeaders: {
- 'content-type': 'text/plain',
- ...auth.headers(),
- ...options.baseHeaders,
- },
- baseQueryParameters: {
- ...auth.queryParameters(),
- ...options.baseQueryParameters,
- },
- });
-
- return {
- transporter,
-
- /**
- * The `appId` currently in use.
- */
- appId: appIdOption,
-
- /**
- * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
- */
- clearCache(): Promise {
- return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => undefined);
- },
-
- /**
- * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
- */
- get _ua(): string {
- return transporter.algoliaAgent.value;
- },
-
- /**
- * Adds a `segment` to the `x-algolia-agent` sent with every requests.
- *
- * @param segment - The algolia agent (user-agent) segment to add.
- * @param version - The version of the agent.
- */
- addAlgoliaAgent(segment: string, version?: string): void {
- transporter.algoliaAgent.add({ segment, version });
- },
-
- /**
- * Helper method to switch the API key used to authenticate the requests.
- *
- * @param params - Method params.
- * @param params.apiKey - The new API Key to use.
- */
- setClientApiKey({ apiKey }: { apiKey: string }): void {
- if (!authMode || authMode === 'WithinHeaders') {
- transporter.baseHeaders['x-algolia-api-key'] = apiKey;
- } else {
- transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;
- }
- },
-
- /**
- * This method allow you to send requests to the Algolia REST API.
- *
- * @param customDelete - The customDelete object.
- * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
- * @param customDelete.parameters - Query parameters to apply to the current query.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
- customDelete(
- { path, parameters }: CustomDeleteProps,
- requestOptions?: RequestOptions,
- ): Promise> {
- if (!path) {
- throw new Error('Parameter `path` is required when calling `customDelete`.');
- }
-
- const requestPath = '/{path}'.replace('{path}', path);
- const headers: Headers = {};
- const queryParameters: QueryParameters = parameters ? parameters : {};
-
- const request: Request = {
- method: 'DELETE',
- path: requestPath,
- queryParameters,
- headers,
- };
-
- return transporter.request(request, requestOptions);
- },
-
- /**
- * This method allow you to send requests to the Algolia REST API.
- *
- * @param customGet - The customGet object.
- * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
- * @param customGet.parameters - Query parameters to apply to the current query.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
- customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise> {
- if (!path) {
- throw new Error('Parameter `path` is required when calling `customGet`.');
- }
-
- const requestPath = '/{path}'.replace('{path}', path);
- const headers: Headers = {};
- const queryParameters: QueryParameters = parameters ? parameters : {};
-
- const request: Request = {
- method: 'GET',
- path: requestPath,
- queryParameters,
- headers,
- };
-
- return transporter.request(request, requestOptions);
- },
-
- /**
- * This method allow you to send requests to the Algolia REST API.
- *
- * @param customPost - The customPost object.
- * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
- * @param customPost.parameters - Query parameters to apply to the current query.
- * @param customPost.body - Parameters to send with the custom request.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
- customPost(
- { path, parameters, body }: CustomPostProps,
- requestOptions?: RequestOptions,
- ): Promise> {
- if (!path) {
- throw new Error('Parameter `path` is required when calling `customPost`.');
- }
-
- const requestPath = '/{path}'.replace('{path}', path);
- const headers: Headers = {};
- const queryParameters: QueryParameters = parameters ? parameters : {};
-
- const request: Request = {
- method: 'POST',
- path: requestPath,
- queryParameters,
- headers,
- data: body ? body : {},
- };
-
- return transporter.request(request, requestOptions);
- },
-
- /**
- * This method allow you to send requests to the Algolia REST API.
- *
- * @param customPut - The customPut object.
- * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
- * @param customPut.parameters - Query parameters to apply to the current query.
- * @param customPut.body - Parameters to send with the custom request.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
- customPut(
- { path, parameters, body }: CustomPutProps,
- requestOptions?: RequestOptions,
- ): Promise> {
- if (!path) {
- throw new Error('Parameter `path` is required when calling `customPut`.');
- }
-
- const requestPath = '/{path}'.replace('{path}', path);
- const headers: Headers = {};
- const queryParameters: QueryParameters = parameters ? parameters : {};
-
- const request: Request = {
- method: 'PUT',
- path: requestPath,
- queryParameters,
- headers,
- data: body ? body : {},
- };
-
- return transporter.request(request, requestOptions);
- },
-
- /**
- * Retrieves the selected usage statistics for one index.
- *
- * @param getIndexUsage - The getIndexUsage object.
- * @param getIndexUsage.statistic - Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server\'s SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries.
- * @param getIndexUsage.indexName - Name of the index on which to perform the operation.
- * @param getIndexUsage.startDate - Start date of the period to analyze, in RFC 3339 format.
- * @param getIndexUsage.endDate - End date of the period to analyze, in RFC 3339 format.
- * @param getIndexUsage.granularity - Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
- getIndexUsage(
- { statistic, indexName, startDate, endDate, granularity }: GetIndexUsageProps,
- requestOptions?: RequestOptions,
- ): Promise {
- if (!statistic) {
- throw new Error('Parameter `statistic` is required when calling `getIndexUsage`.');
- }
-
- if (!indexName) {
- throw new Error('Parameter `indexName` is required when calling `getIndexUsage`.');
- }
-
- if (!startDate) {
- throw new Error('Parameter `startDate` is required when calling `getIndexUsage`.');
- }
-
- if (!endDate) {
- throw new Error('Parameter `endDate` is required when calling `getIndexUsage`.');
- }
-
- const requestPath = '/1/usage/{statistic}/{indexName}'
- .replace('{statistic}', encodeURIComponent(statistic))
- .replace('{indexName}', encodeURIComponent(indexName));
- const headers: Headers = {};
- const queryParameters: QueryParameters = {};
- if (startDate !== undefined) {
- queryParameters.startDate = startDate.toString();
- }
- if (endDate !== undefined) {
- queryParameters.endDate = endDate.toString();
- }
- if (granularity !== undefined) {
- queryParameters.granularity = granularity.toString();
- }
-
- const request: Request = {
- method: 'GET',
- path: requestPath,
- queryParameters,
- headers,
- };
-
- return transporter.request(request, requestOptions);
- },
-
- /**
- * Retrieves usage statistics evaluated over a specified period.
- *
- * @param getUsage - The getUsage object.
- * @param getUsage.statistic - Usage statistics to retrieve. Use `*` to retrieve all usage metrics, otherwise add one or more of the following metrics, separated by a comma. **Search operations** - `search_operations`. All search operations. - `total_search_operations`: Sum of all search operations. - `total_search_requests`: Sum of all [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). The number of billed search requests is equal to this value minus `querysuggestions_total_search_requests`. - `queries_operations`. Number of [single index search](/specs/search#tag/Search/operation/searchSingleIndex) operations. - `multi_queries_operations`. Number of [multi-index search](/specs/search#tag/Search/operation/search) operations. **ACL operations** - `acl_operations`. All ACL operations. - `total_acl_operations`. Sum of all ACL operations. - `get_api_keys_operations`. Number of [list API keys](/specs/search#tag/Api-Keys/operation/listApiKeys) operations. - `get_api_key_operations`. Number of [get API key permission](/specs/search#tag/Api-Keys/operation/getApiKey) operations. - `add_api_key_operations`. Number of [create API key](/specs/search#tag/Api-Keys/operation/addApiKey) operations. - `update_api_key_operations`. Number of [update API key](/specs/search#tag/Api-Keys/operation/updateApiKey) operations. - `delete_api_key_operations`. Number of [delete API key](/specs/search#tag/Api-Keys/operation/deleteApiKey) operations. - `list_api_key_operations`. Number of list index API keys operations. **Indexing operations** - `indexing_operations`. All indexing operations. - `total_indexing_operations`. Sum of all indexing operations. - `browse_operations`. Number of [browse index](/specs/search#tag/Search/operation/browse) operations. - `clear_index_operations`. Number of [clear records](/specs/search#tag/Records/operation/clearObjects) operations. - `copy_move_operations`. Number of [copy or move index](/specs/search#tag/Indices/operation/operationIndex) operations. - `delete_index_operations`. Number of [delete index](/specs/search#tag/Indices/operation/deleteIndex) operations. - `get_log_operations`. Number of [get logs](/specs/search#tag/Advanced/operation/getLogs) operations. - `get_settings_operations`. Number of [get settings](/specs/search#operation/getIndexUsage) operations. - `set_settings_operations`. Number of [set settings](/specs/search#tag/Indices/operation/setSettings) operations. - `list_indices_operations`. Number of [list indices](/specs/search#tag/Indices/operation/listIndices) operations. - `wait_task_operations`. Number of [wait](/specs/search#tag/Indices/operation/getTask) operations. **Record operations** - `record_operations`. All record operations. - `total_records_operations`. Sum of all record operations. - `add_record_operations`. Number of [add or replace record](/specs/search#tag/Records/operation/saveObject) operations. - `batch_operations`. Number of [batch indexing](/specs/search#tag/Records/operation/multipleBatch) operations. - `delete_by_query_operations`. Number of [delete by query](/specs/search#tag/Records/operation/deleteBy) operations. - `delete_record_operations`. Number of [delete record](/specs/search#tag/Records/operation/deleteObject) operations. - `get_record_operations`. Number of [get record](/specs/search#tag/Records/operation/getObject) operations. - `partial_update_record_operations`. Number of [partially update records](/specs/search#tag/Records/operation/partialUpdateObject) operations. - `update_record_operations`. Number of [add or replace record by objectID](/specs/search#tag/Records/operation/addOrUpdateObject) operations. **Synonym operations** - `synonym_operations`. All synonym operations. - `total_synonym_operations`. Sum of all synonym operations. - `batch_synonym_operations`. Number of [save all synonyms](/specs/search#tag/Synonyms/operation/saveSynonyms) operations. - `clear_synonym_operations`. Number of [clear synonyms](/specs/search#tag/Synonyms/operation/clearSynonyms) operations. - `delete_synonym_operations`. Number of [delete synonym](/specs/search#tag/Synonyms/operation/deleteSynonym) operations. - `get_synonym_operations`. Number of [get synonym](/specs/search#tag/Synonyms/operation/getSynonym) operations. - `query_synonym_operations`. Number of [search synonyms](/specs/search#tag/Synonyms/operation/searchSynonyms) operations. - `update_synonym_operations`. Number of [save a synonym](/specs/search#tag/Synonyms/operation/saveSynonym) operations. **Rule operations** - `rule_operations`. All rule operations. - `total_rules_operations`. Sum of all rule operations. - `batch_rules_operations`. Number of [batch rules](/specs/search#tag/Rules/operation/saveRules) operations. - `clear_rules_operations`. Number of [delete rule](/specs/search#tag/Rules/operation/deleteRule) operations. - `delete_rules_operations`. Number of [clear rules](/specs/search#tag/Rules/operation/clearRules) operations. - `get_rules_operations`. Number of [get rule](/specs/search#tag/Rules/operation/getRule) operations. - `save_rules_operations`. Number of [save rule](/specs/search#operation/getIndexUsage) operations. - `search_rules_operations`. Number of [search rules](/specs/search#tag/Rules/operation/searchRules) operations. **Total operations** - `total_recommend_requests`. Number of [Recommend requests](https://www.algolia.com/doc/guides/algolia-ai/recommend/) - `total_write_operations`. Number of Write operations - `total_read_operations`. Number of read operations - `total_operations`. Sum of all operations **Total Query Suggestions operations** Query Suggestions operations are a subset of `total_search_operations`. - `querysuggestions_total_search_operations`. Number of Query Suggestions search operations. - `querysuggestions_total_search_requests`. Number of Query Suggestions [search requests](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-). - `querysuggestions_total_acl_operations`. Sum of all Query Suggestions [ACL operations](#acl-operations). - `querysuggestions_total_indexing_operations`. Number of Query Suggestions [indexing operations](#indexing-operations). - `querysuggestions_total_records_operations`. Number of Query Suggestions [record operations](#record-operations). - `querysuggestions_total_synonym_operations`. Number of Query Suggestions [synonym operations](#synonym-operations). - `querysuggestions_total_rules_operations`. Number of Query Suggestions [Rule operations](#rule-operations). - `querysuggestions_total_write_operations`. Number of Query Suggestions Write operations. - `querysuggestions_total_read_operations`. Number of Query Suggestions Read operations. - `querysuggestions_total_operations`. Sum of all Query Suggestions operations. **Processing time** - `avg_processing_time`. Average processing time (in milliseconds). - `90p_processing_time`. 90th percentile of processing time (in milliseconds). - `99p_processing_time`. 99th percentile of processing time (in milliseconds). - `queries_above_last_ms_processing_time`. Number of queries that take one or more seconds to process. **Indices** - `records`. Number of records. - `data_size`. The size of the records (in bytes). - `file_size`. The size of the records _and_ index metadata (in bytes). **Maximum queries per second** - `max_qps`. [Maximum queries per second](https://support.algolia.com/hc/en-us/articles/4406975224721) per server. - `region_max_qps`. Maximum queries per second per region. - `total_max_qps`. Maximum queries per second across all servers. **Used search capacity** The following capacities are reported in percent: - `used_search_capacity`. Maximum search capacity used per server. - `avg_used_search_capacity`. Average search capacity used per server. - `region_used_search_capacity`. Maximum search capacity used per region. - `region_avg_used_search_capacity`. Average search capacity used per region. - `total_used_search_capacity`. Maximum search capacity used for all servers. - `total_avg_used_search_capacity`. Average used search capacity for all servers. **Degraded queries** Check the impact of [degraded queries](https://support.algolia.com/hc/en-us/articles/4406981934481). - `degraded_queries_ssd_used_queries_impacted`. Percentage of degraded queries due to the Algolia search engine having to read from the server\'s SSD. - `degraded_queries_ssd_used_seconds_impacted`. Percentage of seconds affected by `ssd_used` degraded queries. - `degraded_queries_max_capacity_queries_impacted`. Percentage of degraded queries due to all search threads being used. - `degraded_queries_max_capacity_seconds_impacted`. Percentage of seconds affected by `max_capacity` degraded queries.
- * @param getUsage.startDate - Start date of the period to analyze, in RFC 3339 format.
- * @param getUsage.endDate - End date of the period to analyze, in RFC 3339 format.
- * @param getUsage.granularity - Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
- getUsage(
- { statistic, startDate, endDate, granularity }: GetUsageProps,
- requestOptions?: RequestOptions,
- ): Promise {
- if (!statistic) {
- throw new Error('Parameter `statistic` is required when calling `getUsage`.');
- }
-
- if (!startDate) {
- throw new Error('Parameter `startDate` is required when calling `getUsage`.');
- }
-
- if (!endDate) {
- throw new Error('Parameter `endDate` is required when calling `getUsage`.');
- }
-
- const requestPath = '/1/usage/{statistic}'.replace('{statistic}', encodeURIComponent(statistic));
- const headers: Headers = {};
- const queryParameters: QueryParameters = {};
-
- if (startDate !== undefined) {
- queryParameters.startDate = startDate.toString();
- }
- if (endDate !== undefined) {
- queryParameters.endDate = endDate.toString();
- }
- if (granularity !== undefined) {
- queryParameters.granularity = granularity.toString();
- }
-
- const request: Request = {
- method: 'GET',
- path: requestPath,
- queryParameters,
- headers,
- };
-
- return transporter.request(request, requestOptions);
- },
- };
-}
diff --git a/packages/client-usage/tsconfig.json b/packages/client-usage/tsconfig.json
deleted file mode 100644
index 37a747f62..000000000
--- a/packages/client-usage/tsconfig.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "extends": "../../tsconfig.json",
- "compilerOptions": {
- "outDir": "dist"
- },
- "include": ["src", "model", "builds"],
- "exclude": ["dist", "node_modules"]
-}
\ No newline at end of file
diff --git a/packages/client-usage/tsup.config.ts b/packages/client-usage/tsup.config.ts
deleted file mode 100644
index 664853a00..000000000
--- a/packages/client-usage/tsup.config.ts
+++ /dev/null
@@ -1,59 +0,0 @@
-import type { Options } from 'tsup';
-import { defineConfig } from 'tsup';
-
-import { getBaseNodeOptions, getBaseBrowserOptions, getDependencies } from '../../base.tsup.config';
-
-import pkg from './package.json' with { type: 'json' };
-
-const nodeOptions: Options = {
- ...getBaseNodeOptions(pkg, __dirname),
- dts: { entry: { node: 'builds/node.ts' } },
- entry: ['builds/node.ts', 'src/*.ts'],
-};
-
-const nodeConfigs: Options[] = [
- {
- ...nodeOptions,
- format: 'cjs',
- name: `node ${pkg.name} cjs`,
- },
- {
- ...nodeOptions,
- format: 'esm',
- name: `node ${pkg.name} esm`,
- },
- {
- ...nodeOptions,
- format: 'esm',
- name: `fetch ${pkg.name} esm`,
- dts: { entry: { fetch: 'builds/fetch.ts' } },
- external: getDependencies(pkg, 'fetch'),
- entry: ['builds/fetch.ts', 'src/*.ts'],
- },
-];
-
-const browserOptions: Options = {
- ...getBaseBrowserOptions(pkg, __dirname),
- globalName: 'usageClient',
-};
-
-const browserConfigs: Options[] = [
- {
- ...browserOptions,
- minify: false,
- name: `browser ${pkg.name} esm`,
- dts: { entry: { browser: 'builds/browser.ts' } },
- entry: ['builds/browser.ts', 'src/*.ts'],
- },
- {
- ...browserOptions,
- dts: false,
- minify: true,
- name: `browser ${pkg.name} min esm`,
- entry: { 'builds/browser.min': 'builds/browser.ts' },
- external: [],
- noExternal: getDependencies(pkg, 'xhr'),
- },
-];
-
-export default defineConfig([...nodeConfigs, ...browserConfigs]);
diff --git a/yarn.lock b/yarn.lock
index 7a862eda9..6f7f7c46c 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -122,23 +122,6 @@ __metadata:
languageName: unknown
linkType: soft
-"@algolia/client-usage@workspace:packages/client-usage":
- version: 0.0.0-use.local
- resolution: "@algolia/client-usage@workspace:packages/client-usage"
- dependencies:
- "@algolia/client-common": "npm:5.4.0"
- "@algolia/requester-browser-xhr": "npm:5.4.0"
- "@algolia/requester-fetch": "npm:5.4.0"
- "@algolia/requester-node-http": "npm:5.4.0"
- "@arethetypeswrong/cli": "npm:0.15.4"
- "@types/node": "npm:22.5.1"
- publint: "npm:0.2.10"
- rollup: "npm:4.21.2"
- tsup: "npm:8.2.4"
- typescript: "npm:5.5.4"
- languageName: unknown
- linkType: soft
-
"@algolia/ingestion@workspace:packages/ingestion":
version: 0.0.0-use.local
resolution: "@algolia/ingestion@workspace:packages/ingestion"