@distilled.cloud/typesense 0.0.0 → 0.15.0

package/src/operations/retrieveCurationSetItem.ts

@@ -0,0 +1,73 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrieveCurationSetItemInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    curationSetName: Schema.String.pipe(T.PathParam()),
+    itemId: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/curation_sets/{curationSetName}/items/{itemId}",
+    }),
+  );
+export type RetrieveCurationSetItemInput =
+  typeof RetrieveCurationSetItemInput.Type;
+
+// Output Schema
+export const RetrieveCurationSetItemOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    rule: Schema.Struct({
+      tags: Schema.optional(Schema.Array(Schema.String)),
+      query: Schema.optional(Schema.String),
+      match: Schema.optional(Schema.Literals(["exact", "contains"])),
+      filter_by: Schema.optional(Schema.String),
+    }),
+    includes: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          id: Schema.String,
+          position: Schema.Number,
+        }),
+      ),
+    ),
+    excludes: Schema.optional(
+      Schema.Array(
+        Schema.Struct({
+          id: Schema.String,
+        }),
+      ),
+    ),
+    filter_by: Schema.optional(Schema.String),
+    remove_matched_tokens: Schema.optional(Schema.Boolean),
+    metadata: Schema.optional(Schema.Unknown),
+    sort_by: Schema.optional(Schema.String),
+    replace_query: Schema.optional(Schema.String),
+    filter_curated_hits: Schema.optional(Schema.Boolean),
+    effective_from_ts: Schema.optional(Schema.Number),
+    effective_to_ts: Schema.optional(Schema.Number),
+    stop_processing: Schema.optional(Schema.Boolean),
+    id: Schema.String,
+  });
+export type RetrieveCurationSetItemOutput =
+  typeof RetrieveCurationSetItemOutput.Type;
+
+// The operation
+/**
+ * Retrieve a curation set item
+ *
+ * Retrieve a specific curation item by its id
+ *
+ * @param curationSetName - The name of the curation set
+ * @param itemId - The id of the curation item to retrieve
+ */
+export const retrieveCurationSetItem = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveCurationSetItemInput,
+    outputSchema: RetrieveCurationSetItemOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/retrieveCurationSetItems.ts

@@ -0,0 +1,70 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrieveCurationSetItemsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    curationSetName: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({ method: "GET", path: "/curation_sets/{curationSetName}/items" }),
+  );
+export type RetrieveCurationSetItemsInput =
+  typeof RetrieveCurationSetItemsInput.Type;
+
+// Output Schema
+export const RetrieveCurationSetItemsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+    Schema.Struct({
+      rule: Schema.Struct({
+        tags: Schema.optional(Schema.Array(Schema.String)),
+        query: Schema.optional(Schema.String),
+        match: Schema.optional(Schema.Literals(["exact", "contains"])),
+        filter_by: Schema.optional(Schema.String),
+      }),
+      includes: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            id: Schema.String,
+            position: Schema.Number,
+          }),
+        ),
+      ),
+      excludes: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            id: Schema.String,
+          }),
+        ),
+      ),
+      filter_by: Schema.optional(Schema.String),
+      remove_matched_tokens: Schema.optional(Schema.Boolean),
+      metadata: Schema.optional(Schema.Unknown),
+      sort_by: Schema.optional(Schema.String),
+      replace_query: Schema.optional(Schema.String),
+      filter_curated_hits: Schema.optional(Schema.Boolean),
+      effective_from_ts: Schema.optional(Schema.Number),
+      effective_to_ts: Schema.optional(Schema.Number),
+      stop_processing: Schema.optional(Schema.Boolean),
+      id: Schema.String,
+    }),
+  );
+export type RetrieveCurationSetItemsOutput =
+  typeof RetrieveCurationSetItemsOutput.Type;
+
+// The operation
+/**
+ * List items in a curation set
+ *
+ * Retrieve all curation items in a set
+ *
+ * @param curationSetName - The name of the curation set to retrieve items for
+ */
+export const retrieveCurationSetItems = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveCurationSetItemsInput,
+    outputSchema: RetrieveCurationSetItemsOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/retrieveCurationSets.ts

@@ -0,0 +1,68 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveCurationSetsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+    T.Http({ method: "GET", path: "/curation_sets" }),
+  );
+export type RetrieveCurationSetsInput = typeof RetrieveCurationSetsInput.Type;
+
+// Output Schema
+export const RetrieveCurationSetsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+    Schema.Struct({
+      items: Schema.Array(
+        Schema.Struct({
+          rule: Schema.Struct({
+            tags: Schema.optional(Schema.Array(Schema.String)),
+            query: Schema.optional(Schema.String),
+            match: Schema.optional(Schema.Literals(["exact", "contains"])),
+            filter_by: Schema.optional(Schema.String),
+          }),
+          includes: Schema.optional(
+            Schema.Array(
+              Schema.Struct({
+                id: Schema.String,
+                position: Schema.Number,
+              }),
+            ),
+          ),
+          excludes: Schema.optional(
+            Schema.Array(
+              Schema.Struct({
+                id: Schema.String,
+              }),
+            ),
+          ),
+          filter_by: Schema.optional(Schema.String),
+          remove_matched_tokens: Schema.optional(Schema.Boolean),
+          metadata: Schema.optional(Schema.Unknown),
+          sort_by: Schema.optional(Schema.String),
+          replace_query: Schema.optional(Schema.String),
+          filter_curated_hits: Schema.optional(Schema.Boolean),
+          effective_from_ts: Schema.optional(Schema.Number),
+          effective_to_ts: Schema.optional(Schema.Number),
+          stop_processing: Schema.optional(Schema.Boolean),
+          id: Schema.optional(Schema.String),
+        }),
+      ),
+      description: Schema.optional(Schema.String),
+      name: Schema.String,
+    }),
+  );
+export type RetrieveCurationSetsOutput = typeof RetrieveCurationSetsOutput.Type;
+
+// The operation
+/**
+ * List all curation sets
+ *
+ * Retrieve all curation sets
+ */
+export const retrieveCurationSets = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveCurationSetsInput,
+    outputSchema: RetrieveCurationSetsOutput,
+  }),
+);

package/src/operations/retrieveMetrics.ts

@@ -0,0 +1,24 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveMetricsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {},
+).pipe(T.Http({ method: "GET", path: "/metrics.json" }));
+export type RetrieveMetricsInput = typeof RetrieveMetricsInput.Type;
+
+// Output Schema
+export const RetrieveMetricsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Unknown;
+export type RetrieveMetricsOutput = typeof RetrieveMetricsOutput.Type;
+
+// The operation
+/**
+ * Get current RAM, CPU, Disk & Network usage metrics.
+ *
+ * Retrieve the metrics.
+ */
+export const retrieveMetrics = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RetrieveMetricsInput,
+  outputSchema: RetrieveMetricsOutput,
+}));

package/src/operations/retrieveNLSearchModel.ts

@@ -0,0 +1,35 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrieveNLSearchModelInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    modelId: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "GET", path: "/nl_search_models/{modelId}" }));
+export type RetrieveNLSearchModelInput = typeof RetrieveNLSearchModelInput.Type;
+
+// Output Schema
+export const RetrieveNLSearchModelOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+  });
+export type RetrieveNLSearchModelOutput =
+  typeof RetrieveNLSearchModelOutput.Type;
+
+// The operation
+/**
+ * Retrieve a NL search model
+ *
+ * Retrieve a specific NL search model by its ID.
+ *
+ * @param modelId - The ID of the NL search model to retrieve
+ */
+export const retrieveNLSearchModel = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveNLSearchModelInput,
+    outputSchema: RetrieveNLSearchModelOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/retrievePreset.ts

@@ -0,0 +1,31 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrievePresetInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  presetId: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/presets/{presetId}" }));
+export type RetrievePresetInput = typeof RetrievePresetInput.Type;
+
+// Output Schema
+export const RetrievePresetOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  value: Schema.Unknown,
+  name: Schema.String,
+});
+export type RetrievePresetOutput = typeof RetrievePresetOutput.Type;
+
+// The operation
+/**
+ * Retrieves a preset.
+ *
+ * Retrieve the details of a preset, given it's name.
+ *
+ * @param presetId - The ID of the preset to retrieve.
+ */
+export const retrievePreset = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RetrievePresetInput,
+  outputSchema: RetrievePresetOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/retrieveStopwordsSet.ts

@@ -0,0 +1,38 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrieveStopwordsSetInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    setId: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "GET", path: "/stopwords/{setId}" }));
+export type RetrieveStopwordsSetInput = typeof RetrieveStopwordsSetInput.Type;
+
+// Output Schema
+export const RetrieveStopwordsSetOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    stopwords: Schema.Struct({
+      id: Schema.String,
+      stopwords: Schema.Array(Schema.String),
+      locale: Schema.optional(Schema.String),
+    }),
+  });
+export type RetrieveStopwordsSetOutput = typeof RetrieveStopwordsSetOutput.Type;
+
+// The operation
+/**
+ * Retrieves a stopwords set.
+ *
+ * Retrieve the details of a stopwords set, given it's name.
+ *
+ * @param setId - The ID of the stopwords set to retrieve.
+ */
+export const retrieveStopwordsSet = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveStopwordsSetInput,
+    outputSchema: RetrieveStopwordsSetOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/retrieveStopwordsSets.ts

@@ -0,0 +1,37 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveStopwordsSetsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+    T.Http({ method: "GET", path: "/stopwords" }),
+  );
+export type RetrieveStopwordsSetsInput = typeof RetrieveStopwordsSetsInput.Type;
+
+// Output Schema
+export const RetrieveStopwordsSetsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    stopwords: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        stopwords: Schema.Array(Schema.String),
+        locale: Schema.optional(Schema.String),
+      }),
+    ),
+  });
+export type RetrieveStopwordsSetsOutput =
+  typeof RetrieveStopwordsSetsOutput.Type;
+
+// The operation
+/**
+ * Retrieves all stopwords sets.
+ *
+ * Retrieve the details of all stopwords sets
+ */
+export const retrieveStopwordsSets = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveStopwordsSetsInput,
+    outputSchema: RetrieveStopwordsSetsOutput,
+  }),
+);

package/src/operations/retrieveSynonymSet.ts

@@ -0,0 +1,41 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrieveSynonymSetInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    synonymSetName: Schema.String.pipe(T.PathParam()),
+  }).pipe(T.Http({ method: "GET", path: "/synonym_sets/{synonymSetName}" }));
+export type RetrieveSynonymSetInput = typeof RetrieveSynonymSetInput.Type;
+
+// Output Schema
+export const RetrieveSynonymSetOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    items: Schema.Array(
+      Schema.Struct({
+        id: Schema.String,
+        synonyms: Schema.Array(Schema.String),
+        root: Schema.optional(Schema.String),
+        locale: Schema.optional(Schema.String),
+        symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
+      }),
+    ),
+    name: Schema.String,
+  });
+export type RetrieveSynonymSetOutput = typeof RetrieveSynonymSetOutput.Type;
+
+// The operation
+/**
+ * Retrieve a synonym set
+ *
+ * Retrieve a specific synonym set by its name
+ *
+ * @param synonymSetName - The name of the synonym set to retrieve
+ */
+export const retrieveSynonymSet = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RetrieveSynonymSetInput,
+  outputSchema: RetrieveSynonymSetOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/retrieveSynonymSetItem.ts

@@ -0,0 +1,47 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrieveSynonymSetItemInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    synonymSetName: Schema.String.pipe(T.PathParam()),
+    itemId: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      path: "/synonym_sets/{synonymSetName}/items/{itemId}",
+    }),
+  );
+export type RetrieveSynonymSetItemInput =
+  typeof RetrieveSynonymSetItemInput.Type;
+
+// Output Schema
+export const RetrieveSynonymSetItemOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    id: Schema.String,
+    synonyms: Schema.Array(Schema.String),
+    root: Schema.optional(Schema.String),
+    locale: Schema.optional(Schema.String),
+    symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
+  });
+export type RetrieveSynonymSetItemOutput =
+  typeof RetrieveSynonymSetItemOutput.Type;
+
+// The operation
+/**
+ * Retrieve a synonym set item
+ *
+ * Retrieve a specific synonym item by its id
+ *
+ * @param synonymSetName - The name of the synonym set
+ * @param itemId - The id of the synonym item to retrieve
+ */
+export const retrieveSynonymSetItem = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveSynonymSetItemInput,
+    outputSchema: RetrieveSynonymSetItemOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/retrieveSynonymSetItems.ts

@@ -0,0 +1,44 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+import { NotFound } from "../errors.ts";
+
+// Input Schema
+export const RetrieveSynonymSetItemsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+    synonymSetName: Schema.String.pipe(T.PathParam()),
+  }).pipe(
+    T.Http({ method: "GET", path: "/synonym_sets/{synonymSetName}/items" }),
+  );
+export type RetrieveSynonymSetItemsInput =
+  typeof RetrieveSynonymSetItemsInput.Type;
+
+// Output Schema
+export const RetrieveSynonymSetItemsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+      synonyms: Schema.Array(Schema.String),
+      root: Schema.optional(Schema.String),
+      locale: Schema.optional(Schema.String),
+      symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
+    }),
+  );
+export type RetrieveSynonymSetItemsOutput =
+  typeof RetrieveSynonymSetItemsOutput.Type;
+
+// The operation
+/**
+ * List items in a synonym set
+ *
+ * Retrieve all synonym items in a set
+ *
+ * @param synonymSetName - The name of the synonym set to retrieve items for
+ */
+export const retrieveSynonymSetItems = /*@__PURE__*/ /*#__PURE__*/ API.make(
+  () => ({
+    inputSchema: RetrieveSynonymSetItemsInput,
+    outputSchema: RetrieveSynonymSetItemsOutput,
+    errors: [NotFound] as const,
+  }),
+);

package/src/operations/retrieveSynonymSets.ts

@@ -0,0 +1,39 @@
+import * as Schema from "effect/Schema";
+import { API } from "../client.ts";
+import * as T from "../traits.ts";
+
+// Input Schema
+export const RetrieveSynonymSetsInput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+    T.Http({ method: "GET", path: "/synonym_sets" }),
+  );
+export type RetrieveSynonymSetsInput = typeof RetrieveSynonymSetsInput.Type;
+
+// Output Schema
+export const RetrieveSynonymSetsOutput =
+  /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+    Schema.Struct({
+      items: Schema.Array(
+        Schema.Struct({
+          id: Schema.String,
+          synonyms: Schema.Array(Schema.String),
+          root: Schema.optional(Schema.String),
+          locale: Schema.optional(Schema.String),
+          symbols_to_index: Schema.optional(Schema.Array(Schema.String)),
+        }),
+      ),
+      name: Schema.String,
+    }),
+  );
+export type RetrieveSynonymSetsOutput = typeof RetrieveSynonymSetsOutput.Type;
+
+// The operation
+/**
+ * List all synonym sets
+ *
+ * Retrieve all synonym sets
+ */
+export const retrieveSynonymSets = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: RetrieveSynonymSetsInput,
+  outputSchema: RetrieveSynonymSetsOutput,
+}));