chore: generated code for commit 193fb73d. [skip ci]

algolia-bot · shortcuts · algolia-bot · commit ec56890a0571 · 2022-08-03T14:24:13.000Z
algolia/api-clients-automation@193fb73 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
diff --git a/packages/algoliasearch/lite/model/acl.ts b/packages/algoliasearch/lite/model/acl.ts
@@ -1,5 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * List of rights for the API key. The following rights can be used:  addObject: allows to add/update an object in the index (copy/move index are also allowed with this right). Analytics: allows to retrieve the analytics through the Analytics API. Browse: allows to retrieve all index content via the browse API. DeleteIndex: allows to delete or clear index content. DeleteObject: allows to delete objects from the index. EditSettings: allows to change index settings. ListIndexes: allows to list all accessible indices. Logs: allows to get the logs. Recommendation: Allows usage of the Personalization dashboard and the Recommendation API. Search: allows to search the index. SeeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records. Settings: allows to get index settings.
+ */
 export type Acl =
   | 'addObject'
   | 'analytics'
diff --git a/packages/algoliasearch/lite/model/addApiKeyResponse.ts b/packages/algoliasearch/lite/model/addApiKeyResponse.ts
@@ -2,7 +2,7 @@
 
 export type AddApiKeyResponse = {
   /**
-   * Key string.
+   * The API key.
    */
   key: string;
 
diff --git a/packages/algoliasearch/lite/model/attributeToUpdate.ts b/packages/algoliasearch/lite/model/attributeToUpdate.ts
@@ -2,4 +2,4 @@
 
 import type { BuiltInOperation } from './builtInOperation';
 
-export type AttributeOrBuiltInOperation = BuiltInOperation | string;
+export type AttributeToUpdate = BuiltInOperation | string;
diff --git a/packages/algoliasearch/lite/model/baseGetApiKeyResponse.ts b/packages/algoliasearch/lite/model/baseGetApiKeyResponse.ts
@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type BaseGetApiKeyResponse = {
+  /**
+   * The API key.
+   */
+  value?: string;
+
+  /**
+   * Time of the event expressed in milliseconds since the Unix epoch.
+   */
+  createdAt: number;
+};
diff --git a/packages/algoliasearch/lite/model/createdAtObject.ts b/packages/algoliasearch/lite/model/createdAtObject.ts
diff --git a/packages/algoliasearch/lite/model/getApiKeyResponse.ts b/packages/algoliasearch/lite/model/getApiKeyResponse.ts
@@ -1,6 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
 import type { ApiKey } from './apiKey';
-import type { CreatedAtObject } from './createdAtObject';
+import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
 
-export type Key = ApiKey & CreatedAtObject;
+export type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
diff --git a/packages/algoliasearch/lite/model/index.ts b/packages/algoliasearch/lite/model/index.ts
@@ -9,10 +9,11 @@ export * from './anchoring';
 export * from './apiKey';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
-export * from './attributeOrBuiltInOperation';
+export * from './attributeToUpdate';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
 export * from './baseBrowseResponse';
+export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
@@ -26,7 +27,6 @@ export * from './consequenceHide';
 export * from './consequenceParams';
 export * from './consequenceQuery';
 export * from './consequenceQueryObject';
-export * from './createdAtObject';
 export * from './dictionaryAction';
 export * from './dictionaryEntry';
 export * from './dictionaryEntryState';
@@ -42,13 +42,13 @@ export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
 export * from './fetchedIndex';
+export * from './getApiKeyResponse';
 export * from './highlightResult';
 export * from './highlightResultOption';
 export * from './hit';
 export * from './ignorePlurals';
 export * from './indexSettings';
 export * from './indexSettingsAsSearchParams';
-export * from './key';
 export * from './languages';
 export * from './listIndicesResponse';
 export * from './logType';
diff --git a/packages/client-search/model/acl.ts b/packages/client-search/model/acl.ts
@@ -1,5 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
+/**
+ * List of rights for the API key. The following rights can be used:  addObject: allows to add/update an object in the index (copy/move index are also allowed with this right). Analytics: allows to retrieve the analytics through the Analytics API. Browse: allows to retrieve all index content via the browse API. DeleteIndex: allows to delete or clear index content. DeleteObject: allows to delete objects from the index. EditSettings: allows to change index settings. ListIndexes: allows to list all accessible indices. Logs: allows to get the logs. Recommendation: Allows usage of the Personalization dashboard and the Recommendation API. Search: allows to search the index. SeeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records. Settings: allows to get index settings.
+ */
 export type Acl =
   | 'addObject'
   | 'analytics'
diff --git a/packages/client-search/model/addApiKeyResponse.ts b/packages/client-search/model/addApiKeyResponse.ts
@@ -2,7 +2,7 @@
 
 export type AddApiKeyResponse = {
   /**
-   * Key string.
+   * The API key.
    */
   key: string;
 
diff --git a/packages/client-search/model/attributeToUpdate.ts b/packages/client-search/model/attributeToUpdate.ts
@@ -2,4 +2,4 @@
 
 import type { BuiltInOperation } from './builtInOperation';
 
-export type AttributeOrBuiltInOperation = BuiltInOperation | string;
+export type AttributeToUpdate = BuiltInOperation | string;
diff --git a/packages/client-search/model/baseGetApiKeyResponse.ts b/packages/client-search/model/baseGetApiKeyResponse.ts
@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type BaseGetApiKeyResponse = {
+  /**
+   * The API key.
+   */
+  value?: string;
+
+  /**
+   * Time of the event expressed in milliseconds since the Unix epoch.
+   */
+  createdAt: number;
+};
diff --git a/packages/client-search/model/batchParams.ts b/packages/client-search/model/batchParams.ts
@@ -6,5 +6,5 @@ import type { MultipleBatchRequest } from './multipleBatchRequest';
  * The `multipleBatch` parameters.
  */
 export type BatchParams = {
-  requests?: MultipleBatchRequest[];
+  requests: MultipleBatchRequest[];
 };
diff --git a/packages/client-search/model/clientMethodProps.ts b/packages/client-search/model/clientMethodProps.ts
@@ -4,15 +4,15 @@ import type { CreateIterablePromise } from '@algolia/client-common';
 
 import type { ApiKey } from './apiKey';
 import type { AssignUserIdParams } from './assignUserIdParams';
-import type { AttributeOrBuiltInOperation } from './attributeOrBuiltInOperation';
+import type { AttributeToUpdate } from './attributeToUpdate';
 import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
 import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
 import type { BatchWriteParams } from './batchWriteParams';
 import type { BrowseRequest } from './browseRequest';
 import type { DictionaryType } from './dictionaryType';
+import type { GetApiKeyResponse } from './getApiKeyResponse';
 import type { GetTaskResponse } from './getTaskResponse';
 import type { IndexSettings } from './indexSettings';
-import type { Key } from './key';
 import type { LogType } from './logType';
 import type { OperationIndexParams } from './operationIndexParams';
 import type { Rule } from './rule';
@@ -430,9 +430,7 @@ export type PartialUpdateObjectProps = {
   /**
    * List of attributes to update.
    */
-  attributeOrBuiltInOperation: Array<
-    Record<string, AttributeOrBuiltInOperation>
-  >;
+  attributeToUpdate: Array<Record<string, AttributeToUpdate>>;
   /**
    * Creates the record if it does not exist yet.
    */
@@ -761,7 +759,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<Key> & {
+export type WaitForApiKeyOptions = WaitForOptions<GetApiKeyResponse> & {
   /**
    * The API Key.
    */
diff --git a/packages/client-search/model/createdAtObject.ts b/packages/client-search/model/createdAtObject.ts
diff --git a/packages/client-search/model/getApiKeyResponse.ts b/packages/client-search/model/getApiKeyResponse.ts
@@ -1,6 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
 import type { ApiKey } from './apiKey';
-import type { CreatedAtObject } from './createdAtObject';
+import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
 
-export type Key = ApiKey & CreatedAtObject;
+export type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
diff --git a/packages/client-search/model/getObjectsParams.ts b/packages/client-search/model/getObjectsParams.ts
@@ -6,5 +6,5 @@ import type { GetObjectsRequest } from './getObjectsRequest';
  * The `getObjects` parameters.
  */
 export type GetObjectsParams = {
-  requests?: GetObjectsRequest[];
+  requests: GetObjectsRequest[];
 };
diff --git a/packages/client-search/model/index.ts b/packages/client-search/model/index.ts
@@ -10,10 +10,11 @@ export * from './apiKey';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './assignUserIdParams';
-export * from './attributeOrBuiltInOperation';
+export * from './attributeToUpdate';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
 export * from './baseBrowseResponse';
+export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
@@ -35,7 +36,6 @@ export * from './consequenceHide';
 export * from './consequenceParams';
 export * from './consequenceQuery';
 export * from './consequenceQueryObject';
-export * from './createdAtObject';
 export * from './createdAtResponse';
 export * from './deleteApiKeyResponse';
 export * from './deleteSourceResponse';
@@ -57,6 +57,7 @@ export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
 export * from './fetchedIndex';
+export * from './getApiKeyResponse';
 export * from './getDictionarySettingsResponse';
 export * from './getLogsResponse';
 export * from './getObjectsParams';
@@ -71,7 +72,6 @@ export * from './hit';
 export * from './ignorePlurals';
 export * from './indexSettings';
 export * from './indexSettingsAsSearchParams';
-export * from './key';
 export * from './languages';
 export * from './listApiKeysResponse';
 export * from './listClustersResponse';
diff --git a/packages/client-search/model/listApiKeysResponse.ts b/packages/client-search/model/listApiKeysResponse.ts
@@ -1,10 +1,10 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { Key } from './key';
+import type { GetApiKeyResponse } from './getApiKeyResponse';
 
 export type ListApiKeysResponse = {
   /**
    * List of api keys.
    */
-  keys: Key[];
+  keys: GetApiKeyResponse[];
 };
diff --git a/packages/client-search/model/multipleBatchRequest.ts b/packages/client-search/model/multipleBatchRequest.ts
@@ -3,15 +3,15 @@
 import type { Action } from './action';
 
 export type MultipleBatchRequest = {
-  action?: Action;
+  action: Action;
 
   /**
    * Arguments to the operation (depends on the type of the operation).
    */
-  body?: Record<string, any>;
+  body: Record<string, any>;
 
   /**
    * Index to target for this operation.
    */
-  indexName?: string;
+  indexName: string;
 };
diff --git a/packages/client-search/model/multipleBatchResponse.ts b/packages/client-search/model/multipleBatchResponse.ts
@@ -4,10 +4,10 @@ export type MultipleBatchResponse = {
   /**
    * List of tasksIDs per index.
    */
-  taskID?: Record<string, any>;
+  taskID: Record<string, number>;
 
   /**
    * List of objectID.
    */
-  objectIDs?: string[];
+  objectIDs: string[];
 };
diff --git a/packages/client-search/model/updateApiKeyResponse.ts b/packages/client-search/model/updateApiKeyResponse.ts
@@ -2,7 +2,7 @@
 
 export type UpdateApiKeyResponse = {
   /**
-   * Key string.
+   * The API key.
    */
   key: string;
 
diff --git a/packages/client-search/src/searchClient.ts b/packages/client-search/src/searchClient.ts

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	`import type { BuiltInOperation } from './builtInOperation';`
`4`	`4`
`5`		`-export type AttributeOrBuiltInOperation = BuiltInOperation \| string;`
	`5`	`+export type AttributeToUpdate = BuiltInOperation \| string;`