chore: generated code for commit 0076edc. [skip ci]

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

Author: algolia-bot

clients/algoliasearch-client-javascript/packages/predict/builds/browser.ts

@@ -0,0 +1,68 @@
+import type { InitClientOptions } from '@algolia/client-common';
+import {
+  DEFAULT_CONNECT_TIMEOUT_BROWSER,
+  DEFAULT_READ_TIMEOUT_BROWSER,
+  DEFAULT_WRITE_TIMEOUT_BROWSER,
+  createMemoryCache,
+  createFallbackableCache,
+  createBrowserLocalStorageCache,
+} from '@algolia/client-common';
+import { createXhrRequester } from '@algolia/requester-browser-xhr';
+
+import type { PredictClient, Region } from '../src/predictClient';
+import {
+  createPredictClient,
+  apiClientVersion,
+  REGIONS,
+} from '../src/predictClient';
+
+export { apiClientVersion, PredictClient } from '../src/predictClient';
+export * from '../model';
+
+export function predictClient(
+  appId: string,
+  apiKey: string,
+  region: Region,
+  options?: InitClientOptions
+): PredictClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  if (!region) {
+    throw new Error('`region` is missing.');
+  }
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
+    throw new Error(
+      `\`region\` must be one of the following: ${REGIONS.join(', ')}`
+    );
+  }
+
+  return createPredictClient({
+    appId,
+    apiKey,
+    region,
+    timeouts: {
+      connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
+      read: DEFAULT_READ_TIMEOUT_BROWSER,
+      write: DEFAULT_WRITE_TIMEOUT_BROWSER,
+    },
+    requester: createXhrRequester(),
+    algoliaAgents: [{ segment: 'Browser' }],
+    authMode: 'WithinQueryParameters',
+    responsesCache: createMemoryCache(),
+    requestsCache: createMemoryCache({ serializable: false }),
+    hostsCache: createFallbackableCache({
+      caches: [
+        createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }),
+        createMemoryCache(),
+      ],
+    }),
+    ...options,
+  });
+}

clients/algoliasearch-client-javascript/packages/predict/builds/node.ts

@@ -0,0 +1,57 @@
+import type { InitClientOptions } from '@algolia/client-common';
+import {
+  DEFAULT_CONNECT_TIMEOUT_NODE,
+  DEFAULT_READ_TIMEOUT_NODE,
+  DEFAULT_WRITE_TIMEOUT_NODE,
+  createMemoryCache,
+  createNullCache,
+} from '@algolia/client-common';
+import { createHttpRequester } from '@algolia/requester-node-http';
+
+import type { PredictClient, Region } from '../src/predictClient';
+import { createPredictClient, REGIONS } from '../src/predictClient';
+
+export { apiClientVersion, PredictClient } from '../src/predictClient';
+export * from '../model';
+
+export function predictClient(
+  appId: string,
+  apiKey: string,
+  region: Region,
+  options?: InitClientOptions
+): PredictClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  if (!region) {
+    throw new Error('`region` is missing.');
+  }
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
+    throw new Error(
+      `\`region\` must be one of the following: ${REGIONS.join(', ')}`
+    );
+  }
+
+  return createPredictClient({
+    appId,
+    apiKey,
+    region,
+    timeouts: {
+      connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+      read: DEFAULT_READ_TIMEOUT_NODE,
+      write: DEFAULT_WRITE_TIMEOUT_NODE,
+    },
+    requester: createHttpRequester(),
+    algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+    responsesCache: createNullCache(),
+    requestsCache: createNullCache(),
+    hostsCache: createMemoryCache(),
+    ...options,
+  });
+}

clients/algoliasearch-client-javascript/packages/predict/index.d.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-unresolved
+export * from './dist/builds/node';

clients/algoliasearch-client-javascript/packages/predict/index.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-commonjs,import/extensions
+module.exports = require('./dist/predict.cjs.js');

clients/algoliasearch-client-javascript/packages/predict/model/affinities.ts

@@ -0,0 +1,5 @@
+export type Affinities = {
+  name?: string;
+  value?: string;
+  probability?: number;
+};

clients/algoliasearch-client-javascript/packages/predict/model/allParams.ts

@@ -0,0 +1,4 @@
+import type { ModelsToRetrieve } from './modelsToRetrieve';
+import type { TypesToRetrieve } from './typesToRetrieve';
+
+export type AllParams = ModelsToRetrieve & TypesToRetrieve;

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

@@ -0,0 +1,76 @@
+import type { Params } from './params';
+
+/**
+ * Properties for the `del` method.
+ */
+export type DelProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `fetchUserProfile` method.
+ */
+export type FetchUserProfileProps = {
+  /**
+   * User ID for authenticated users or cookie ID for non-authenticated repeated users (visitors).
+   */
+  userID: string;
+  params: Params;
+};
+
+/**
+ * Properties for the `get` method.
+ */
+export type GetProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `put` method.
+ */
+export type PutProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};

clients/algoliasearch-client-javascript/packages/predict/model/errorBase.ts

@@ -0,0 +1,6 @@
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

clients/algoliasearch-client-javascript/packages/predict/model/fetchUserProfileResponse.ts

@@ -0,0 +1,10 @@
+import type { Predictions } from './predictions';
+import type { Properties } from './properties';
+import type { Segments } from './segments';
+
+export type FetchUserProfileResponse = {
+  user: string;
+  predictions?: Predictions;
+  properties?: Properties;
+  segments?: Segments;
+};

clients/algoliasearch-client-javascript/packages/predict/model/funnelStage.ts

@@ -0,0 +1,4 @@
+export type FunnelStage = {
+  name?: string;
+  probability?: number;
+};

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

@@ -0,0 +1,17 @@
+export * from './affinities';
+export * from './allParams';
+export * from './errorBase';
+export * from './fetchUserProfileResponse';
+export * from './funnelStage';
+export * from './modelsToRetrieve';
+export * from './modelsToRetrieveEnum';
+export * from './params';
+export * from './predictions';
+export * from './predictionsAffinities';
+export * from './predictionsFunnelStage';
+export * from './predictionsOrderValue';
+export * from './properties';
+export * from './segments';
+export * from './typesToRetrieve';
+export * from './typesToRetrieveEnum';
+export * from './clientMethodProps';

clients/algoliasearch-client-javascript/packages/predict/model/modelsToRetrieve.ts

@@ -0,0 +1,5 @@
+import type { ModelsToRetrieveEnum } from './modelsToRetrieveEnum';
+
+export type ModelsToRetrieve = {
+  modelsToRetrieve: ModelsToRetrieveEnum[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/modelsToRetrieveEnum.ts

@@ -0,0 +1,4 @@
+export type ModelsToRetrieveEnum =
+  | 'affinities'
+  | 'funnel_stage'
+  | 'order_value';

clients/algoliasearch-client-javascript/packages/predict/model/params.ts

@@ -0,0 +1,5 @@
+import type { AllParams } from './allParams';
+import type { ModelsToRetrieve } from './modelsToRetrieve';
+import type { TypesToRetrieve } from './typesToRetrieve';
+
+export type Params = AllParams | ModelsToRetrieve | TypesToRetrieve;

clients/algoliasearch-client-javascript/packages/predict/model/predictions.ts

@@ -0,0 +1,9 @@
+import type { PredictionsAffinities } from './predictionsAffinities';
+import type { PredictionsFunnelStage } from './predictionsFunnelStage';
+import type { PredictionsOrderValue } from './predictionsOrderValue';
+
+export type Predictions = {
+  funnel_stage?: PredictionsFunnelStage;
+  order_value?: PredictionsOrderValue;
+  affinities?: PredictionsAffinities;
+};

clients/algoliasearch-client-javascript/packages/predict/model/predictionsAffinities.ts

@@ -0,0 +1,9 @@
+import type { Affinities } from './affinities';
+
+/**
+ * Prediction for the **affinities** model.
+ */
+export type PredictionsAffinities = {
+  value?: Affinities[];
+  lastUpdatedAt?: string;
+};

clients/algoliasearch-client-javascript/packages/predict/model/predictionsFunnelStage.ts

@@ -0,0 +1,9 @@
+import type { FunnelStage } from './funnelStage';
+
+/**
+ * Prediction for the **funnel_stage** model.
+ */
+export type PredictionsFunnelStage = {
+  value?: FunnelStage[];
+  lastUpdatedAt?: string;
+};

clients/algoliasearch-client-javascript/packages/predict/model/predictionsOrderValue.ts

@@ -0,0 +1,7 @@
+/**
+ * Prediction for the **order_value** model.
+ */
+export type PredictionsOrderValue = {
+  value?: number;
+  lastUpdatedAt?: string;
+};

clients/algoliasearch-client-javascript/packages/predict/model/properties.ts

@@ -0,0 +1,17 @@
+/**
+ * Properties for the user profile.
+ */
+export type Properties = {
+  /**
+   * Raw user properties (key-value pairs).
+   */
+  raw?: Record<string, any>;
+  /**
+   * Computed user properties (key-value pairs).
+   */
+  computed?: Record<string, any>;
+  /**
+   * Custom user properties (key-value pairs).
+   */
+  custom?: Record<string, any>;
+};

clients/algoliasearch-client-javascript/packages/predict/model/segments.ts

@@ -0,0 +1,13 @@
+/**
+ * Segments that the user belongs to.
+ */
+export type Segments = {
+  /**
+   * List of computed segments IDs.
+   */
+  computed?: string[];
+  /**
+   * List of custom segments IDs.
+   */
+  custom?: string[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/typesToRetrieve.ts

@@ -0,0 +1,5 @@
+import type { TypesToRetrieveEnum } from './typesToRetrieveEnum';
+
+export type TypesToRetrieve = {
+  typesToRetrieve: TypesToRetrieveEnum[];
+};

clients/algoliasearch-client-javascript/packages/predict/model/typesToRetrieveEnum.ts

@@ -0,0 +1 @@
+export type TypesToRetrieveEnum = 'properties' | 'segments';