feat(specs): add with transformation helpers (generated)

algolia/api-clients-automation#4931

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

Author: algolia-bot

packages/algoliasearch/builds/browser.ts

@@ -50,9 +50,9 @@ export type Algoliasearch = SearchClient & {
   // Bridge helpers to expose along with the search endpoints at the root of the API client
 
   /**
-   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
-   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
+   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param saveObjects - The `saveObjects` object.
    * @param saveObjects.indexName - The `indexName` to save `objects` in.
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
@@ -66,7 +66,7 @@ export type Algoliasearch = SearchClient & {
   ) => Promise<WatchResponse>;
 
   /**
-   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
    * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param partialUpdateObjects - The `partialUpdateObjects` object.

packages/algoliasearch/builds/fetch.ts

@@ -50,9 +50,9 @@ export type Algoliasearch = SearchClient & {
   // Bridge helpers to expose along with the search endpoints at the root of the API client
 
   /**
-   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
-   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
+   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param saveObjects - The `saveObjects` object.
    * @param saveObjects.indexName - The `indexName` to save `objects` in.
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
@@ -66,7 +66,7 @@ export type Algoliasearch = SearchClient & {
   ) => Promise<WatchResponse>;
 
   /**
-   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
    * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param partialUpdateObjects - The `partialUpdateObjects` object.

packages/algoliasearch/builds/models.ts

@@ -113,6 +113,7 @@ import type {
   Widgets,
 } from '@algolia/client-search';
 import { apiClientVersion } from '@algolia/client-search';
+import type { Event, EventStatus, WatchResponse } from '@algolia/ingestion';
 
 export * from '@algolia/client-abtesting';
 export * from '@algolia/client-analytics';
@@ -191,6 +192,8 @@ export type {
   Edit,
   EditType,
   ErrorBase,
+  Event,
+  EventStatus,
   ExactOnSingleWordQuery,
   Exhaustive,
   FacetFilters,
@@ -249,6 +252,7 @@ export type {
   TypoTolerance,
   TypoToleranceEnum,
   Value,
+  WatchResponse,
   Widgets,
 };
 

packages/algoliasearch/builds/node.ts

@@ -50,9 +50,9 @@ export type Algoliasearch = SearchClient & {
   // Bridge helpers to expose along with the search endpoints at the root of the API client
 
   /**
-   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
-   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
+   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param saveObjects - The `saveObjects` object.
    * @param saveObjects.indexName - The `indexName` to save `objects` in.
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
@@ -66,7 +66,7 @@ export type Algoliasearch = SearchClient & {
   ) => Promise<WatchResponse>;
 
   /**
-   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
    * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param partialUpdateObjects - The `partialUpdateObjects` object.

packages/algoliasearch/builds/worker.ts

@@ -50,9 +50,9 @@ export type Algoliasearch = SearchClient & {
   // Bridge helpers to expose along with the search endpoints at the root of the API client
 
   /**
-   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
-   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
+   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param saveObjects - The `saveObjects` object.
    * @param saveObjects.indexName - The `indexName` to save `objects` in.
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
@@ -66,7 +66,7 @@ export type Algoliasearch = SearchClient & {
   ) => Promise<WatchResponse>;
 
   /**
-   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
    * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param partialUpdateObjects - The `partialUpdateObjects` object.

packages/client-search/model/event.ts

@@ -0,0 +1,35 @@
+// 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 { EventStatus } from './eventStatus';
+import type { EventType } from './eventType';
+
+/**
+ * An event describe a step of the task execution flow..
+ */
+export type Event = {
+  /**
+   * Universally unique identifier (UUID) of an event.
+   */
+  eventID: string;
+
+  /**
+   * Universally unique identifier (UUID) of a task run.
+   */
+  runID: string;
+
+  status: EventStatus | null;
+
+  type: EventType;
+
+  /**
+   * The extracted record batch size.
+   */
+  batchSize: number;
+
+  data?: { [key: string]: any } | null;
+
+  /**
+   * Date of publish RFC 3339 format.
+   */
+  publishedAt: string;
+};

packages/client-search/model/eventStatus.ts

@@ -0,0 +1,3 @@
+// 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 EventStatus = 'created' | 'started' | 'retried' | 'failed' | 'succeeded' | 'critical';

packages/client-search/model/eventType.ts

@@ -0,0 +1,3 @@
+// 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 EventType = 'fetch' | 'record' | 'log' | 'transform';

packages/client-search/model/index.ts

@@ -63,6 +63,9 @@ export * from './distinct';
 export * from './edit';
 export * from './editType';
 export * from './errorBase';
+export * from './event';
+export * from './eventStatus';
+export * from './eventType';
 export * from './exactOnSingleWordQuery';
 export * from './exhaustive';
 export * from './facetFilters';
@@ -179,5 +182,6 @@ export * from './userHighlightResult';
 export * from './userHit';
 export * from './userId';
 export * from './value';
+export * from './watchResponse';
 export * from './widgets';
 export * from './withPrimary';

packages/client-search/model/watchResponse.ts

@@ -0,0 +1,35 @@
+// 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 { Event } from './event';
+
+export type WatchResponse = {
+  /**
+   * Universally unique identifier (UUID) of a task run.
+   */
+  runID: string;
+
+  /**
+   * Universally unique identifier (UUID) of an event.
+   */
+  eventID?: string;
+
+  /**
+   * This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
+   */
+  data?: Array<Record<string, unknown>>;
+
+  /**
+   * in case of error, observability events will be added to the response.
+   */
+  events?: Array<Event>;
+
+  /**
+   * a message describing the outcome of the operation that has been ran (push, discover or validate) run.
+   */
+  message?: string;
+
+  /**
+   * Date of creation in RFC 3339 format.
+   */
+  createdAt?: string;
+};