chore: generated code for commit 2c7cd9c5. [skip ci]

algolia/api-clients-automation@2c7cd9c

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

packages/algoliasearch/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

packages/algoliasearch/__tests__/algoliasearch.test.ts

@@ -14,6 +14,14 @@ const client = algoliasearch('APP_ID', 'API_KEY', {
 });
 
 describe('api', () => {
+  it('exposes the `appId` currently in use at the root of the API', () => {
+    expect(client.appId).toEqual('APP_ID');
+  });
+
+  it('provides a `clearCache` method', () => {
+    expect(client.clearCache).not.toBeUndefined();
+  });
+
   it('sets the user agent', async () => {
     const req = (await client.post({
       path: '/test',

packages/algoliasearch/lite/src/liteClient.ts

@@ -90,6 +90,21 @@ export function createLiteClient({
   return {
     transporter,
 
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      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.
      */

packages/client-abtesting/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

packages/client-abtesting/src/abtestingClient.ts

@@ -74,6 +74,21 @@ export function createAbtestingClient({
   return {
     transporter,
 
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      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.
      */

packages/client-analytics/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

packages/client-analytics/src/analyticsClient.ts

@@ -100,6 +100,21 @@ export function createAnalyticsClient({
   return {
     transporter,
 
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      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.
      */

packages/client-common/src/createIterablePromise.ts

@@ -1,4 +1,4 @@
-import type { CreateIterablePromise } from './types/CreateIterablePromise';
+import type { CreateIterablePromise } from './types/createIterablePromise';
 
 /**
  * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.

packages/client-common/src/types/Cache.ts renamed to packages/client-common/src/types/cache.ts

@@ -1,4 +1,4 @@
-import type { AlgoliaAgentOptions, TransporterOptions } from './Transporter';
+import type { AlgoliaAgentOptions, TransporterOptions } from './transporter';
 
 export type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
 

packages/client-common/src/types/CreateClient.ts renamed to packages/client-common/src/types/createClient.ts

@@ -1,6 +1,6 @@
-export * from './Cache';
-export * from './CreateClient';
-export * from './CreateIterablePromise';
-export * from './Host';
-export * from './Requester';
-export * from './Transporter';
+export * from './cache';
+export * from './createClient';
+export * from './createIterablePromise';
+export * from './host';
+export * from './requester';
+export * from './transporter';

packages/client-common/src/types/CreateIterablePromise.ts renamed to packages/client-common/src/types/createIterablePromise.ts

@@ -1,4 +1,4 @@
-import type { Headers, QueryParameters } from './Transporter';
+import type { Headers, QueryParameters } from './transporter';
 
 /**
  * The method of the request.

packages/client-common/src/types/Host.ts renamed to packages/client-common/src/types/host.ts

@@ -1,6 +1,6 @@
-import type { Cache } from './Cache';
-import type { Host } from './Host';
-import type { Request, Requester, EndRequest, Response } from './Requester';
+import type { Cache } from './cache';
+import type { Host } from './host';
+import type { Request, Requester, EndRequest, Response } from './requester';
 
 export type Headers = Record<string, string>;
 export type QueryParameters = Record<string, any>;

packages/client-common/src/types/index.ts

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

packages/client-common/src/types/Requester.ts renamed to packages/client-common/src/types/requester.ts

@@ -68,6 +68,21 @@ export function createInsightsClient({
   return {
     transporter,
 
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      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.
      */

packages/client-common/src/types/Transporter.ts renamed to packages/client-common/src/types/transporter.ts

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

packages/client-insights/.openapi-generator-ignore

@@ -73,6 +73,21 @@ export function createPersonalizationClient({
   return {
     transporter,
 
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      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.
      */

packages/client-insights/src/insightsClient.ts

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

packages/client-personalization/.openapi-generator-ignore

@@ -77,6 +77,21 @@ export function createQuerySuggestionsClient({
   return {
     transporter,
 
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      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.
      */

packages/client-personalization/src/personalizationClient.ts

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

packages/client-query-suggestions/.openapi-generator-ignore

@@ -186,6 +186,21 @@ export function createSearchClient({
   return {
     transporter,
 
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      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.
      */