@gleanwork/api-client 0.4.1 → 0.4.3

package/src/models/components/tool.ts

@@ -0,0 +1,125 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ToolParameter,
+  ToolParameter$inboundSchema,
+  ToolParameter$Outbound,
+  ToolParameter$outboundSchema,
+} from "./toolparameter.js";
+
+/**
+ * Type of tool (READ, WRITE)
+ */
+export const ToolType = {
+  Read: "READ",
+  Write: "WRITE",
+} as const;
+/**
+ * Type of tool (READ, WRITE)
+ */
+export type ToolType = ClosedEnum<typeof ToolType>;
+
+export type Tool = {
+  /**
+   * Type of tool (READ, WRITE)
+   */
+  type?: ToolType | undefined;
+  /**
+   * Unique identifier for the tool
+   */
+  name?: string | undefined;
+  /**
+   * Human-readable name
+   */
+  displayName?: string | undefined;
+  /**
+   * LLM friendly description of the tool
+   */
+  description?: string | undefined;
+  /**
+   * The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
+   */
+  parameters?: { [k: string]: ToolParameter } | undefined;
+};
+
+/** @internal */
+export const ToolType$inboundSchema: z.ZodNativeEnum<typeof ToolType> = z
+  .nativeEnum(ToolType);
+
+/** @internal */
+export const ToolType$outboundSchema: z.ZodNativeEnum<typeof ToolType> =
+  ToolType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolType$ {
+  /** @deprecated use `ToolType$inboundSchema` instead. */
+  export const inboundSchema = ToolType$inboundSchema;
+  /** @deprecated use `ToolType$outboundSchema` instead. */
+  export const outboundSchema = ToolType$outboundSchema;
+}
+
+/** @internal */
+export const Tool$inboundSchema: z.ZodType<Tool, z.ZodTypeDef, unknown> = z
+  .object({
+    type: ToolType$inboundSchema.optional(),
+    name: z.string().optional(),
+    displayName: z.string().optional(),
+    description: z.string().optional(),
+    parameters: z.record(ToolParameter$inboundSchema).optional(),
+  });
+
+/** @internal */
+export type Tool$Outbound = {
+  type?: string | undefined;
+  name?: string | undefined;
+  displayName?: string | undefined;
+  description?: string | undefined;
+  parameters?: { [k: string]: ToolParameter$Outbound } | undefined;
+};
+
+/** @internal */
+export const Tool$outboundSchema: z.ZodType<Tool$Outbound, z.ZodTypeDef, Tool> =
+  z.object({
+    type: ToolType$outboundSchema.optional(),
+    name: z.string().optional(),
+    displayName: z.string().optional(),
+    description: z.string().optional(),
+    parameters: z.record(ToolParameter$outboundSchema).optional(),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Tool$ {
+  /** @deprecated use `Tool$inboundSchema` instead. */
+  export const inboundSchema = Tool$inboundSchema;
+  /** @deprecated use `Tool$outboundSchema` instead. */
+  export const outboundSchema = Tool$outboundSchema;
+  /** @deprecated use `Tool$Outbound` instead. */
+  export type Outbound = Tool$Outbound;
+}
+
+export function toolToJSON(tool: Tool): string {
+  return JSON.stringify(Tool$outboundSchema.parse(tool));
+}
+
+export function toolFromJSON(
+  jsonString: string,
+): SafeParseResult<Tool, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Tool$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Tool' from JSON`,
+  );
+}

package/src/models/components/toolparameter.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Parameter type (string, number, boolean, object, array)
+ */
+export const ToolParameterType = {
+  String: "string",
+  Number: "number",
+  Boolean: "boolean",
+  Object: "object",
+  Array: "array",
+} as const;
+/**
+ * Parameter type (string, number, boolean, object, array)
+ */
+export type ToolParameterType = ClosedEnum<typeof ToolParameterType>;
+
+export type ToolParameter = {
+  /**
+   * Parameter type (string, number, boolean, object, array)
+   */
+  type?: ToolParameterType | undefined;
+  /**
+   * The name of the parameter
+   */
+  name?: string | undefined;
+  /**
+   * The description of the parameter
+   */
+  description?: string | undefined;
+  /**
+   * Whether the parameter is required
+   */
+  isRequired?: boolean | undefined;
+  /**
+   * The possible values for the parameter. Can contain only primitive values or arrays of primitive values.
+   */
+  possibleValues?: Array<string> | undefined;
+  items?: ToolParameter | undefined;
+  /**
+   * When type is 'object', this describes the structure of the object.
+   */
+  properties?: { [k: string]: ToolParameter } | undefined;
+};
+
+/** @internal */
+export const ToolParameterType$inboundSchema: z.ZodNativeEnum<
+  typeof ToolParameterType
+> = z.nativeEnum(ToolParameterType);
+
+/** @internal */
+export const ToolParameterType$outboundSchema: z.ZodNativeEnum<
+  typeof ToolParameterType
+> = ToolParameterType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameterType$ {
+  /** @deprecated use `ToolParameterType$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterType$inboundSchema;
+  /** @deprecated use `ToolParameterType$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterType$outboundSchema;
+}
+
+/** @internal */
+export const ToolParameter$inboundSchema: z.ZodType<
+  ToolParameter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: ToolParameterType$inboundSchema.optional(),
+  name: z.string().optional(),
+  description: z.string().optional(),
+  isRequired: z.boolean().optional(),
+  possibleValues: z.array(z.string()).optional(),
+  items: z.lazy(() => ToolParameter$inboundSchema).optional(),
+  properties: z.record(z.lazy(() => ToolParameter$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type ToolParameter$Outbound = {
+  type?: string | undefined;
+  name?: string | undefined;
+  description?: string | undefined;
+  isRequired?: boolean | undefined;
+  possibleValues?: Array<string> | undefined;
+  items?: ToolParameter$Outbound | undefined;
+  properties?: { [k: string]: ToolParameter$Outbound } | undefined;
+};
+
+/** @internal */
+export const ToolParameter$outboundSchema: z.ZodType<
+  ToolParameter$Outbound,
+  z.ZodTypeDef,
+  ToolParameter
+> = z.object({
+  type: ToolParameterType$outboundSchema.optional(),
+  name: z.string().optional(),
+  description: z.string().optional(),
+  isRequired: z.boolean().optional(),
+  possibleValues: z.array(z.string()).optional(),
+  items: z.lazy(() => ToolParameter$outboundSchema).optional(),
+  properties: z.record(z.lazy(() => ToolParameter$outboundSchema)).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameter$ {
+  /** @deprecated use `ToolParameter$inboundSchema` instead. */
+  export const inboundSchema = ToolParameter$inboundSchema;
+  /** @deprecated use `ToolParameter$outboundSchema` instead. */
+  export const outboundSchema = ToolParameter$outboundSchema;
+  /** @deprecated use `ToolParameter$Outbound` instead. */
+  export type Outbound = ToolParameter$Outbound;
+}
+
+export function toolParameterToJSON(toolParameter: ToolParameter): string {
+  return JSON.stringify(ToolParameter$outboundSchema.parse(toolParameter));
+}
+
+export function toolParameterFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameter' from JSON`,
+  );
+}

package/src/models/components/toolscallparameter.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ToolsCallParameter = {
+  /**
+   * The name of the parameter
+   */
+  name: string;
+  /**
+   * The value of the parameter (for primitive types)
+   */
+  value: string;
+  /**
+   * The value of the parameter (for array types)
+   */
+  items?: Array<ToolsCallParameter> | undefined;
+  /**
+   * The value of the parameter (for object types)
+   */
+  properties?: { [k: string]: ToolsCallParameter } | undefined;
+};
+
+/** @internal */
+export const ToolsCallParameter$inboundSchema: z.ZodType<
+  ToolsCallParameter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  value: z.string(),
+  items: z.array(z.lazy(() => ToolsCallParameter$inboundSchema)).optional(),
+  properties: z.record(z.lazy(() => ToolsCallParameter$inboundSchema))
+    .optional(),
+});
+
+/** @internal */
+export type ToolsCallParameter$Outbound = {
+  name: string;
+  value: string;
+  items?: Array<ToolsCallParameter$Outbound> | undefined;
+  properties?: { [k: string]: ToolsCallParameter$Outbound } | undefined;
+};
+
+/** @internal */
+export const ToolsCallParameter$outboundSchema: z.ZodType<
+  ToolsCallParameter$Outbound,
+  z.ZodTypeDef,
+  ToolsCallParameter
+> = z.object({
+  name: z.string(),
+  value: z.string(),
+  items: z.array(z.lazy(() => ToolsCallParameter$outboundSchema)).optional(),
+  properties: z.record(z.lazy(() => ToolsCallParameter$outboundSchema))
+    .optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolsCallParameter$ {
+  /** @deprecated use `ToolsCallParameter$inboundSchema` instead. */
+  export const inboundSchema = ToolsCallParameter$inboundSchema;
+  /** @deprecated use `ToolsCallParameter$outboundSchema` instead. */
+  export const outboundSchema = ToolsCallParameter$outboundSchema;
+  /** @deprecated use `ToolsCallParameter$Outbound` instead. */
+  export type Outbound = ToolsCallParameter$Outbound;
+}
+
+export function toolsCallParameterToJSON(
+  toolsCallParameter: ToolsCallParameter,
+): string {
+  return JSON.stringify(
+    ToolsCallParameter$outboundSchema.parse(toolsCallParameter),
+  );
+}
+
+export function toolsCallParameterFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsCallParameter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsCallParameter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsCallParameter' from JSON`,
+  );
+}

package/src/models/components/toolscallrequest.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ToolsCallParameter,
+  ToolsCallParameter$inboundSchema,
+  ToolsCallParameter$Outbound,
+  ToolsCallParameter$outboundSchema,
+} from "./toolscallparameter.js";
+
+export type ToolsCallRequest = {
+  /**
+   * Required name of the tool to execute
+   */
+  name: string;
+  /**
+   * The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
+   */
+  parameters: { [k: string]: ToolsCallParameter };
+};
+
+/** @internal */
+export const ToolsCallRequest$inboundSchema: z.ZodType<
+  ToolsCallRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  parameters: z.record(ToolsCallParameter$inboundSchema),
+});
+
+/** @internal */
+export type ToolsCallRequest$Outbound = {
+  name: string;
+  parameters: { [k: string]: ToolsCallParameter$Outbound };
+};
+
+/** @internal */
+export const ToolsCallRequest$outboundSchema: z.ZodType<
+  ToolsCallRequest$Outbound,
+  z.ZodTypeDef,
+  ToolsCallRequest
+> = z.object({
+  name: z.string(),
+  parameters: z.record(ToolsCallParameter$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolsCallRequest$ {
+  /** @deprecated use `ToolsCallRequest$inboundSchema` instead. */
+  export const inboundSchema = ToolsCallRequest$inboundSchema;
+  /** @deprecated use `ToolsCallRequest$outboundSchema` instead. */
+  export const outboundSchema = ToolsCallRequest$outboundSchema;
+  /** @deprecated use `ToolsCallRequest$Outbound` instead. */
+  export type Outbound = ToolsCallRequest$Outbound;
+}
+
+export function toolsCallRequestToJSON(
+  toolsCallRequest: ToolsCallRequest,
+): string {
+  return JSON.stringify(
+    ToolsCallRequest$outboundSchema.parse(toolsCallRequest),
+  );
+}
+
+export function toolsCallRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsCallRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsCallRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsCallRequest' from JSON`,
+  );
+}

package/src/models/components/toolscallresponse.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ToolsCallResponse = {
+  /**
+   * The raw response from the tool
+   */
+  rawResponse?: { [k: string]: any } | undefined;
+  /**
+   * The error message if applicable
+   */
+  error?: string | undefined;
+};
+
+/** @internal */
+export const ToolsCallResponse$inboundSchema: z.ZodType<
+  ToolsCallResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  rawResponse: z.record(z.any()).optional(),
+  error: z.string().optional(),
+});
+
+/** @internal */
+export type ToolsCallResponse$Outbound = {
+  rawResponse?: { [k: string]: any } | undefined;
+  error?: string | undefined;
+};
+
+/** @internal */
+export const ToolsCallResponse$outboundSchema: z.ZodType<
+  ToolsCallResponse$Outbound,
+  z.ZodTypeDef,
+  ToolsCallResponse
+> = z.object({
+  rawResponse: z.record(z.any()).optional(),
+  error: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolsCallResponse$ {
+  /** @deprecated use `ToolsCallResponse$inboundSchema` instead. */
+  export const inboundSchema = ToolsCallResponse$inboundSchema;
+  /** @deprecated use `ToolsCallResponse$outboundSchema` instead. */
+  export const outboundSchema = ToolsCallResponse$outboundSchema;
+  /** @deprecated use `ToolsCallResponse$Outbound` instead. */
+  export type Outbound = ToolsCallResponse$Outbound;
+}
+
+export function toolsCallResponseToJSON(
+  toolsCallResponse: ToolsCallResponse,
+): string {
+  return JSON.stringify(
+    ToolsCallResponse$outboundSchema.parse(toolsCallResponse),
+  );
+}
+
+export function toolsCallResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsCallResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsCallResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsCallResponse' from JSON`,
+  );
+}

package/src/models/components/toolslistresponse.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Tool,
+  Tool$inboundSchema,
+  Tool$Outbound,
+  Tool$outboundSchema,
+} from "./tool.js";
+
+export type ToolsListResponse = {
+  tools?: Array<Tool> | undefined;
+};
+
+/** @internal */
+export const ToolsListResponse$inboundSchema: z.ZodType<
+  ToolsListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tools: z.array(Tool$inboundSchema).optional(),
+});
+
+/** @internal */
+export type ToolsListResponse$Outbound = {
+  tools?: Array<Tool$Outbound> | undefined;
+};
+
+/** @internal */
+export const ToolsListResponse$outboundSchema: z.ZodType<
+  ToolsListResponse$Outbound,
+  z.ZodTypeDef,
+  ToolsListResponse
+> = z.object({
+  tools: z.array(Tool$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolsListResponse$ {
+  /** @deprecated use `ToolsListResponse$inboundSchema` instead. */
+  export const inboundSchema = ToolsListResponse$inboundSchema;
+  /** @deprecated use `ToolsListResponse$outboundSchema` instead. */
+  export const outboundSchema = ToolsListResponse$outboundSchema;
+  /** @deprecated use `ToolsListResponse$Outbound` instead. */
+  export type Outbound = ToolsListResponse$Outbound;
+}
+
+export function toolsListResponseToJSON(
+  toolsListResponse: ToolsListResponse,
+): string {
+  return JSON.stringify(
+    ToolsListResponse$outboundSchema.parse(toolsListResponse),
+  );
+}
+
+export function toolsListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsListResponse' from JSON`,
+  );
+}

package/src/models/operations/getrestapiv1toolslist.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetRestApiV1ToolsListRequest = {
+  /**
+   * Optional array of tool names to filter by
+   */
+  toolNames?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetRestApiV1ToolsListRequest$inboundSchema: z.ZodType<
+  GetRestApiV1ToolsListRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  toolNames: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type GetRestApiV1ToolsListRequest$Outbound = {
+  toolNames?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetRestApiV1ToolsListRequest$outboundSchema: z.ZodType<
+  GetRestApiV1ToolsListRequest$Outbound,
+  z.ZodTypeDef,
+  GetRestApiV1ToolsListRequest
+> = z.object({
+  toolNames: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetRestApiV1ToolsListRequest$ {
+  /** @deprecated use `GetRestApiV1ToolsListRequest$inboundSchema` instead. */
+  export const inboundSchema = GetRestApiV1ToolsListRequest$inboundSchema;
+  /** @deprecated use `GetRestApiV1ToolsListRequest$outboundSchema` instead. */
+  export const outboundSchema = GetRestApiV1ToolsListRequest$outboundSchema;
+  /** @deprecated use `GetRestApiV1ToolsListRequest$Outbound` instead. */
+  export type Outbound = GetRestApiV1ToolsListRequest$Outbound;
+}
+
+export function getRestApiV1ToolsListRequestToJSON(
+  getRestApiV1ToolsListRequest: GetRestApiV1ToolsListRequest,
+): string {
+  return JSON.stringify(
+    GetRestApiV1ToolsListRequest$outboundSchema.parse(
+      getRestApiV1ToolsListRequest,
+    ),
+  );
+}
+
+export function getRestApiV1ToolsListRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetRestApiV1ToolsListRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetRestApiV1ToolsListRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetRestApiV1ToolsListRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -16,11 +16,12 @@ export * from "./getchat.js";
 export * from "./getchatapplication.js";
 export * from "./getchatfiles.js";
 export * from "./getdocvisibility.js";
-export * from "./getpolicies.js";
 export * from "./getpolicy.js";
 export * from "./getreportstatus.js";
+export * from "./getrestapiv1toolslist.js";
 export * from "./listchats.js";
 export * from "./listpins.js";
+export * from "./listpolicies.js";
 export * from "./listverifications.js";
 export * from "./postapiindexv1debugdatasourcedocument.js";
 export * from "./postapiindexv1debugdatasourcedocuments.js";