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

package/src/models/components/toolparametertransform.ts

@@ -0,0 +1,138 @@
+/*
+ * 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 {
+  ToolParameterTransformCondition,
+  ToolParameterTransformCondition$inboundSchema,
+  ToolParameterTransformCondition$Outbound,
+  ToolParameterTransformCondition$outboundSchema,
+} from "./toolparametertransformcondition.js";
+
+/**
+ * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+ */
+export const Action = {
+  Default: "default",
+  Override: "override",
+  Remove: "remove",
+} as const;
+/**
+ * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+ */
+export type Action = ClosedEnum<typeof Action>;
+
+/**
+ * A transform to be applied to the value of a parameter.
+ *
+ * @remarks
+ *
+ * Either `value` or `format` must be set:
+ * - `value` is any arbitrary value: string, list or dictionary.
+ * - `format` is a string composed of other parameters or context variables.
+ */
+export type ToolParameterTransform = {
+  /**
+   * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+   */
+  action?: Action | undefined;
+  /**
+   * Only apply the transform if the condition is met.
+   */
+  when?: ToolParameterTransformCondition | null | undefined;
+  /**
+   * The default value to use for the parameter.
+   */
+  value?: any | null | undefined;
+  /**
+   * The string value to use for the parameter. The value will be evaluated with the Python `str.format` method, for example, `Hello, {name}!`
+   */
+  format?: string | null | undefined;
+};
+
+/** @internal */
+export const Action$inboundSchema: z.ZodNativeEnum<typeof Action> = z
+  .nativeEnum(Action);
+
+/** @internal */
+export const Action$outboundSchema: z.ZodNativeEnum<typeof Action> =
+  Action$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Action$ {
+  /** @deprecated use `Action$inboundSchema` instead. */
+  export const inboundSchema = Action$inboundSchema;
+  /** @deprecated use `Action$outboundSchema` instead. */
+  export const outboundSchema = Action$outboundSchema;
+}
+
+/** @internal */
+export const ToolParameterTransform$inboundSchema: z.ZodType<
+  ToolParameterTransform,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action: Action$inboundSchema.default("default"),
+  when: z.nullable(ToolParameterTransformCondition$inboundSchema).optional(),
+  value: z.nullable(z.any()).optional(),
+  format: z.nullable(z.string()).optional(),
+});
+
+/** @internal */
+export type ToolParameterTransform$Outbound = {
+  action: string;
+  when?: ToolParameterTransformCondition$Outbound | null | undefined;
+  value?: any | null | undefined;
+  format?: string | null | undefined;
+};
+
+/** @internal */
+export const ToolParameterTransform$outboundSchema: z.ZodType<
+  ToolParameterTransform$Outbound,
+  z.ZodTypeDef,
+  ToolParameterTransform
+> = z.object({
+  action: Action$outboundSchema.default("default"),
+  when: z.nullable(ToolParameterTransformCondition$outboundSchema).optional(),
+  value: z.nullable(z.any()).optional(),
+  format: z.nullable(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 ToolParameterTransform$ {
+  /** @deprecated use `ToolParameterTransform$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterTransform$inboundSchema;
+  /** @deprecated use `ToolParameterTransform$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterTransform$outboundSchema;
+  /** @deprecated use `ToolParameterTransform$Outbound` instead. */
+  export type Outbound = ToolParameterTransform$Outbound;
+}
+
+export function toolParameterTransformToJSON(
+  toolParameterTransform: ToolParameterTransform,
+): string {
+  return JSON.stringify(
+    ToolParameterTransform$outboundSchema.parse(toolParameterTransform),
+  );
+}
+
+export function toolParameterTransformFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameterTransform, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameterTransform$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameterTransform' from JSON`,
+  );
+}

package/src/models/components/toolparametertransformcondition.ts

@@ -0,0 +1,88 @@
+/*
+ * 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";
+
+/**
+ * A condition to be met for a transform to be applied to the value of a parameter.
+ */
+export type ToolParameterTransformCondition = {
+  /**
+   * The name of the parameter to check.
+   */
+  key: string;
+  /**
+   * The value to check against the parameter.
+   */
+  value: string;
+  /**
+   * The operator to use for the comparison.
+   */
+  operator?: "eq" | null | undefined;
+};
+
+/** @internal */
+export const ToolParameterTransformCondition$inboundSchema: z.ZodType<
+  ToolParameterTransformCondition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+  operator: z.nullable(z.literal("eq")).optional(),
+});
+
+/** @internal */
+export type ToolParameterTransformCondition$Outbound = {
+  key: string;
+  value: string;
+  operator: "eq" | null;
+};
+
+/** @internal */
+export const ToolParameterTransformCondition$outboundSchema: z.ZodType<
+  ToolParameterTransformCondition$Outbound,
+  z.ZodTypeDef,
+  ToolParameterTransformCondition
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+  operator: z.nullable(z.literal("eq").default("eq" as const)),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameterTransformCondition$ {
+  /** @deprecated use `ToolParameterTransformCondition$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterTransformCondition$inboundSchema;
+  /** @deprecated use `ToolParameterTransformCondition$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterTransformCondition$outboundSchema;
+  /** @deprecated use `ToolParameterTransformCondition$Outbound` instead. */
+  export type Outbound = ToolParameterTransformCondition$Outbound;
+}
+
+export function toolParameterTransformConditionToJSON(
+  toolParameterTransformCondition: ToolParameterTransformCondition,
+): string {
+  return JSON.stringify(
+    ToolParameterTransformCondition$outboundSchema.parse(
+      toolParameterTransformCondition,
+    ),
+  );
+}
+
+export function toolParameterTransformConditionFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameterTransformCondition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameterTransformCondition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameterTransformCondition' from JSON`,
+  );
+}

package/src/models/components/toolupdate.ts

@@ -7,21 +7,19 @@ 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";
-
-/**
- * The definition of the tool
- */
-export type ToolUpdateDefinition = {};
+import {
+  SDKToolDefinition,
+  SDKToolDefinition$inboundSchema,
+  SDKToolDefinition$Outbound,
+  SDKToolDefinition$outboundSchema,
+} from "./sdktooldefinition.js";
 
 export type ToolUpdate = {
   /**
    * The name of the tool
    */
   name: string;
-  /**
-   * The definition of the tool
-   */
-  definition?: ToolUpdateDefinition | undefined;
+  definition: SDKToolDefinition;
   /**
    * The service this tool belongs to
    */
@@ -32,54 +30,6 @@ export type ToolUpdate = {
   id: number;
 };
 
-/** @internal */
-export const ToolUpdateDefinition$inboundSchema: z.ZodType<
-  ToolUpdateDefinition,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type ToolUpdateDefinition$Outbound = {};
-
-/** @internal */
-export const ToolUpdateDefinition$outboundSchema: z.ZodType<
-  ToolUpdateDefinition$Outbound,
-  z.ZodTypeDef,
-  ToolUpdateDefinition
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ToolUpdateDefinition$ {
-  /** @deprecated use `ToolUpdateDefinition$inboundSchema` instead. */
-  export const inboundSchema = ToolUpdateDefinition$inboundSchema;
-  /** @deprecated use `ToolUpdateDefinition$outboundSchema` instead. */
-  export const outboundSchema = ToolUpdateDefinition$outboundSchema;
-  /** @deprecated use `ToolUpdateDefinition$Outbound` instead. */
-  export type Outbound = ToolUpdateDefinition$Outbound;
-}
-
-export function toolUpdateDefinitionToJSON(
-  toolUpdateDefinition: ToolUpdateDefinition,
-): string {
-  return JSON.stringify(
-    ToolUpdateDefinition$outboundSchema.parse(toolUpdateDefinition),
-  );
-}
-
-export function toolUpdateDefinitionFromJSON(
-  jsonString: string,
-): SafeParseResult<ToolUpdateDefinition, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ToolUpdateDefinition$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ToolUpdateDefinition' from JSON`,
-  );
-}
-
 /** @internal */
 export const ToolUpdate$inboundSchema: z.ZodType<
   ToolUpdate,
@@ -87,7 +37,7 @@ export const ToolUpdate$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.string(),
-  definition: z.lazy(() => ToolUpdateDefinition$inboundSchema).optional(),
+  definition: SDKToolDefinition$inboundSchema,
   service_id: z.number().int(),
   id: z.number().int(),
 }).transform((v) => {
@@ -99,7 +49,7 @@ export const ToolUpdate$inboundSchema: z.ZodType<
 /** @internal */
 export type ToolUpdate$Outbound = {
   name: string;
-  definition?: ToolUpdateDefinition$Outbound | undefined;
+  definition: SDKToolDefinition$Outbound;
   service_id: number;
   id: number;
 };
@@ -111,7 +61,7 @@ export const ToolUpdate$outboundSchema: z.ZodType<
   ToolUpdate
 > = z.object({
   name: z.string(),
-  definition: z.lazy(() => ToolUpdateDefinition$outboundSchema).optional(),
+  definition: SDKToolDefinition$outboundSchema,
   serviceId: z.number().int(),
   id: z.number().int(),
 }).transform((v) => {

package/src/sdk/dashboards.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { dashboardsPostSessionEventsDashboard } from "../funcs/dashboardsPostSessionEventsDashboard.js";
+import { dashboardsPostSessionsDashboard } from "../funcs/dashboardsPostSessionsDashboard.js";
+import { dashboardsPostSessionSummaryDashboard } from "../funcs/dashboardsPostSessionSummaryDashboard.js";
+import { dashboardsPostSessionTransfersDashboard } from "../funcs/dashboardsPostSessionTransfersDashboard.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Dashboards extends ClientSDK {
+  /**
+   * Post Session Events
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_events
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionEventsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionEventsDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Summary
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_summary
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionSummaryDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionSummaryDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Transfers
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_transfers
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionTransfersDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionTransfersDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Sessions
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/sessions
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionsDashboard(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -7,6 +7,7 @@ import { Agents } from "./agents.js";
 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";
@@ -14,6 +15,7 @@ import { Services } from "./services.js";
 import { SessionLabels } from "./sessionlabels.js";
 import { Sessions } from "./sessions.js";
 import { Tools } from "./tools.js";
+import { V1 } from "./v1.js";
 
 export class SyllableSDK extends ClientSDK {
   private _agents?: Agents;
@@ -70,4 +72,14 @@ export class SyllableSDK extends ClientSDK {
   get directory(): Directory {
     return (this._directory ??= new Directory(this._options));
   }
+
+  private _dashboards?: Dashboards;
+  get dashboards(): Dashboards {
+    return (this._dashboards ??= new Dashboards(this._options));
+  }
+
+  private _v1?: V1;
+  get v1(): V1 {
+    return (this._v1 ??= new V1(this._options));
+  }
 }

package/src/sdk/v1.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { v1PostSessionEventsDashboard } from "../funcs/v1PostSessionEventsDashboard.js";
+import { v1PostSessionsDashboard } from "../funcs/v1PostSessionsDashboard.js";
+import { v1PostSessionSummaryDashboard } from "../funcs/v1PostSessionSummaryDashboard.js";
+import { v1PostSessionTransfersDashboard } from "../funcs/v1PostSessionTransfersDashboard.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class V1 extends ClientSDK {
+  /**
+   * Post Session Events
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_events
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionEventsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionEventsDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Summary
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_summary
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionSummaryDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionSummaryDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Transfers
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_transfers
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionTransfersDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionTransfersDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Sessions
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/sessions
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionsDashboard(
+      this,
+      options,
+    ));
+  }
+}

package/test/sdk/contract/agents.test.ts

@@ -0,0 +1,113 @@
+import { beforeAll, describe, it, expect, afterAll } from "vitest";
+import { getSDK, generateFake } from "./helper";
+
+let sdk
+let createdAgents = []
+beforeAll(async () => {
+    sdk = await getSDK()
+});
+
+afterAll(async () => {
+    for (const agent of createdAgents) {
+        const result = await sdk.agents.delete({
+            agentId: agent.id,
+            reason: 'was a created by a test'
+        })
+    }
+    for (const agent of createdAgents) {
+        const promptResult = await sdk.prompts.delete({
+            promptId: agent.promptId,
+            reason: 'was a created by a test'
+        })
+        const customMessageResult = await sdk.customMessages.delete({
+            customMessageId: agent.customMessageId,
+            reason: 'was a created by a test'
+        })
+    }
+})
+
+describe('Syllable SDK Contract test suite', () => {
+    describe('agents', () => {
+        describe('create', () => {
+            it('should create a agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                createdAgents.push(result)
+            })
+        })
+        describe('list', () => {
+            it('should list a newly created agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                createdAgents.push(result)
+                const listResult = await sdk.agents.list({});
+                const isFound = listResult.items.some((cm) => {
+                    return cm.name === agent.name
+                })
+                if (!isFound) {
+                    throw new Error('agent that was just created is not listed')
+                }
+            })
+        })
+        describe('update', () => {
+            it('should update a newly created agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                createdAgents.push(result)
+                agent.id = result.id
+                agent.description = 'new description'
+                const updateResult = await sdk.agents.update(agent);
+            })
+        })
+        describe('delete', () => {
+            it('should delete a newly created agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                const deleteResult = await sdk.agents.delete({
+                    agentId: result.id,
+                    reason: 'created by a test'
+                })
+                await sdk.prompts.delete({
+                    promptId: agent.promptId,
+                    reason: 'was a created by a test'
+                })
+                await sdk.customMessages.delete({
+                    customMessageId: agent.customMessageId,
+                    reason: 'was a created by a test'
+                })
+            })
+        })
+    })
+})