syllable-sdk 0.1.0-alpha.163 → 0.1.0-alpha.168

package/src/funcs/rolesList.ts

@@ -0,0 +1,148 @@
+/*
+ * 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 Roles
+ *
+ * @remarks
+ * List the existing roles.
+ */
+export async function rolesList(
+  client: SyllableSDKCore,
+  request: operations.RolesListRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.ListResponseRoleResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.RolesListRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/api/v1/roles/")();
+
+  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 = {
+    baseURL: options?.serverURL ?? "",
+    operationID: "roles_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.ListResponseRoleResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.ListResponseRoleResponse$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/rolesUpdate.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 Role
+ *
+ * @remarks
+ * Update an existing role.
+ */
+export async function rolesUpdate(
+  client: SyllableSDKCore,
+  request: components.RoleUpdateRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.RoleResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.RoleUpdateRequest$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/roles/")();
+
+  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 = {
+    baseURL: options?.serverURL ?? "",
+    operationID: "roles_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.RoleResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.RoleResponse$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/takeoutsTakeoutsGetFile.ts

@@ -33,7 +33,7 @@ export async function takeoutsTakeoutsGetFile(
   options?: RequestOptions,
 ): Promise<
   Result<
-    string,
+    ReadableStream<Uint8Array>,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -122,7 +122,7 @@ export async function takeoutsTakeoutsGetFile(
   };
 
   const [result] = await M.match<
-    string,
+    ReadableStream<Uint8Array>,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -132,7 +132,9 @@ export async function takeoutsTakeoutsGetFile(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.text(200, z.string(), { ctype: "application/zip" }),
+    M.stream(200, z.instanceof(ReadableStream<Uint8Array>), {
+      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.163",
+  sdkVersion: "0.1.0-alpha.168",
   genVersion: "2.512.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.163 2.512.4 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.168 2.512.4 0.0.2 syllable-sdk",
 } as const;

package/src/models/components/agentcreate.ts

@@ -37,9 +37,15 @@ export type AgentCreate = {
    */
   description?: string | null | undefined;
   /**
-   * The agent label
+   * The agent label (DEPRECATED - use labels instead.)
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   label?: string | null | undefined;
+  /**
+   * The agent labels
+   */
+  labels?: Array<string> | null | undefined;
   /**
    * The agent type. Must be "ca_v1" currently.
    */
@@ -101,6 +107,7 @@ export const AgentCreate$inboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
+  labels: z.nullable(z.array(z.string())).optional(),
   type: z.string(),
   prompt_id: z.number().int(),
   custom_message_id: z.number().int(),
@@ -131,6 +138,7 @@ export type AgentCreate$Outbound = {
   name: string;
   description?: string | null | undefined;
   label?: string | null | undefined;
+  labels?: Array<string> | null | undefined;
   type: string;
   prompt_id: number;
   custom_message_id: number;
@@ -154,6 +162,7 @@ export const AgentCreate$outboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
+  labels: z.nullable(z.array(z.string())).optional(),
   type: z.string(),
   promptId: z.number().int(),
   customMessageId: z.number().int(),

package/src/models/components/agentproperties.ts

@@ -14,6 +14,7 @@ export const AgentProperties = {
   NameExact: "name_exact",
   Description: "description",
   Label: "label",
+  Labels: "labels",
   NameDescription: "name_description",
   Type: "type",
   Timezone: "timezone",

package/src/models/components/agentresponse.ts

@@ -63,9 +63,15 @@ export type AgentResponse = {
    */
   description?: string | null | undefined;
   /**
-   * The agent label
+   * The agent label (DEPRECATED - use labels instead.)
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   label?: string | null | undefined;
+  /**
+   * The agent labels
+   */
+  labels?: Array<string> | null | undefined;
   /**
    * The agent type. Must be "ca_v1" currently.
    */
@@ -159,6 +165,7 @@ export const AgentResponse$inboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
+  labels: z.nullable(z.array(z.string())).optional(),
   type: z.string(),
   prompt_id: z.number().int(),
   custom_message_id: z.number().int(),
@@ -204,6 +211,7 @@ export type AgentResponse$Outbound = {
   name: string;
   description?: string | null | undefined;
   label?: string | null | undefined;
+  labels?: Array<string> | null | undefined;
   type: string;
   prompt_id: number;
   custom_message_id: number;
@@ -235,6 +243,7 @@ export const AgentResponse$outboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
+  labels: z.nullable(z.array(z.string())).optional(),
   type: z.string(),
   promptId: z.number().int(),
   customMessageId: z.number().int(),

package/src/models/components/agentupdate.ts

@@ -37,9 +37,15 @@ export type AgentUpdate = {
    */
   description?: string | null | undefined;
   /**
-   * The agent label
+   * The agent label (DEPRECATED - use labels instead.)
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   label?: string | null | undefined;
+  /**
+   * The agent labels
+   */
+  labels?: Array<string> | null | undefined;
   /**
    * The agent type. Must be "ca_v1" currently.
    */
@@ -105,6 +111,7 @@ export const AgentUpdate$inboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
+  labels: z.nullable(z.array(z.string())).optional(),
   type: z.string(),
   prompt_id: z.number().int(),
   custom_message_id: z.number().int(),
@@ -136,6 +143,7 @@ export type AgentUpdate$Outbound = {
   name: string;
   description?: string | null | undefined;
   label?: string | null | undefined;
+  labels?: Array<string> | null | undefined;
   type: string;
   prompt_id: number;
   custom_message_id: number;
@@ -160,6 +168,7 @@ export const AgentUpdate$outboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
+  labels: z.nullable(z.array(z.string())).optional(),
   type: z.string(),
   promptId: z.number().int(),
   customMessageId: z.number().int(),

package/src/models/components/index.ts

@@ -118,6 +118,7 @@ export * from "./listresponseinsightworkflowoutput.js";
 export * from "./listresponselanguagegroupresponse.js";
 export * from "./listresponseoutboundcampaign.js";
 export * from "./listresponsepromptresponse.js";
+export * from "./listresponseroleresponse.js";
 export * from "./listresponseserviceresponse.js";
 export * from "./listresponsesession.js";
 export * from "./listresponsesessionlabel.js";
@@ -126,7 +127,6 @@ 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";
@@ -135,6 +135,10 @@ export * from "./promptproperties.js";
 export * from "./promptresponse.js";
 export * from "./promptupdaterequest.js";
 export * from "./requeststatus.js";
+export * from "./rolecreaterequest.js";
+export * from "./roleproperties.js";
+export * from "./roleresponse.js";
+export * from "./roleupdaterequest.js";
 export * from "./security.js";
 export * from "./servicecreaterequest.js";
 export * from "./serviceproperties.js";

package/src/models/components/listresponseroleresponse.ts

@@ -0,0 +1,116 @@
+/*
+ * 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 {
+  RoleResponse,
+  RoleResponse$inboundSchema,
+  RoleResponse$Outbound,
+  RoleResponse$outboundSchema,
+} from "./roleresponse.js";
+
+export type ListResponseRoleResponse = {
+  /**
+   * List of items returned from the query
+   */
+  items: Array<RoleResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
+  page: number;
+  /**
+   * The number of items returned per page
+   */
+  pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
+  totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseRoleResponse$inboundSchema: z.ZodType<
+  ListResponseRoleResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(RoleResponse$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseRoleResponse$Outbound = {
+  items: Array<RoleResponse$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseRoleResponse$outboundSchema: z.ZodType<
+  ListResponseRoleResponse$Outbound,
+  z.ZodTypeDef,
+  ListResponseRoleResponse
+> = z.object({
+  items: z.array(RoleResponse$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseRoleResponse$ {
+  /** @deprecated use `ListResponseRoleResponse$inboundSchema` instead. */
+  export const inboundSchema = ListResponseRoleResponse$inboundSchema;
+  /** @deprecated use `ListResponseRoleResponse$outboundSchema` instead. */
+  export const outboundSchema = ListResponseRoleResponse$outboundSchema;
+  /** @deprecated use `ListResponseRoleResponse$Outbound` instead. */
+  export type Outbound = ListResponseRoleResponse$Outbound;
+}
+
+export function listResponseRoleResponseToJSON(
+  listResponseRoleResponse: ListResponseRoleResponse,
+): string {
+  return JSON.stringify(
+    ListResponseRoleResponse$outboundSchema.parse(listResponseRoleResponse),
+  );
+}
+
+export function listResponseRoleResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseRoleResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseRoleResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseRoleResponse' from JSON`,
+  );
+}

package/src/models/components/permissionresponse.ts

@@ -6,17 +6,15 @@ 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;
+  /**
+   * Name of the permission
+   */
+  name: string;
   /**
    * Description of the permission
    */
@@ -29,7 +27,7 @@ export const PermissionResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  name: Permissions$inboundSchema,
+  name: z.string(),
   description: z.string(),
 });
 
@@ -45,7 +43,7 @@ export const PermissionResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PermissionResponse
 > = z.object({
-  name: Permissions$outboundSchema,
+  name: z.string(),
   description: z.string(),
 });