syllable-sdk 0.1.0-alpha.158 → 0.1.0-alpha.161

package/src/funcs/permissionsList.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { SyllableSDKCore } from "../core.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.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 { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List Permissions
+ *
+ * @remarks
+ * Get all available permissions in the system.
+ */
+export async function permissionsList(
+  client: SyllableSDKCore,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    Array<components.PermissionResponse>,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const path = pathToFunc("/api/v1/permissions/")();
+
+  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 = {
+    baseURL: options?.serverURL ?? "",
+    operationID: "permissions_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,
+    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: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    Array<components.PermissionResponse>,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, z.array(components.PermissionResponse$inboundSchema)),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/takeoutsTakeoutsGetFile.ts

@@ -33,7 +33,7 @@ export async function takeoutsTakeoutsGetFile(
   options?: RequestOptions,
 ): Promise<
   Result<
-    any,
+    string,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -71,7 +71,7 @@ export async function takeoutsTakeoutsGetFile(
   );
 
   const headers = new Headers(compactMap({
-    Accept: "application/json",
+    Accept: "application/zip",
   }));
 
   const secConfig = await extractSecurity(client._options.apiKeyHeader);
@@ -122,7 +122,7 @@ export async function takeoutsTakeoutsGetFile(
   };
 
   const [result] = await M.match<
-    any,
+    string,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -132,7 +132,7 @@ export async function takeoutsTakeoutsGetFile(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, z.any()),
+    M.text(200, z.string(), { ctype: "application/zip" }),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/lib/config.ts

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

package/src/models/components/index.ts

@@ -125,6 +125,8 @@ export * from "./listresponsetoolresponse.js";
 export * from "./orderbydirection.js";
 export * from "./outboundcampaign.js";
 export * from "./outboundcampaigninput.js";
+export * from "./permissionresponse.js";
+export * from "./permissions.js";
 export * from "./promptcreaterequest.js";
 export * from "./prompthistory.js";
 export * from "./promptllmconfig.js";

package/src/models/components/insightworkflowcondition.ts

@@ -8,7 +8,10 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type AgentList = string | number;
+/**
+ * List of agent IDs
+ */
+export type AgentList = Array<number> | Array<string>;
 
 /**
  * Model for the conditions that trigger an insight workflow.
@@ -29,7 +32,7 @@ export type InsightWorkflowCondition = {
   /**
    * List of agent IDs
    */
-  agentList?: Array<string | number> | null | undefined;
+  agentList?: Array<number> | Array<string> | null | undefined;
   /**
    * List of prompts IDs
    */
@@ -45,17 +48,17 @@ export const AgentList$inboundSchema: z.ZodType<
   AgentList,
   z.ZodTypeDef,
   unknown
-> = z.union([z.string(), z.number().int()]);
+> = z.union([z.array(z.number().int()), z.array(z.string())]);
 
 /** @internal */
-export type AgentList$Outbound = string | number;
+export type AgentList$Outbound = Array<number> | Array<string>;
 
 /** @internal */
 export const AgentList$outboundSchema: z.ZodType<
   AgentList$Outbound,
   z.ZodTypeDef,
   AgentList
-> = z.union([z.string(), z.number().int()]);
+> = z.union([z.array(z.number().int()), z.array(z.string())]);
 
 /**
  * @internal
@@ -93,8 +96,9 @@ export const InsightWorkflowCondition$inboundSchema: z.ZodType<
   min_duration: z.nullable(z.number().int()).optional(),
   max_duration: z.nullable(z.number().int()).optional(),
   sample_rate: z.nullable(z.number().int()).optional(),
-  agent_list: z.nullable(z.array(z.union([z.string(), z.number().int()])))
-    .optional(),
+  agent_list: z.nullable(
+    z.union([z.array(z.number().int()), z.array(z.string())]),
+  ).optional(),
   prompt_list: z.nullable(z.array(z.string())).optional(),
   folder_list: z.nullable(z.array(z.number().int())).optional(),
 }).transform((v) => {
@@ -113,7 +117,7 @@ export type InsightWorkflowCondition$Outbound = {
   min_duration?: number | null | undefined;
   max_duration?: number | null | undefined;
   sample_rate?: number | null | undefined;
-  agent_list?: Array<string | number> | null | undefined;
+  agent_list?: Array<number> | Array<string> | null | undefined;
   prompt_list?: Array<string> | null | undefined;
   folder_list?: Array<number> | null | undefined;
 };
@@ -127,8 +131,9 @@ export const InsightWorkflowCondition$outboundSchema: z.ZodType<
   minDuration: z.nullable(z.number().int()).optional(),
   maxDuration: z.nullable(z.number().int()).optional(),
   sampleRate: z.nullable(z.number().int()).optional(),
-  agentList: z.nullable(z.array(z.union([z.string(), z.number().int()])))
-    .optional(),
+  agentList: z.nullable(
+    z.union([z.array(z.number().int()), z.array(z.string())]),
+  ).optional(),
   promptList: z.nullable(z.array(z.string())).optional(),
   folderList: z.nullable(z.array(z.number().int())).optional(),
 }).transform((v) => {

package/src/models/components/permissionresponse.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 {
+  Permissions,
+  Permissions$inboundSchema,
+  Permissions$outboundSchema,
+} from "./permissions.js";
+
+/**
+ * Information about a permission.
+ */
+export type PermissionResponse = {
+  name: Permissions;
+  /**
+   * Description of the permission
+   */
+  description: string;
+};
+
+/** @internal */
+export const PermissionResponse$inboundSchema: z.ZodType<
+  PermissionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: Permissions$inboundSchema,
+  description: z.string(),
+});
+
+/** @internal */
+export type PermissionResponse$Outbound = {
+  name: string;
+  description: string;
+};
+
+/** @internal */
+export const PermissionResponse$outboundSchema: z.ZodType<
+  PermissionResponse$Outbound,
+  z.ZodTypeDef,
+  PermissionResponse
+> = z.object({
+  name: Permissions$outboundSchema,
+  description: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PermissionResponse$ {
+  /** @deprecated use `PermissionResponse$inboundSchema` instead. */
+  export const inboundSchema = PermissionResponse$inboundSchema;
+  /** @deprecated use `PermissionResponse$outboundSchema` instead. */
+  export const outboundSchema = PermissionResponse$outboundSchema;
+  /** @deprecated use `PermissionResponse$Outbound` instead. */
+  export type Outbound = PermissionResponse$Outbound;
+}
+
+export function permissionResponseToJSON(
+  permissionResponse: PermissionResponse,
+): string {
+  return JSON.stringify(
+    PermissionResponse$outboundSchema.parse(permissionResponse),
+  );
+}
+
+export function permissionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PermissionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PermissionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PermissionResponse' from JSON`,
+  );
+}

package/src/models/components/permissions.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const Permissions = {
+  AgentsRead: "agents_read",
+  AgentsWrite: "agents_write",
+  AgentsDelete: "agents_delete",
+  ApiTokenRead: "api_token_read",
+  ApiTokenWrite: "api_token_write",
+  ApiTokenDelete: "api_token_delete",
+  ChannelsRead: "channels_read",
+  ChannelsWrite: "channels_write",
+  ChannelsDelete: "channels_delete",
+  Chat: "chat",
+  ConversationsRead: "conversations_read",
+  CustomMessagesRead: "custom_messages_read",
+  CustomMessagesWrite: "custom_messages_write",
+  CustomMessagesDelete: "custom_messages_delete",
+  DataSourcesRead: "data_sources_read",
+  DataSourcesWrite: "data_sources_write",
+  DataSourcesDelete: "data_sources_delete",
+  DirectoryRead: "directory_read",
+  DirectoryWrite: "directory_write",
+  DirectoryDelete: "directory_delete",
+  EventsRead: "events_read",
+  IncidentsRead: "incidents_read",
+  InsightsRead: "insights_read",
+  InsightsWrite: "insights_write",
+  InsightsDelete: "insights_delete",
+  IntegrationsRead: "integrations_read",
+  IntegrationsWrite: "integrations_write",
+  IntegrationsDelete: "integrations_delete",
+  LanguageGroupsRead: "language_groups_read",
+  LanguageGroupsWrite: "language_groups_write",
+  LanguageGroupsDelete: "language_groups_delete",
+  OrganizationsRead: "organizations_read",
+  OrganizationsWrite: "organizations_write",
+  OutboundRead: "outbound_read",
+  OutboundWrite: "outbound_write",
+  OutboundDelete: "outbound_delete",
+  PermissionsRead: "permissions_read",
+  PromptsRead: "prompts_read",
+  PromptsWrite: "prompts_write",
+  PromptsDelete: "prompts_delete",
+  RecordingDownload: "recording_download",
+  ReportsRead: "reports_read",
+  ServicesRead: "services_read",
+  ServicesWrite: "services_write",
+  ServicesDelete: "services_delete",
+  SessionLabelsRead: "session_labels_read",
+  SessionLabelsWrite: "session_labels_write",
+  SessionsRead: "sessions_read",
+  ToolsRead: "tools_read",
+  ToolsWrite: "tools_write",
+  ToolsDelete: "tools_delete",
+  UsersRead: "users_read",
+  UsersWrite: "users_write",
+  UsersDelete: "users_delete",
+  SaIncidentsRead: "sa_incidents_read",
+  SaIncidentsWrite: "sa_incidents_write",
+  SaIncidentsDelete: "sa_incidents_delete",
+  SaPermissionsRead: "sa_permissions_read",
+  SuperAdminGlobal: "super_admin_global",
+} as const;
+export type Permissions = ClosedEnum<typeof Permissions>;
+
+/** @internal */
+export const Permissions$inboundSchema: z.ZodNativeEnum<typeof Permissions> = z
+  .nativeEnum(Permissions);
+
+/** @internal */
+export const Permissions$outboundSchema: z.ZodNativeEnum<typeof Permissions> =
+  Permissions$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Permissions$ {
+  /** @deprecated use `Permissions$inboundSchema` instead. */
+  export const inboundSchema = Permissions$inboundSchema;
+  /** @deprecated use `Permissions$outboundSchema` instead. */
+  export const outboundSchema = Permissions$outboundSchema;
+}

package/src/sdk/permissions.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { permissionsList } from "../funcs/permissionsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Permissions extends ClientSDK {
+  /**
+   * List Permissions
+   *
+   * @remarks
+   * Get all available permissions in the system.
+   */
+  async list(
+    options?: RequestOptions,
+  ): Promise<Array<components.PermissionResponse>> {
+    return unwrapAsync(permissionsList(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -14,6 +14,7 @@ import { Incidents } from "./incidents.js";
 import { Insights } from "./insights.js";
 import { LanguageGroups } from "./languagegroups.js";
 import { Outbound } from "./outbound.js";
+import { Permissions } from "./permissions.js";
 import { Prompts } from "./prompts.js";
 import { Services } from "./services.js";
 import { SessionDebug } from "./sessiondebug.js";
@@ -65,6 +66,11 @@ export class SyllableSDK extends ClientSDK {
     return (this._customMessages ??= new CustomMessages(this._options));
   }
 
+  private _permissions?: Permissions;
+  get permissions(): Permissions {
+    return (this._permissions ??= new Permissions(this._options));
+  }
+
   private _prompts?: Prompts;
   get prompts(): Prompts {
     return (this._prompts ??= new Prompts(this._options));

package/src/sdk/takeouts.ts

@@ -43,7 +43,7 @@ export class Takeouts extends ClientSDK {
   async takeoutsGetFile(
     request: operations.TakeoutsGetFileRequest,
     options?: RequestOptions,
-  ): Promise<any> {
+  ): Promise<string> {
     return unwrapAsync(takeoutsTakeoutsGetFile(
       this,
       request,