syllable-sdk 0.1.0-alpha.35 → 0.1.0-alpha.36

package/src/funcs/v1GetByName.ts

@@ -0,0 +1,142 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Data Source
+ *
+ * @remarks
+ * Fetch a given data source, including its text.
+ */
+export async function v1GetByName(
+  client: SyllableSDKCore,
+  request: operations.DataSourcesGetByNameRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.DataSourceDetailResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.DataSourcesGetByNameRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    name: encodeSimple("name", payload.name, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/api/v1/data_sources/{name}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "data_sources_get_by_name",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.DataSourceDetailResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.DataSourceDetailResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/v1List.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List Data Sources
+ *
+ * @remarks
+ * Fetch metadata about all data sources, not including their text.
+ */
+export async function v1List(
+  client: SyllableSDKCore,
+  request: operations.DataSourcesListRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.ListResponseDataSourceMetadataResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.DataSourcesListRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/api/v1/data_sources/")();
+
+  const query = encodeFormQuery({
+    "end_datetime": payload.end_datetime,
+    "fields": payload.fields,
+    "limit": payload.limit,
+    "order_by": payload.order_by,
+    "order_by_direction": payload.order_by_direction,
+    "page": payload.page,
+    "search_field_values": payload.search_field_values,
+    "search_fields": payload.search_fields,
+    "start_datetime": payload.start_datetime,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "data_sources_list",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.ListResponseDataSourceMetadataResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      components.ListResponseDataSourceMetadataResponse$inboundSchema,
+    ),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/v1Update.ts

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update Data Source
+ *
+ * @remarks
+ * Update an existing data source.
+ */
+export async function v1Update(
+  client: SyllableSDKCore,
+  request: components.DataSourceUpdateRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.DataSourceDetailResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.DataSourceUpdateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/api/v1/data_sources/")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "data_sources_update",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.DataSourceDetailResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.DataSourceDetailResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.2",
-  sdkVersion: "0.1.0-alpha.35",
-  genVersion: "2.493.34",
+  sdkVersion: "0.1.0-alpha.36",
+  genVersion: "2.500.5",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.35 2.493.34 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.36 2.500.5 0.0.2 syllable-sdk",
 } as const;

package/src/lib/retries.ts

@@ -158,7 +158,6 @@ async function retryBackoff(
   const start = Date.now();
   let x = 0;
 
-  // eslint-disable-next-line no-constant-condition
   while (true) {
     try {
       const res = await fn();

package/src/models/components/datasourcecreaterequest.ts

@@ -0,0 +1,113 @@
+/*
+ * 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";
+
+export type DataSourceCreateRequest = {
+  /**
+   * The data source name. Must be unique within suborg.
+   */
+  name: string;
+  /**
+   * The description of the data source.
+   */
+  description?: string | null | undefined;
+  /**
+   * Searchable labels for the data source. Can be included in agent.prompt_tool_defaults for a given tool to give the agent access to data sources with those labels when calling that tool.
+   */
+  labels?: Array<string> | undefined;
+  /**
+   * Whether the content should be split into smaller chunks. This can improve agent performance when searching a large data source but risks some relevant information being left off search results if chunk_delimiter is not set up properly.
+   */
+  chunk: boolean;
+  /**
+   * String that should be treated as delimiter between intended chunks if chunk == True. This string will not be included in any chunks. If chunk == True and chunk_delimiter is None, the default chunking algorithm will be used. It is recommended that a delimiter be specified if chunking is enabled.
+   */
+  chunkDelimiter?: string | null | undefined;
+  /**
+   * Information that the data source will provide to the agent accessing it.
+   */
+  text: string;
+};
+
+/** @internal */
+export const DataSourceCreateRequest$inboundSchema: z.ZodType<
+  DataSourceCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  labels: z.array(z.string()).optional(),
+  chunk: z.boolean(),
+  chunk_delimiter: z.nullable(z.string()).optional(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "chunk_delimiter": "chunkDelimiter",
+  });
+});
+
+/** @internal */
+export type DataSourceCreateRequest$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  labels?: Array<string> | undefined;
+  chunk: boolean;
+  chunk_delimiter?: string | null | undefined;
+  text: string;
+};
+
+/** @internal */
+export const DataSourceCreateRequest$outboundSchema: z.ZodType<
+  DataSourceCreateRequest$Outbound,
+  z.ZodTypeDef,
+  DataSourceCreateRequest
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  labels: z.array(z.string()).optional(),
+  chunk: z.boolean(),
+  chunkDelimiter: z.nullable(z.string()).optional(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    chunkDelimiter: "chunk_delimiter",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DataSourceCreateRequest$ {
+  /** @deprecated use `DataSourceCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = DataSourceCreateRequest$inboundSchema;
+  /** @deprecated use `DataSourceCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = DataSourceCreateRequest$outboundSchema;
+  /** @deprecated use `DataSourceCreateRequest$Outbound` instead. */
+  export type Outbound = DataSourceCreateRequest$Outbound;
+}
+
+export function dataSourceCreateRequestToJSON(
+  dataSourceCreateRequest: DataSourceCreateRequest,
+): string {
+  return JSON.stringify(
+    DataSourceCreateRequest$outboundSchema.parse(dataSourceCreateRequest),
+  );
+}
+
+export function dataSourceCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<DataSourceCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataSourceCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataSourceCreateRequest' from JSON`,
+  );
+}

package/src/models/components/datasourcedetailresponse.ts

@@ -0,0 +1,143 @@
+/*
+ * 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";
+
+/**
+ * Metadata about a data source, along with the text.
+ */
+export type DataSourceDetailResponse = {
+  /**
+   * The data source name. Must be unique within suborg.
+   */
+  name: string;
+  /**
+   * The description of the data source.
+   */
+  description?: string | null | undefined;
+  /**
+   * Searchable labels for the data source. Can be included in agent.prompt_tool_defaults for a given tool to give the agent access to data sources with those labels when calling that tool.
+   */
+  labels?: Array<string> | undefined;
+  /**
+   * Whether the content should be split into smaller chunks. This can improve agent performance when searching a large data source but risks some relevant information being left off search results if chunk_delimiter is not set up properly.
+   */
+  chunk: boolean;
+  /**
+   * String that should be treated as delimiter between intended chunks if chunk == True. This string will not be included in any chunks. If chunk == True and chunk_delimiter is None, the default chunking algorithm will be used. It is recommended that a delimiter be specified if chunking is enabled.
+   */
+  chunkDelimiter?: string | null | undefined;
+  /**
+   * The comments for the most recent edit to the data source
+   */
+  editComments?: string | null | undefined;
+  /**
+   * Timestamp of most recent update
+   */
+  updatedAt: Date;
+  /**
+   * Email of the user who last updated the data source
+   */
+  lastUpdatedBy: string | null;
+  /**
+   * Information that the data source will provide to the agent accessing it.
+   */
+  text: string;
+};
+
+/** @internal */
+export const DataSourceDetailResponse$inboundSchema: z.ZodType<
+  DataSourceDetailResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  labels: z.array(z.string()).optional(),
+  chunk: z.boolean(),
+  chunk_delimiter: z.nullable(z.string()).optional(),
+  edit_comments: z.nullable(z.string()).optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  last_updated_by: z.nullable(z.string()),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "chunk_delimiter": "chunkDelimiter",
+    "edit_comments": "editComments",
+    "updated_at": "updatedAt",
+    "last_updated_by": "lastUpdatedBy",
+  });
+});
+
+/** @internal */
+export type DataSourceDetailResponse$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  labels?: Array<string> | undefined;
+  chunk: boolean;
+  chunk_delimiter?: string | null | undefined;
+  edit_comments?: string | null | undefined;
+  updated_at: string;
+  last_updated_by: string | null;
+  text: string;
+};
+
+/** @internal */
+export const DataSourceDetailResponse$outboundSchema: z.ZodType<
+  DataSourceDetailResponse$Outbound,
+  z.ZodTypeDef,
+  DataSourceDetailResponse
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  labels: z.array(z.string()).optional(),
+  chunk: z.boolean(),
+  chunkDelimiter: z.nullable(z.string()).optional(),
+  editComments: z.nullable(z.string()).optional(),
+  updatedAt: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.nullable(z.string()),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    chunkDelimiter: "chunk_delimiter",
+    editComments: "edit_comments",
+    updatedAt: "updated_at",
+    lastUpdatedBy: "last_updated_by",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DataSourceDetailResponse$ {
+  /** @deprecated use `DataSourceDetailResponse$inboundSchema` instead. */
+  export const inboundSchema = DataSourceDetailResponse$inboundSchema;
+  /** @deprecated use `DataSourceDetailResponse$outboundSchema` instead. */
+  export const outboundSchema = DataSourceDetailResponse$outboundSchema;
+  /** @deprecated use `DataSourceDetailResponse$Outbound` instead. */
+  export type Outbound = DataSourceDetailResponse$Outbound;
+}
+
+export function dataSourceDetailResponseToJSON(
+  dataSourceDetailResponse: DataSourceDetailResponse,
+): string {
+  return JSON.stringify(
+    DataSourceDetailResponse$outboundSchema.parse(dataSourceDetailResponse),
+  );
+}
+
+export function dataSourceDetailResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DataSourceDetailResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataSourceDetailResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataSourceDetailResponse' from JSON`,
+  );
+}