fix task id response (generated)

Co-authored-by: Ben Kalmus <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-javascript/packages/client-composition/model/clientMethodProps.ts

@@ -1,5 +1,7 @@
 // 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 { Composition } from '../model/composition';
+import type { CompositionRule } from '../model/compositionRule';
 import type { CompositionRulesBatchParams } from '../model/compositionRulesBatchParams';
 
 import type { RequestBody } from '../model/requestBody';
@@ -72,6 +74,30 @@ export type CustomPutProps = {
   body?: Record<string, unknown> | undefined;
 };
 
+/**
+ * Properties for the `deleteComposition` method.
+ */
+export type DeleteCompositionProps = {
+  /**
+   * Unique Composition ObjectID.
+   */
+  compositionID: string;
+};
+
+/**
+ * Properties for the `deleteCompositionRule` method.
+ */
+export type DeleteCompositionRuleProps = {
+  /**
+   * Unique Composition ObjectID.
+   */
+  compositionID: string;
+  /**
+   * Unique identifier of a rule object.
+   */
+  objectID: string;
+};
+
 /**
  * Properties for the `getComposition` method.
  */
@@ -124,6 +150,32 @@ export type ListCompositionsProps = {
   hitsPerPage?: number | undefined;
 };
 
+/**
+ * Properties for the `putComposition` method.
+ */
+export type PutCompositionProps = {
+  /**
+   * Unique Composition ObjectID.
+   */
+  compositionID: string;
+  composition: Composition;
+};
+
+/**
+ * Properties for the `putCompositionRule` method.
+ */
+export type PutCompositionRuleProps = {
+  /**
+   * Unique Composition ObjectID.
+   */
+  compositionID: string;
+  /**
+   * Unique identifier of a rule object.
+   */
+  objectID: string;
+  compositionRule: CompositionRule;
+};
+
 /**
  * Properties for the `saveRules` method.
  */

clients/algoliasearch-client-javascript/packages/client-composition/model/index.ts

@@ -101,6 +101,7 @@ export * from './snippetResult';
 export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './supportedLanguage';
+export * from './taskIDResponse';
 export * from './taskStatus';
 export * from './timeRange';
 export * from './typoTolerance';

clients/algoliasearch-client-javascript/packages/client-composition/model/taskIDResponse.ts

@@ -0,0 +1,8 @@
+// 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 TaskIDResponse = {
+  /**
+   * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+   */
+  taskID: number;
+};

clients/algoliasearch-client-javascript/packages/client-composition/src/compositionClient.ts

@@ -24,16 +24,21 @@ import type { SearchCompositionRulesResponse } from '../model/searchCompositionR
 
 import type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';
 import type { SearchResponse } from '../model/searchResponse';
+import type { TaskIDResponse } from '../model/taskIDResponse';
 
 import type {
   CustomDeleteProps,
   CustomGetProps,
   CustomPostProps,
   CustomPutProps,
+  DeleteCompositionProps,
+  DeleteCompositionRuleProps,
   GetCompositionProps,
   GetRuleProps,
   GetTaskProps,
   ListCompositionsProps,
+  PutCompositionProps,
+  PutCompositionRuleProps,
   SaveRulesProps,
   SearchCompositionRulesProps,
   SearchForFacetValuesProps,
@@ -307,6 +312,80 @@ export function createCompositionClient({
       return transporter.request(request, requestOptions);
     },
 
+    /**
+     * Delete a composition from the current Algolia application.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     *  - settings
+     * @param deleteComposition - The deleteComposition object.
+     * @param deleteComposition.compositionID - Unique Composition ObjectID.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteComposition(
+      { compositionID }: DeleteCompositionProps,
+      requestOptions?: RequestOptions,
+    ): Promise<TaskIDResponse> {
+      if (!compositionID) {
+        throw new Error('Parameter `compositionID` is required when calling `deleteComposition`.');
+      }
+
+      const requestPath = '/1/compositions/{compositionID}'.replace(
+        '{compositionID}',
+        encodeURIComponent(compositionID),
+      );
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'DELETE',
+        path: requestPath,
+        queryParameters,
+        headers,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
+    /**
+     * Delete a Composition Rule from the specified Composition ID.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     *  - settings
+     * @param deleteCompositionRule - The deleteCompositionRule object.
+     * @param deleteCompositionRule.compositionID - Unique Composition ObjectID.
+     * @param deleteCompositionRule.objectID - Unique identifier of a rule object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteCompositionRule(
+      { compositionID, objectID }: DeleteCompositionRuleProps,
+      requestOptions?: RequestOptions,
+    ): Promise<TaskIDResponse> {
+      if (!compositionID) {
+        throw new Error('Parameter `compositionID` is required when calling `deleteCompositionRule`.');
+      }
+
+      if (!objectID) {
+        throw new Error('Parameter `objectID` is required when calling `deleteCompositionRule`.');
+      }
+
+      const requestPath = '/1/compositions/{compositionID}/rules/{objectID}'
+        .replace('{compositionID}', encodeURIComponent(compositionID))
+        .replace('{objectID}', encodeURIComponent(objectID));
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'DELETE',
+        path: requestPath,
+        queryParameters,
+        headers,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
     /**
      * Retrieve a single composition in the current Algolia application.
      *
@@ -482,6 +561,112 @@ export function createCompositionClient({
       return transporter.request(request, requestOptions);
     },
 
+    /**
+     * Upsert a composition in the current Algolia application.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     *  - settings
+     * @param putComposition - The putComposition object.
+     * @param putComposition.compositionID - Unique Composition ObjectID.
+     * @param putComposition.composition - The composition object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    putComposition(
+      { compositionID, composition }: PutCompositionProps,
+      requestOptions?: RequestOptions,
+    ): Promise<TaskIDResponse> {
+      if (!compositionID) {
+        throw new Error('Parameter `compositionID` is required when calling `putComposition`.');
+      }
+
+      if (!composition) {
+        throw new Error('Parameter `composition` is required when calling `putComposition`.');
+      }
+
+      if (!composition.objectID) {
+        throw new Error('Parameter `composition.objectID` is required when calling `putComposition`.');
+      }
+      if (!composition.name) {
+        throw new Error('Parameter `composition.name` is required when calling `putComposition`.');
+      }
+      if (!composition.behavior) {
+        throw new Error('Parameter `composition.behavior` is required when calling `putComposition`.');
+      }
+
+      const requestPath = '/1/compositions/{compositionID}'.replace(
+        '{compositionID}',
+        encodeURIComponent(compositionID),
+      );
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'PUT',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: composition,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
+    /**
+     * Upsert a Composition Rule for the specified composition ID.
+     *
+     * Required API Key ACLs:
+     *  - editSettings
+     *  - settings
+     * @param putCompositionRule - The putCompositionRule object.
+     * @param putCompositionRule.compositionID - Unique Composition ObjectID.
+     * @param putCompositionRule.objectID - Unique identifier of a rule object.
+     * @param putCompositionRule.compositionRule - The compositionRule object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    putCompositionRule(
+      { compositionID, objectID, compositionRule }: PutCompositionRuleProps,
+      requestOptions?: RequestOptions,
+    ): Promise<TaskIDResponse> {
+      if (!compositionID) {
+        throw new Error('Parameter `compositionID` is required when calling `putCompositionRule`.');
+      }
+
+      if (!objectID) {
+        throw new Error('Parameter `objectID` is required when calling `putCompositionRule`.');
+      }
+
+      if (!compositionRule) {
+        throw new Error('Parameter `compositionRule` is required when calling `putCompositionRule`.');
+      }
+
+      if (!compositionRule.objectID) {
+        throw new Error('Parameter `compositionRule.objectID` is required when calling `putCompositionRule`.');
+      }
+      if (!compositionRule.conditions) {
+        throw new Error('Parameter `compositionRule.conditions` is required when calling `putCompositionRule`.');
+      }
+      if (!compositionRule.consequence) {
+        throw new Error('Parameter `compositionRule.consequence` is required when calling `putCompositionRule`.');
+      }
+
+      const requestPath = '/1/compositions/{compositionID}/rules/{objectID}'
+        .replace('{compositionID}', encodeURIComponent(compositionID))
+        .replace('{objectID}', encodeURIComponent(objectID));
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'PUT',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: compositionRule,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
     /**
      * Create or update or delete multiple composition rules.
      *

docs/bundled/composition-full-snippets.json

@@ -33,6 +33,12 @@
       "allow put method for a custom path with minimal parameters": "const response = await client.customPut({ path: 'test/minimal' });",
       "allow put method for a custom path with all parameters": "const response = await client.customPut({\n  path: 'test/all',\n  parameters: { query: 'parameters' },\n  body: { body: 'parameters' },\n});"
     },
+    "deleteComposition": {
+      "default": "const response = await client.deleteComposition({ compositionID: '1234' });"
+    },
+    "deleteCompositionRule": {
+      "default": "const response = await client.deleteCompositionRule({ compositionID: '1234', objectID: '5678' });"
+    },
     "getComposition": {
       "default": "const response = await client.getComposition({ compositionID: 'foo' });"
     },
@@ -48,6 +54,12 @@
     "multipleBatch": {
       "default": "const response = await client.multipleBatch({\n  requests: [\n    {\n      action: 'upsert',\n      body: {\n        objectID: 'foo',\n        name: 'my first composition',\n        behavior: { injection: { main: { source: { search: { index: 'bar' } } }, injectedItems: [] } },\n      },\n    },\n    { action: 'delete', body: { objectID: 'baz' } },\n  ],\n});"
     },
+    "putComposition": {
+      "default": "const response = await client.putComposition({\n  compositionID: '1234',\n  composition: {\n    objectID: '1234',\n    name: 'my first composition',\n    behavior: {\n      injection: {\n        main: { source: { search: { index: 'foo' } } },\n        injectedItems: [{ key: 'injectedItem1', source: { search: { index: 'foo' } }, position: 2, length: 1 }],\n      },\n    },\n  },\n});"
+    },
+    "putCompositionRule": {
+      "default": "const response = await client.putCompositionRule({\n  compositionID: '1234',\n  objectID: '5678',\n  compositionRule: {\n    objectID: '5678',\n    conditions: [{ anchoring: 'is', pattern: 'test' }],\n    consequence: {\n      behavior: {\n        injection: {\n          main: { source: { search: { index: 'foo' } } },\n          injectedItems: [{ key: 'injectedItem1', source: { search: { index: 'foo' } }, position: 2, length: 1 }],\n        },\n      },\n    },\n  },\n});"
+    },
     "saveRules": {
       "default": "const response = await client.saveRules({\n  compositionID: 'foo',\n  rules: {\n    requests: [\n      {\n        action: 'upsert',\n        body: {\n          objectID: '123',\n          conditions: [{ pattern: 'a' }],\n          consequence: { behavior: { injection: { main: { source: { search: { index: '<YOUR_INDEX_NAME>' } } } } } },\n        },\n      },\n    ],\n  },\n});"
     },