syllable-sdk 0.1.0-alpha.29 → 0.1.0-alpha.30

package/src/models/components/toolresponse.ts

@@ -0,0 +1,206 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+  ToolDefinition$Outbound,
+  ToolDefinition$outboundSchema,
+} from "./tooldefinition.js";
+
+/**
+ * A tool is a function that an agent can call to perform actions like accessing databases,
+ *
+ * @remarks
+ * making API calls, or processing data. For an agent to have access to a tool, the prompt
+ * associated with that agent should be linked to the tool and include instructions to use it.
+ */
+export type ToolResponse = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * A tool that can be called from an LLM during the conversation.
+   *
+   * @remarks
+   *
+   * The tool can result in one of the following actions depending on the `type` field:
+   * - `action`:
+   *   A request to perform an action.
+   * - `endpoint`:
+   *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
+   * - `context`:
+   *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
+   *   `language` and `say` context vars are currently supported, but this will be made more generic.
+   *
+   * For example, to change the current session language:
+   * {
+   *   "type": "context",
+   *   "tool": {
+   *     "function": {
+   *       "name": "set_language",
+   *       "parameters": {
+   *         "language": {
+   *           "type": "string",
+   *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
+   *         },
+   *         "message": {
+   *           "type": "string",
+   *           "description": "Inform the caller we're now speaking in the new language."
+   *         }
+   *       }
+   *     }
+   *   }
+   * }
+   *
+   * If `defaults` is provided, it will be used as the default values for the parameters of the
+   * tool call, if the LLM doesn't provide them:
+   * "defaults": {
+   *   "hospital": "Queens Hospital"
+   * }
+   *
+   * Some special "transform" handling is supported if the value is a dict with a single `transform`
+   * key. The parameter value will be transformed by the given `action` before being used as the
+   * default value:
+   *
+   * Removing an unwanted parameter:
+   * "defaults": {
+   *   "hospital": {
+   *     "transform": {
+   *       "action": "remove"
+   *     }
+   *   }
+   * }
+   *
+   * Using a value from another parameter and converting it to a dictionary:
+   * "defaults": {
+   *   "tags.hospital": "{vars.hospital}",
+   *   "tags.foo": "{params.foo}",
+   *   "foo": {
+   *     "transform": {
+   *       "action": "remove"
+   *     }
+   *   }
+   * }
+   *
+   * Add custom parameters from other parameters using Python's `format`:
+   * "defaults": {
+   *   "hello": {
+   *     "transform": {
+   *       "format": "Hello, {name}!"
+   *     }
+   *   }
+   * }
+   *
+   * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
+   * {
+   *   "defaults": {
+   *     "city": {
+   *       "transform": {
+   *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
+   *         "action": "override",
+   *         "format": "The {city}"
+   *       }
+   *     }
+   *   }
+   * }
+   *
+   * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
+   * "defaults": {
+   *   "foo": "@remove",
+   *   "name": "@override Hello, {name}!"
+   * }
+   */
+  definition: ToolDefinition;
+  /**
+   * The service this tool belongs to
+   */
+  serviceId: number;
+  /**
+   * The ID of the tool
+   */
+  id: number;
+  /**
+   * The name of the service to which the tool belongs
+   */
+  serviceName?: string | null | undefined;
+};
+
+/** @internal */
+export const ToolResponse$inboundSchema: z.ZodType<
+  ToolResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$inboundSchema,
+  service_id: z.number().int(),
+  id: z.number().int(),
+  service_name: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+    "service_name": "serviceName",
+  });
+});
+
+/** @internal */
+export type ToolResponse$Outbound = {
+  name: string;
+  definition: ToolDefinition$Outbound;
+  service_id: number;
+  id: number;
+  service_name?: string | null | undefined;
+};
+
+/** @internal */
+export const ToolResponse$outboundSchema: z.ZodType<
+  ToolResponse$Outbound,
+  z.ZodTypeDef,
+  ToolResponse
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$outboundSchema,
+  serviceId: z.number().int(),
+  id: z.number().int(),
+  serviceName: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+    serviceName: "service_name",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolResponse$ {
+  /** @deprecated use `ToolResponse$inboundSchema` instead. */
+  export const inboundSchema = ToolResponse$inboundSchema;
+  /** @deprecated use `ToolResponse$outboundSchema` instead. */
+  export const outboundSchema = ToolResponse$outboundSchema;
+  /** @deprecated use `ToolResponse$Outbound` instead. */
+  export type Outbound = ToolResponse$Outbound;
+}
+
+export function toolResponseToJSON(toolResponse: ToolResponse): string {
+  return JSON.stringify(ToolResponse$outboundSchema.parse(toolResponse));
+}
+
+export function toolResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolResponse' from JSON`,
+  );
+}

package/src/models/components/toolupdaterequest.ts

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+  ToolDefinition$Outbound,
+  ToolDefinition$outboundSchema,
+} from "./tooldefinition.js";
+
+export type ToolUpdateRequest = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * A tool that can be called from an LLM during the conversation.
+   *
+   * @remarks
+   *
+   * The tool can result in one of the following actions depending on the `type` field:
+   * - `action`:
+   *   A request to perform an action.
+   * - `endpoint`:
+   *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
+   * - `context`:
+   *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
+   *   `language` and `say` context vars are currently supported, but this will be made more generic.
+   *
+   * For example, to change the current session language:
+   * {
+   *   "type": "context",
+   *   "tool": {
+   *     "function": {
+   *       "name": "set_language",
+   *       "parameters": {
+   *         "language": {
+   *           "type": "string",
+   *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
+   *         },
+   *         "message": {
+   *           "type": "string",
+   *           "description": "Inform the caller we're now speaking in the new language."
+   *         }
+   *       }
+   *     }
+   *   }
+   * }
+   *
+   * If `defaults` is provided, it will be used as the default values for the parameters of the
+   * tool call, if the LLM doesn't provide them:
+   * "defaults": {
+   *   "hospital": "Queens Hospital"
+   * }
+   *
+   * Some special "transform" handling is supported if the value is a dict with a single `transform`
+   * key. The parameter value will be transformed by the given `action` before being used as the
+   * default value:
+   *
+   * Removing an unwanted parameter:
+   * "defaults": {
+   *   "hospital": {
+   *     "transform": {
+   *       "action": "remove"
+   *     }
+   *   }
+   * }
+   *
+   * Using a value from another parameter and converting it to a dictionary:
+   * "defaults": {
+   *   "tags.hospital": "{vars.hospital}",
+   *   "tags.foo": "{params.foo}",
+   *   "foo": {
+   *     "transform": {
+   *       "action": "remove"
+   *     }
+   *   }
+   * }
+   *
+   * Add custom parameters from other parameters using Python's `format`:
+   * "defaults": {
+   *   "hello": {
+   *     "transform": {
+   *       "format": "Hello, {name}!"
+   *     }
+   *   }
+   * }
+   *
+   * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
+   * {
+   *   "defaults": {
+   *     "city": {
+   *       "transform": {
+   *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
+   *         "action": "override",
+   *         "format": "The {city}"
+   *       }
+   *     }
+   *   }
+   * }
+   *
+   * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
+   * "defaults": {
+   *   "foo": "@remove",
+   *   "name": "@override Hello, {name}!"
+   * }
+   */
+  definition: ToolDefinition;
+  /**
+   * The service this tool belongs to
+   */
+  serviceId: number;
+  /**
+   * The ID of the tool
+   */
+  id: number;
+};
+
+/** @internal */
+export const ToolUpdateRequest$inboundSchema: z.ZodType<
+  ToolUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$inboundSchema,
+  service_id: z.number().int(),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+  });
+});
+
+/** @internal */
+export type ToolUpdateRequest$Outbound = {
+  name: string;
+  definition: ToolDefinition$Outbound;
+  service_id: number;
+  id: number;
+};
+
+/** @internal */
+export const ToolUpdateRequest$outboundSchema: z.ZodType<
+  ToolUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  ToolUpdateRequest
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$outboundSchema,
+  serviceId: z.number().int(),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolUpdateRequest$ {
+  /** @deprecated use `ToolUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = ToolUpdateRequest$inboundSchema;
+  /** @deprecated use `ToolUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = ToolUpdateRequest$outboundSchema;
+  /** @deprecated use `ToolUpdateRequest$Outbound` instead. */
+  export type Outbound = ToolUpdateRequest$Outbound;
+}
+
+export function toolUpdateRequestToJSON(
+  toolUpdateRequest: ToolUpdateRequest,
+): string {
+  return JSON.stringify(
+    ToolUpdateRequest$outboundSchema.parse(toolUpdateRequest),
+  );
+}
+
+export function toolUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolUpdateRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -16,10 +16,6 @@ export * from "./conversationslist.js";
 export * from "./custommessagegetbyid.js";
 export * from "./custommessagesdelete.js";
 export * from "./custommessageslist.js";
-export * from "./directorymemberdelete.js";
-export * from "./directorymembergetbyid.js";
-export * from "./directorymemberlist.js";
-export * from "./directorymemberupdate.js";
 export * from "./eventslist.js";
 export * from "./generatesessionrecordingurls.js";
 export * from "./promptsdelete.js";

package/src/sdk/agents.ts

@@ -46,7 +46,7 @@ export class Agents extends ClientSDK {
   async create(
     request: components.AgentCreate,
     options?: RequestOptions,
-  ): Promise<components.Agent> {
+  ): Promise<components.AgentResponse> {
     return unwrapAsync(agentsCreate(
       this,
       request,
@@ -63,7 +63,7 @@ export class Agents extends ClientSDK {
   async update(
     request: components.AgentUpdate,
     options?: RequestOptions,
-  ): Promise<components.Agent> {
+  ): Promise<components.AgentResponse> {
     return unwrapAsync(agentsUpdate(
       this,
       request,

package/src/sdk/prompts.ts

@@ -23,7 +23,7 @@ export class Prompts extends ClientSDK {
   async list(
     request: operations.PromptsListRequest,
     options?: RequestOptions,
-  ): Promise<components.ListResponsePrompt> {
+  ): Promise<components.ListResponsePromptResponse> {
     return unwrapAsync(promptsList(
       this,
       request,
@@ -38,9 +38,9 @@ export class Prompts extends ClientSDK {
    * Create a new prompt
    */
   async create(
-    request: components.PromptCreate,
+    request: components.PromptCreateRequest,
     options?: RequestOptions,
-  ): Promise<components.Prompt> {
+  ): Promise<components.PromptResponse> {
     return unwrapAsync(promptsCreate(
       this,
       request,
@@ -55,9 +55,9 @@ export class Prompts extends ClientSDK {
    * Update an existing prompt
    */
   async update(
-    request: components.PromptUpdate,
+    request: components.PromptUpdateRequest,
     options?: RequestOptions,
-  ): Promise<components.Prompt> {
+  ): Promise<components.PromptResponse> {
     return unwrapAsync(promptsUpdate(
       this,
       request,
@@ -74,7 +74,7 @@ export class Prompts extends ClientSDK {
   async getById(
     request: operations.PromptsGetByIdRequest,
     options?: RequestOptions,
-  ): Promise<components.Prompt> {
+  ): Promise<components.PromptResponse> {
     return unwrapAsync(promptsGetById(
       this,
       request,

package/src/sdk/sdk.ts

@@ -8,7 +8,6 @@ import { Channels } from "./channels.js";
 import { Conversations } from "./conversations.js";
 import { CustomMessages } from "./custommessages.js";
 import { Dashboards } from "./dashboards.js";
-import { Directory } from "./directory.js";
 import { Events } from "./events.js";
 import { Prompts } from "./prompts.js";
 import { Services } from "./services.js";
@@ -68,11 +67,6 @@ export class SyllableSDK extends ClientSDK {
     return (this._tools ??= new Tools(this._options));
   }
 
-  private _directory?: Directory;
-  get directory(): Directory {
-    return (this._directory ??= new Directory(this._options));
-  }
-
   private _dashboards?: Dashboards;
   get dashboards(): Dashboards {
     return (this._dashboards ??= new Dashboards(this._options));

package/src/sdk/targets.ts

@@ -36,7 +36,7 @@ export class Targets extends ClientSDK {
   async list(
     request: operations.ChannelTargetsListRequest,
     options?: RequestOptions,
-  ): Promise<components.ListResponseChannelTarget> {
+  ): Promise<components.ListResponseChannelTargetResponse> {
     return unwrapAsync(channelsTargetsList(
       this,
       request,
@@ -50,7 +50,7 @@ export class Targets extends ClientSDK {
   async create(
     request: operations.ChannelTargetsCreateRequest,
     options?: RequestOptions,
-  ): Promise<components.ChannelTarget> {
+  ): Promise<components.ChannelTargetResponse> {
     return unwrapAsync(channelsTargetsCreate(
       this,
       request,
@@ -64,7 +64,7 @@ export class Targets extends ClientSDK {
   async getById(
     request: operations.ChannelTargetsGetByIdRequest,
     options?: RequestOptions,
-  ): Promise<components.ChannelTarget> {
+  ): Promise<components.ChannelTargetResponse> {
     return unwrapAsync(channelsTargetsGetById(
       this,
       request,
@@ -81,7 +81,7 @@ export class Targets extends ClientSDK {
   async update(
     request: operations.ChannelTargetsUpdateRequest,
     options?: RequestOptions,
-  ): Promise<components.ChannelTarget> {
+  ): Promise<components.ChannelTargetResponse> {
     return unwrapAsync(channelsTargetsUpdate(
       this,
       request,

package/src/sdk/tools.ts

@@ -21,7 +21,7 @@ export class Tools extends ClientSDK {
   async list(
     request: operations.ToolListRequest,
     options?: RequestOptions,
-  ): Promise<components.ListResponseTool> {
+  ): Promise<components.ListResponseToolResponse> {
     return unwrapAsync(toolsList(
       this,
       request,
@@ -36,9 +36,9 @@ export class Tools extends ClientSDK {
    * Create a new tool
    */
   async create(
-    request: components.ToolCreate,
+    request: components.ToolCreateRequest,
     options?: RequestOptions,
-  ): Promise<components.Tool> {
+  ): Promise<components.ToolResponse> {
     return unwrapAsync(toolsCreate(
       this,
       request,
@@ -53,9 +53,9 @@ export class Tools extends ClientSDK {
    * Update an existing tool
    */
   async update(
-    request: components.ToolUpdate,
+    request: components.ToolUpdateRequest,
     options?: RequestOptions,
-  ): Promise<components.Tool> {
+  ): Promise<components.ToolResponse> {
     return unwrapAsync(toolsUpdate(
       this,
       request,

package/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "tsBuildInfoFile": ".tsbuildinfo",
+    "target": "ES2020",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+
+    "module": "Node16",
+    "moduleResolution": "Node16",
+
+    "allowJs": true,
+
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": ".",
+    
+
+    // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json
+    "strict": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "useUnknownInCatchVariables": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "isolatedModules": true,
+    "checkJs": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}