syllable-sdk 0.1.0-alpha.192 → 0.1.0-alpha.196

package/src/models/components/usercreaterequest.ts

@@ -7,6 +7,11 @@ 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 {
+  LoginType,
+  LoginType$inboundSchema,
+  LoginType$outboundSchema,
+} from "./logintype.js";
 
 /**
  * Request model to create a user.
@@ -28,6 +33,10 @@ export type UserCreateRequest = {
    * ID of the role assigned to the user
    */
   roleId: number;
+  /**
+   * The type of login to use for the user. If not provided, defaults to google for @gmail.com email addresses, and username and password otherwise.
+   */
+  loginType?: LoginType | null | undefined;
 };
 
 /** @internal */
@@ -40,11 +49,13 @@ export const UserCreateRequest$inboundSchema: z.ZodType<
   first_name: z.nullable(z.string()).optional(),
   last_name: z.nullable(z.string()).optional(),
   role_id: z.number().int(),
+  login_type: z.nullable(LoginType$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "first_name": "firstName",
     "last_name": "lastName",
     "role_id": "roleId",
+    "login_type": "loginType",
   });
 });
 
@@ -54,6 +65,7 @@ export type UserCreateRequest$Outbound = {
   first_name?: string | null | undefined;
   last_name?: string | null | undefined;
   role_id: number;
+  login_type?: string | null | undefined;
 };
 
 /** @internal */
@@ -66,11 +78,13 @@ export const UserCreateRequest$outboundSchema: z.ZodType<
   firstName: z.nullable(z.string()).optional(),
   lastName: z.nullable(z.string()).optional(),
   roleId: z.number().int(),
+  loginType: z.nullable(LoginType$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     firstName: "first_name",
     lastName: "last_name",
     roleId: "role_id",
+    loginType: "login_type",
   });
 });
 

package/src/models/components/userproperties.ts

@@ -13,7 +13,9 @@ export const UserProperties = {
   FirstName: "first_name",
   LastName: "last_name",
   RoleId: "role_id",
+  RoleName: "role_name",
   EmailFirstNameLastName: "email_first_name_last_name",
+  ActivityStatus: "activity_status",
   LastUpdated: "last_updated",
 } as const;
 /**

package/src/models/components/userresponse.ts

@@ -7,6 +7,11 @@ 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 {
+  UserActivityStatus,
+  UserActivityStatus$inboundSchema,
+  UserActivityStatus$outboundSchema,
+} from "./useractivitystatus.js";
 
 /**
  * Information about a user.
@@ -40,6 +45,11 @@ export type UserResponse = {
    * Name of the role assigned to the user
    */
   roleName: string;
+  /**
+   * Whether the welcome email has been sent to the user
+   */
+  emailSent: boolean;
+  activityStatus: UserActivityStatus;
   /**
    * The timestamp of the most recent update to the user
    */
@@ -67,6 +77,8 @@ export const UserResponse$inboundSchema: z.ZodType<
   last_updated_comments: z.nullable(z.string()).optional(),
   id: z.number().int(),
   role_name: z.string(),
+  email_sent: z.boolean(),
+  activity_status: UserActivityStatus$inboundSchema,
   last_updated: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ),
@@ -81,6 +93,8 @@ export const UserResponse$inboundSchema: z.ZodType<
     "role_id": "roleId",
     "last_updated_comments": "lastUpdatedComments",
     "role_name": "roleName",
+    "email_sent": "emailSent",
+    "activity_status": "activityStatus",
     "last_updated": "lastUpdated",
     "last_updated_by": "lastUpdatedBy",
     "last_session_at": "lastSessionAt",
@@ -96,6 +110,8 @@ export type UserResponse$Outbound = {
   last_updated_comments?: string | null | undefined;
   id: number;
   role_name: string;
+  email_sent: boolean;
+  activity_status: string;
   last_updated: string;
   last_updated_by?: string | null | undefined;
   last_session_at?: string | null | undefined;
@@ -114,6 +130,8 @@ export const UserResponse$outboundSchema: z.ZodType<
   lastUpdatedComments: z.nullable(z.string()).optional(),
   id: z.number().int(),
   roleName: z.string(),
+  emailSent: z.boolean(),
+  activityStatus: UserActivityStatus$outboundSchema,
   lastUpdated: z.date().transform(v => v.toISOString()),
   lastUpdatedBy: z.nullable(z.string()).optional(),
   lastSessionAt: z.nullable(z.date().transform(v => v.toISOString()))
@@ -125,6 +143,8 @@ export const UserResponse$outboundSchema: z.ZodType<
     roleId: "role_id",
     lastUpdatedComments: "last_updated_comments",
     roleName: "role_name",
+    emailSent: "email_sent",
+    activityStatus: "activity_status",
     lastUpdated: "last_updated",
     lastUpdatedBy: "last_updated_by",
     lastSessionAt: "last_session_at",

package/src/models/operations/index.ts

@@ -91,3 +91,4 @@ export * from "./toolgetbyname.js";
 export * from "./toollist.js";
 export * from "./usersgetbyemail.js";
 export * from "./userslist.js";
+export * from "./userssendemail.js";

package/src/models/operations/userssendemail.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 UsersSendEmailRequest = {
+  userEmail: string;
+};
+
+/** @internal */
+export const UsersSendEmailRequest$inboundSchema: z.ZodType<
+  UsersSendEmailRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  user_email: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "user_email": "userEmail",
+  });
+});
+
+/** @internal */
+export type UsersSendEmailRequest$Outbound = {
+  user_email: string;
+};
+
+/** @internal */
+export const UsersSendEmailRequest$outboundSchema: z.ZodType<
+  UsersSendEmailRequest$Outbound,
+  z.ZodTypeDef,
+  UsersSendEmailRequest
+> = z.object({
+  userEmail: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    userEmail: "user_email",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UsersSendEmailRequest$ {
+  /** @deprecated use `UsersSendEmailRequest$inboundSchema` instead. */
+  export const inboundSchema = UsersSendEmailRequest$inboundSchema;
+  /** @deprecated use `UsersSendEmailRequest$outboundSchema` instead. */
+  export const outboundSchema = UsersSendEmailRequest$outboundSchema;
+  /** @deprecated use `UsersSendEmailRequest$Outbound` instead. */
+  export type Outbound = UsersSendEmailRequest$Outbound;
+}
+
+export function usersSendEmailRequestToJSON(
+  usersSendEmailRequest: UsersSendEmailRequest,
+): string {
+  return JSON.stringify(
+    UsersSendEmailRequest$outboundSchema.parse(usersSendEmailRequest),
+  );
+}
+
+export function usersSendEmailRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UsersSendEmailRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UsersSendEmailRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UsersSendEmailRequest' from JSON`,
+  );
+}

package/src/sdk/users.ts

@@ -8,6 +8,7 @@ import { usersList } from "../funcs/usersList.js";
 import { usersUpdate } from "../funcs/usersUpdate.js";
 import { usersUsersDeleteAccount } from "../funcs/usersUsersDeleteAccount.js";
 import { usersUsersGetByEmail } from "../funcs/usersUsersGetByEmail.js";
+import { usersUsersSendEmail } from "../funcs/usersUsersSendEmail.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -99,6 +100,23 @@ export class Users extends ClientSDK {
     ));
   }
 
+  /**
+   * Send User Email
+   *
+   * @remarks
+   * Send a welcome email to a user.
+   */
+  async usersSendEmail(
+    request: operations.UsersSendEmailRequest,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(usersUsersSendEmail(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Request Removal Of This Account
    *

package/src/sdk/v1.ts

@@ -8,6 +8,7 @@ import { v1List } from "../funcs/v1List.js";
 import { v1Update } from "../funcs/v1Update.js";
 import { v1UsersDeleteAccount } from "../funcs/v1UsersDeleteAccount.js";
 import { v1UsersGetByEmail } from "../funcs/v1UsersGetByEmail.js";
+import { v1UsersSendEmail } from "../funcs/v1UsersSendEmail.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -99,6 +100,23 @@ export class V1 extends ClientSDK {
     ));
   }
 
+  /**
+   * Send User Email
+   *
+   * @remarks
+   * Send a welcome email to a user.
+   */
+  async usersSendEmail(
+    request: operations.UsersSendEmailRequest,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(v1UsersSendEmail(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Request Removal Of This Account
    *