chore: generated code for commit aed20fe. [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: 3 people

clients/algoliasearch-client-javascript/packages/ingestion/model/actionType.ts

@@ -1,3 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * The action to perform on the Algolia index.
+ */
 export type ActionType = 'delete' | 'replace' | 'save';

clients/algoliasearch-client-javascript/packages/ingestion/model/authAPIKey.ts

@@ -1,5 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Authentication input used for token credentials.
+ */
 export type AuthAPIKey = {
   key: string;
 };

clients/algoliasearch-client-javascript/packages/ingestion/model/authAlgolia.ts

@@ -1,7 +1,13 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
 export type AuthAlgolia = {
+  /**
+   * Algolia Application ID.
+   */
   appID: string;
 
+  /**
+   * Algolia API Key, with the correct rights to push to an index and change settings.
+   */
   apiKey: string;
 };

clients/algoliasearch-client-javascript/packages/ingestion/model/authBasic.ts

@@ -1,5 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Authentication input for Basic login with username and password.
+ */
 export type AuthBasic = {
   username: string;
 

clients/algoliasearch-client-javascript/packages/ingestion/model/authGoogleServiceAccount.ts

@@ -1,7 +1,16 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Authentication input to connect to a Google service (e.g. BigQuery).
+ */
 export type AuthGoogleServiceAccount = {
+  /**
+   * Email address of the Service Account.
+   */
   clientEmail: string;
 
+  /**
+   * Private key of the Service Account.
+   */
   privateKey: string;
 };

clients/algoliasearch-client-javascript/packages/ingestion/model/authOAuth.ts

@@ -1,11 +1,21 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Authentication input for OAuth login.
+ */
 export type AuthOAuth = {
+  /**
+   * The OAuth endpoint URL.
+   */
   url: string;
 
+  /**
+   * The clientID.
+   */
   client_id: string;
 
+  /**
+   * The secret.
+   */
   client_secret: string;
-
-  scope?: string;
 };

clients/algoliasearch-client-javascript/packages/ingestion/model/authentication.ts

@@ -3,11 +3,20 @@
 import type { AuthenticationType } from './authenticationType';
 import type { Platform } from './platform';
 
+/**
+ * An authentication is used to login into a Source or a Destination.
+ */
 export type Authentication = {
+  /**
+   * The authentication UUID.
+   */
   authenticationID: string;
 
   type: AuthenticationType;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: string;
 
   platform?: Platform;

clients/algoliasearch-client-javascript/packages/ingestion/model/authenticationCreate.ts

@@ -4,9 +4,15 @@ import type { AuthInput } from './authInput';
 import type { AuthenticationType } from './authenticationType';
 import type { Platform } from './platform';
 
+/**
+ * The payload when creating an authentication.
+ */
 export type AuthenticationCreate = {
   type: AuthenticationType;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: string;
 
   platform?: Platform;

clients/algoliasearch-client-javascript/packages/ingestion/model/authenticationCreateResponse.ts

@@ -1,8 +1,17 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Response from the API when the Authentication is successfully created.
+ */
 export type AuthenticationCreateResponse = {
+  /**
+   * The authentication UUID.
+   */
   authenticationID: string;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: string;
 
   /**

clients/algoliasearch-client-javascript/packages/ingestion/model/authenticationInput.ts

@@ -2,6 +2,9 @@
 
 import type { AuthInput } from './authInput';
 
+/**
+ * The authentication input property stores the (encrypted) credentials.
+ */
 export type AuthenticationInput = {
   input: AuthInput;
 };

clients/algoliasearch-client-javascript/packages/ingestion/model/authenticationSearch.ts

@@ -1,5 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Payload to search for multiple authentications, based on the given `authenticationIDs`.
+ */
 export type AuthenticationSearch = {
   authenticationIDs: string[];
 };

clients/algoliasearch-client-javascript/packages/ingestion/model/authenticationType.ts

@@ -1,5 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Type of the Authentication, defines what kind of object is stored in the input.
+ */
 export type AuthenticationType =
   | 'algolia'
   | 'apiKey'

clients/algoliasearch-client-javascript/packages/ingestion/model/authenticationUpdate.ts

@@ -4,9 +4,15 @@ import type { AuthInput } from './authInput';
 import type { AuthenticationType } from './authenticationType';
 import type { Platform } from './platform';
 
+/**
+ * Payload to partialy update an Authentication.
+ */
 export type AuthenticationUpdate = {
   type?: AuthenticationType;
 
+  /**
+   * An human readable name describing the object.
+   */
   name?: string;
 
   platform?: Platform;

clients/algoliasearch-client-javascript/packages/ingestion/model/authenticationUpdateResponse.ts

@@ -1,8 +1,17 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * Response from the API when the Authentication is successfully updated.
+ */
 export type AuthenticationUpdateResponse = {
+  /**
+   * The authentication UUID.
+   */
   authenticationID: string;
 
+  /**
+   * An human readable name describing the object.
+   */
   name: string;
 
   /**