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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/README.md +4 -0
  2. package/docs/sdks/batches/README.md +4 -4
  3. package/docs/sdks/roles/README.md +4 -4
  4. package/docs/sdks/users/README.md +86 -8
  5. package/docs/sdks/v1/README.md +86 -8
  6. package/docs/sdks/workflows/README.md +8 -8
  7. package/funcs/usersUsersSendEmail.d.ts +16 -0
  8. package/funcs/usersUsersSendEmail.d.ts.map +1 -0
  9. package/funcs/usersUsersSendEmail.js +108 -0
  10. package/funcs/usersUsersSendEmail.js.map +1 -0
  11. package/funcs/v1UsersSendEmail.d.ts +16 -0
  12. package/funcs/v1UsersSendEmail.d.ts.map +1 -0
  13. package/funcs/v1UsersSendEmail.js +108 -0
  14. package/funcs/v1UsersSendEmail.js.map +1 -0
  15. package/jsr.json +1 -1
  16. package/lib/config.d.ts +2 -2
  17. package/lib/config.js +2 -2
  18. package/models/components/agentvoicedisplayname.d.ts +144 -0
  19. package/models/components/agentvoicedisplayname.d.ts.map +1 -1
  20. package/models/components/agentvoicedisplayname.js +48 -0
  21. package/models/components/agentvoicedisplayname.js.map +1 -1
  22. package/models/components/agentvoicemodel.d.ts +3 -0
  23. package/models/components/agentvoicemodel.d.ts.map +1 -1
  24. package/models/components/agentvoicemodel.js +1 -0
  25. package/models/components/agentvoicemodel.js.map +1 -1
  26. package/models/components/agentvoicevarname.d.ts +144 -0
  27. package/models/components/agentvoicevarname.d.ts.map +1 -1
  28. package/models/components/agentvoicevarname.js +48 -0
  29. package/models/components/agentvoicevarname.js.map +1 -1
  30. package/models/components/index.d.ts +1 -0
  31. package/models/components/index.d.ts.map +1 -1
  32. package/models/components/index.js +1 -0
  33. package/models/components/index.js.map +1 -1
  34. package/models/components/useractivitystatus.d.ts +31 -0
  35. package/models/components/useractivitystatus.d.ts.map +1 -0
  36. package/models/components/useractivitystatus.js +51 -0
  37. package/models/components/useractivitystatus.js.map +1 -0
  38. package/models/components/userproperties.d.ts +6 -0
  39. package/models/components/userproperties.d.ts.map +1 -1
  40. package/models/components/userproperties.js +2 -0
  41. package/models/components/userproperties.js.map +1 -1
  42. package/models/components/userresponse.d.ts +8 -0
  43. package/models/components/userresponse.d.ts.map +1 -1
  44. package/models/components/userresponse.js +9 -0
  45. package/models/components/userresponse.js.map +1 -1
  46. package/models/operations/index.d.ts +1 -0
  47. package/models/operations/index.d.ts.map +1 -1
  48. package/models/operations/index.js +1 -0
  49. package/models/operations/index.js.map +1 -1
  50. package/models/operations/userssendemail.d.ts +29 -0
  51. package/models/operations/userssendemail.d.ts.map +1 -0
  52. package/models/operations/userssendemail.js +68 -0
  53. package/models/operations/userssendemail.js.map +1 -0
  54. package/openapi.json +215 -43
  55. package/package.json +1 -1
  56. package/sdk/users.d.ts +7 -0
  57. package/sdk/users.d.ts.map +1 -1
  58. package/sdk/users.js +10 -0
  59. package/sdk/users.js.map +1 -1
  60. package/sdk/v1.d.ts +7 -0
  61. package/sdk/v1.d.ts.map +1 -1
  62. package/sdk/v1.js +10 -0
  63. package/sdk/v1.js.map +1 -1
  64. package/src/funcs/usersUsersSendEmail.ts +142 -0
  65. package/src/funcs/v1UsersSendEmail.ts +142 -0
  66. package/src/lib/config.ts +2 -2
  67. package/src/models/components/agentvoicedisplayname.ts +48 -0
  68. package/src/models/components/agentvoicemodel.ts +1 -0
  69. package/src/models/components/agentvoicevarname.ts +48 -0
  70. package/src/models/components/index.ts +1 -0
  71. package/src/models/components/useractivitystatus.ts +34 -0
  72. package/src/models/components/userproperties.ts +2 -0
  73. package/src/models/components/userresponse.ts +20 -0
  74. package/src/models/operations/index.ts +1 -0
  75. package/src/models/operations/userssendemail.ts +75 -0
  76. package/src/sdk/users.ts +18 -0
  77. package/src/sdk/v1.ts +18 -0
@@ -0,0 +1,75 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+
11
+ export type UsersSendEmailRequest = {
12
+ userEmail: string;
13
+ };
14
+
15
+ /** @internal */
16
+ export const UsersSendEmailRequest$inboundSchema: z.ZodType<
17
+ UsersSendEmailRequest,
18
+ z.ZodTypeDef,
19
+ unknown
20
+ > = z.object({
21
+ user_email: z.string(),
22
+ }).transform((v) => {
23
+ return remap$(v, {
24
+ "user_email": "userEmail",
25
+ });
26
+ });
27
+
28
+ /** @internal */
29
+ export type UsersSendEmailRequest$Outbound = {
30
+ user_email: string;
31
+ };
32
+
33
+ /** @internal */
34
+ export const UsersSendEmailRequest$outboundSchema: z.ZodType<
35
+ UsersSendEmailRequest$Outbound,
36
+ z.ZodTypeDef,
37
+ UsersSendEmailRequest
38
+ > = z.object({
39
+ userEmail: z.string(),
40
+ }).transform((v) => {
41
+ return remap$(v, {
42
+ userEmail: "user_email",
43
+ });
44
+ });
45
+
46
+ /**
47
+ * @internal
48
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
49
+ */
50
+ export namespace UsersSendEmailRequest$ {
51
+ /** @deprecated use `UsersSendEmailRequest$inboundSchema` instead. */
52
+ export const inboundSchema = UsersSendEmailRequest$inboundSchema;
53
+ /** @deprecated use `UsersSendEmailRequest$outboundSchema` instead. */
54
+ export const outboundSchema = UsersSendEmailRequest$outboundSchema;
55
+ /** @deprecated use `UsersSendEmailRequest$Outbound` instead. */
56
+ export type Outbound = UsersSendEmailRequest$Outbound;
57
+ }
58
+
59
+ export function usersSendEmailRequestToJSON(
60
+ usersSendEmailRequest: UsersSendEmailRequest,
61
+ ): string {
62
+ return JSON.stringify(
63
+ UsersSendEmailRequest$outboundSchema.parse(usersSendEmailRequest),
64
+ );
65
+ }
66
+
67
+ export function usersSendEmailRequestFromJSON(
68
+ jsonString: string,
69
+ ): SafeParseResult<UsersSendEmailRequest, SDKValidationError> {
70
+ return safeParse(
71
+ jsonString,
72
+ (x) => UsersSendEmailRequest$inboundSchema.parse(JSON.parse(x)),
73
+ `Failed to parse 'UsersSendEmailRequest' from JSON`,
74
+ );
75
+ }
package/src/sdk/users.ts CHANGED
@@ -8,6 +8,7 @@ import { usersList } from "../funcs/usersList.js";
8
8
  import { usersUpdate } from "../funcs/usersUpdate.js";
9
9
  import { usersUsersDeleteAccount } from "../funcs/usersUsersDeleteAccount.js";
10
10
  import { usersUsersGetByEmail } from "../funcs/usersUsersGetByEmail.js";
11
+ import { usersUsersSendEmail } from "../funcs/usersUsersSendEmail.js";
11
12
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
12
13
  import * as components from "../models/components/index.js";
13
14
  import * as operations from "../models/operations/index.js";
@@ -99,6 +100,23 @@ export class Users extends ClientSDK {
99
100
  ));
100
101
  }
101
102
 
103
+ /**
104
+ * Send User Email
105
+ *
106
+ * @remarks
107
+ * Send a welcome email to a user.
108
+ */
109
+ async usersSendEmail(
110
+ request: operations.UsersSendEmailRequest,
111
+ options?: RequestOptions,
112
+ ): Promise<any> {
113
+ return unwrapAsync(usersUsersSendEmail(
114
+ this,
115
+ request,
116
+ options,
117
+ ));
118
+ }
119
+
102
120
  /**
103
121
  * Request Removal Of This Account
104
122
  *
package/src/sdk/v1.ts CHANGED
@@ -8,6 +8,7 @@ import { v1List } from "../funcs/v1List.js";
8
8
  import { v1Update } from "../funcs/v1Update.js";
9
9
  import { v1UsersDeleteAccount } from "../funcs/v1UsersDeleteAccount.js";
10
10
  import { v1UsersGetByEmail } from "../funcs/v1UsersGetByEmail.js";
11
+ import { v1UsersSendEmail } from "../funcs/v1UsersSendEmail.js";
11
12
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
12
13
  import * as components from "../models/components/index.js";
13
14
  import * as operations from "../models/operations/index.js";
@@ -99,6 +100,23 @@ export class V1 extends ClientSDK {
99
100
  ));
100
101
  }
101
102
 
103
+ /**
104
+ * Send User Email
105
+ *
106
+ * @remarks
107
+ * Send a welcome email to a user.
108
+ */
109
+ async usersSendEmail(
110
+ request: operations.UsersSendEmailRequest,
111
+ options?: RequestOptions,
112
+ ): Promise<any> {
113
+ return unwrapAsync(v1UsersSendEmail(
114
+ this,
115
+ request,
116
+ options,
117
+ ));
118
+ }
119
+
102
120
  /**
103
121
  * Request Removal Of This Account
104
122
  *