syllable-sdk 0.1.0-alpha.177 → 0.1.0-alpha.186

package/src/models/components/permissiongroupresponse.ts

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

package/src/models/components/permissionresponse.ts

@@ -3,6 +3,7 @@
  */
 
 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";
@@ -15,10 +16,14 @@ export type PermissionResponse = {
    * Name of the permission
    */
   name: string;
+  /**
+   * Display name of the permission
+   */
+  displayName: string;
   /**
    * Description of the permission
    */
-  description: string;
+  description?: string | null | undefined;
 };
 
 /** @internal */
@@ -28,13 +33,19 @@ export const PermissionResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.string(),
-  description: z.string(),
+  display_name: z.string(),
+  description: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+  });
 });
 
 /** @internal */
 export type PermissionResponse$Outbound = {
   name: string;
-  description: string;
+  display_name: string;
+  description?: string | null | undefined;
 };
 
 /** @internal */
@@ -44,7 +55,12 @@ export const PermissionResponse$outboundSchema: z.ZodType<
   PermissionResponse
 > = z.object({
   name: z.string(),
-  description: z.string(),
+  displayName: z.string(),
+  description: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+  });
 });
 
 /**

package/src/models/components/userproperties.ts

@@ -13,6 +13,8 @@ export const UserProperties = {
   FirstName: "first_name",
   LastName: "last_name",
   RoleId: "role_id",
+  EmailFirstNameLastName: "email_first_name_last_name",
+  LastUpdated: "last_updated",
 } as const;
 /**
  * Names of user fields supported for filtering/sorting on list endpoint.

package/src/models/components/userresponse.ts

@@ -36,6 +36,10 @@ export type UserResponse = {
    * Internal ID of the user
    */
   id: number;
+  /**
+   * Name of the role assigned to the user
+   */
+  roleName: string;
   /**
    * The timestamp of the most recent update to the user
    */
@@ -62,6 +66,7 @@ export const UserResponse$inboundSchema: z.ZodType<
   role_id: z.number().int(),
   last_updated_comments: z.nullable(z.string()).optional(),
   id: z.number().int(),
+  role_name: z.string(),
   last_updated: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ),
@@ -75,6 +80,7 @@ export const UserResponse$inboundSchema: z.ZodType<
     "last_name": "lastName",
     "role_id": "roleId",
     "last_updated_comments": "lastUpdatedComments",
+    "role_name": "roleName",
     "last_updated": "lastUpdated",
     "last_updated_by": "lastUpdatedBy",
     "last_session_at": "lastSessionAt",
@@ -89,6 +95,7 @@ export type UserResponse$Outbound = {
   role_id: number;
   last_updated_comments?: string | null | undefined;
   id: number;
+  role_name: string;
   last_updated: string;
   last_updated_by?: string | null | undefined;
   last_session_at?: string | null | undefined;
@@ -106,6 +113,7 @@ export const UserResponse$outboundSchema: z.ZodType<
   roleId: z.number().int(),
   lastUpdatedComments: z.nullable(z.string()).optional(),
   id: z.number().int(),
+  roleName: z.string(),
   lastUpdated: z.date().transform(v => v.toISOString()),
   lastUpdatedBy: z.nullable(z.string()).optional(),
   lastSessionAt: z.nullable(z.date().transform(v => v.toISOString()))
@@ -116,6 +124,7 @@ export const UserResponse$outboundSchema: z.ZodType<
     lastName: "last_name",
     roleId: "role_id",
     lastUpdatedComments: "last_updated_comments",
+    roleName: "role_name",
     lastUpdated: "last_updated",
     lastUpdatedBy: "last_updated_by",
     lastSessionAt: "last_session_at",

package/src/models/operations/rolesdelete.ts

@@ -9,8 +9,18 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type RolesDeleteRequest = {
+  /**
+   * The ID of the role to delete
+   */
   roleId: number;
+  /**
+   * The reason for deleting the role
+   */
   reason: string;
+  /**
+   * Users with the deleted role will be reassigned to the new role, if a new role ID is provided
+   */
+  newRoleId?: number | null | undefined;
 };
 
 /** @internal */
@@ -21,9 +31,11 @@ export const RolesDeleteRequest$inboundSchema: z.ZodType<
 > = z.object({
   role_id: z.number().int(),
   reason: z.string(),
+  new_role_id: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "role_id": "roleId",
+    "new_role_id": "newRoleId",
   });
 });
 
@@ -31,6 +43,7 @@ export const RolesDeleteRequest$inboundSchema: z.ZodType<
 export type RolesDeleteRequest$Outbound = {
   role_id: number;
   reason: string;
+  new_role_id?: number | null | undefined;
 };
 
 /** @internal */
@@ -41,9 +54,11 @@ export const RolesDeleteRequest$outboundSchema: z.ZodType<
 > = z.object({
   roleId: z.number().int(),
   reason: z.string(),
+  newRoleId: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
     roleId: "role_id",
+    newRoleId: "new_role_id",
   });
 });
 

package/src/sdk/permissions.ts

@@ -16,7 +16,7 @@ export class Permissions extends ClientSDK {
    */
   async list(
     options?: RequestOptions,
-  ): Promise<Array<components.PermissionResponse>> {
+  ): Promise<Array<components.PermissionGroupResponse>> {
     return unwrapAsync(permissionsList(
       this,
       options,

package/src/sdk/roles.ts

@@ -85,7 +85,7 @@ export class Roles extends ClientSDK {
    * Delete Role
    *
    * @remarks
-   * Delete a role.
+   * Delete a role. Optionally, reassign existing users with that role to a new role.
    */
   async delete(
     request: operations.RolesDeleteRequest,