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

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 (65) hide show
  1. package/README.md +11 -0
  2. package/docs/sdks/batches/README.md +4 -4
  3. package/docs/sdks/organizations/README.md +325 -0
  4. package/docs/sdks/workflows/README.md +8 -8
  5. package/funcs/organizationsCreate.d.ts +16 -0
  6. package/funcs/organizationsCreate.d.ts.map +1 -0
  7. package/funcs/organizationsCreate.js +120 -0
  8. package/funcs/organizationsCreate.js.map +1 -0
  9. package/funcs/organizationsDelete.d.ts +16 -0
  10. package/funcs/organizationsDelete.d.ts.map +1 -0
  11. package/funcs/organizationsDelete.js +105 -0
  12. package/funcs/organizationsDelete.js.map +1 -0
  13. package/funcs/organizationsOrganizationsGet.d.ts +15 -0
  14. package/funcs/organizationsOrganizationsGet.d.ts.map +1 -0
  15. package/funcs/organizationsOrganizationsGet.js +88 -0
  16. package/funcs/organizationsOrganizationsGet.js.map +1 -0
  17. package/funcs/organizationsUpdate.d.ts +16 -0
  18. package/funcs/organizationsUpdate.d.ts.map +1 -0
  19. package/funcs/organizationsUpdate.js +125 -0
  20. package/funcs/organizationsUpdate.js.map +1 -0
  21. package/jsr.json +1 -1
  22. package/lib/config.d.ts +2 -2
  23. package/lib/config.js +2 -2
  24. package/models/components/bodyorganizationscreate.d.ts +74 -0
  25. package/models/components/bodyorganizationscreate.d.ts.map +1 -0
  26. package/models/components/bodyorganizationscreate.js +114 -0
  27. package/models/components/bodyorganizationscreate.js.map +1 -0
  28. package/models/components/bodyorganizationsdelete.d.ts +32 -0
  29. package/models/components/bodyorganizationsdelete.d.ts.map +1 -0
  30. package/models/components/bodyorganizationsdelete.js +68 -0
  31. package/models/components/bodyorganizationsdelete.js.map +1 -0
  32. package/models/components/bodyorganizationsupdate.d.ts +79 -0
  33. package/models/components/bodyorganizationsupdate.d.ts.map +1 -0
  34. package/models/components/bodyorganizationsupdate.js +119 -0
  35. package/models/components/bodyorganizationsupdate.js.map +1 -0
  36. package/models/components/index.d.ts +4 -0
  37. package/models/components/index.d.ts.map +1 -1
  38. package/models/components/index.js +4 -0
  39. package/models/components/index.js.map +1 -1
  40. package/models/components/organizationresponse.d.ts +64 -0
  41. package/models/components/organizationresponse.d.ts.map +1 -0
  42. package/models/components/organizationresponse.js +90 -0
  43. package/models/components/organizationresponse.js.map +1 -0
  44. package/openapi.json +427 -33
  45. package/package.json +1 -1
  46. package/sdk/organizations.d.ts +33 -0
  47. package/sdk/organizations.d.ts.map +1 -0
  48. package/sdk/organizations.js +52 -0
  49. package/sdk/organizations.js.map +1 -0
  50. package/sdk/sdk.d.ts +3 -0
  51. package/sdk/sdk.d.ts.map +1 -1
  52. package/sdk/sdk.js +4 -0
  53. package/sdk/sdk.js.map +1 -1
  54. package/src/funcs/organizationsCreate.ts +157 -0
  55. package/src/funcs/organizationsDelete.ts +140 -0
  56. package/src/funcs/organizationsOrganizationsGet.ts +111 -0
  57. package/src/funcs/organizationsUpdate.ts +162 -0
  58. package/src/lib/config.ts +2 -2
  59. package/src/models/components/bodyorganizationscreate.ts +176 -0
  60. package/src/models/components/bodyorganizationsdelete.ts +78 -0
  61. package/src/models/components/bodyorganizationsupdate.ts +171 -0
  62. package/src/models/components/index.ts +4 -0
  63. package/src/models/components/organizationresponse.ts +134 -0
  64. package/src/sdk/organizations.ts +79 -0
  65. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,134 @@
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 OrganizationResponse = {
12
+ /**
13
+ * The human-readable display name of the organization.
14
+ */
15
+ displayName: string;
16
+ /**
17
+ * Description of the organization.
18
+ */
19
+ description?: string | null | undefined;
20
+ /**
21
+ * Comma-delimited list of domains that users at the organization may have in their email addresses.
22
+ */
23
+ domains: string;
24
+ /**
25
+ * The internal ID of the organization.
26
+ */
27
+ id: number;
28
+ /**
29
+ * Comments for the most recent edit to the organization.
30
+ */
31
+ lastUpdatedComments?: string | null | undefined;
32
+ /**
33
+ * The timestamp of the most recent update to the organization
34
+ */
35
+ lastUpdated: Date;
36
+ /**
37
+ * The email of the user who most recently updated the organization
38
+ */
39
+ lastUpdatedBy?: string | null | undefined;
40
+ logoStr: string | null;
41
+ };
42
+
43
+ /** @internal */
44
+ export const OrganizationResponse$inboundSchema: z.ZodType<
45
+ OrganizationResponse,
46
+ z.ZodTypeDef,
47
+ unknown
48
+ > = z.object({
49
+ display_name: z.string(),
50
+ description: z.nullable(z.string()).optional(),
51
+ domains: z.string(),
52
+ id: z.number().int(),
53
+ last_updated_comments: z.nullable(z.string()).optional(),
54
+ last_updated: z.string().datetime({ offset: true }).transform(v =>
55
+ new Date(v)
56
+ ),
57
+ last_updated_by: z.nullable(z.string()).optional(),
58
+ logo_str: z.nullable(z.string()),
59
+ }).transform((v) => {
60
+ return remap$(v, {
61
+ "display_name": "displayName",
62
+ "last_updated_comments": "lastUpdatedComments",
63
+ "last_updated": "lastUpdated",
64
+ "last_updated_by": "lastUpdatedBy",
65
+ "logo_str": "logoStr",
66
+ });
67
+ });
68
+
69
+ /** @internal */
70
+ export type OrganizationResponse$Outbound = {
71
+ display_name: string;
72
+ description?: string | null | undefined;
73
+ domains: string;
74
+ id: number;
75
+ last_updated_comments?: string | null | undefined;
76
+ last_updated: string;
77
+ last_updated_by?: string | null | undefined;
78
+ logo_str: string | null;
79
+ };
80
+
81
+ /** @internal */
82
+ export const OrganizationResponse$outboundSchema: z.ZodType<
83
+ OrganizationResponse$Outbound,
84
+ z.ZodTypeDef,
85
+ OrganizationResponse
86
+ > = z.object({
87
+ displayName: z.string(),
88
+ description: z.nullable(z.string()).optional(),
89
+ domains: z.string(),
90
+ id: z.number().int(),
91
+ lastUpdatedComments: z.nullable(z.string()).optional(),
92
+ lastUpdated: z.date().transform(v => v.toISOString()),
93
+ lastUpdatedBy: z.nullable(z.string()).optional(),
94
+ logoStr: z.nullable(z.string()),
95
+ }).transform((v) => {
96
+ return remap$(v, {
97
+ displayName: "display_name",
98
+ lastUpdatedComments: "last_updated_comments",
99
+ lastUpdated: "last_updated",
100
+ lastUpdatedBy: "last_updated_by",
101
+ logoStr: "logo_str",
102
+ });
103
+ });
104
+
105
+ /**
106
+ * @internal
107
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
108
+ */
109
+ export namespace OrganizationResponse$ {
110
+ /** @deprecated use `OrganizationResponse$inboundSchema` instead. */
111
+ export const inboundSchema = OrganizationResponse$inboundSchema;
112
+ /** @deprecated use `OrganizationResponse$outboundSchema` instead. */
113
+ export const outboundSchema = OrganizationResponse$outboundSchema;
114
+ /** @deprecated use `OrganizationResponse$Outbound` instead. */
115
+ export type Outbound = OrganizationResponse$Outbound;
116
+ }
117
+
118
+ export function organizationResponseToJSON(
119
+ organizationResponse: OrganizationResponse,
120
+ ): string {
121
+ return JSON.stringify(
122
+ OrganizationResponse$outboundSchema.parse(organizationResponse),
123
+ );
124
+ }
125
+
126
+ export function organizationResponseFromJSON(
127
+ jsonString: string,
128
+ ): SafeParseResult<OrganizationResponse, SDKValidationError> {
129
+ return safeParse(
130
+ jsonString,
131
+ (x) => OrganizationResponse$inboundSchema.parse(JSON.parse(x)),
132
+ `Failed to parse 'OrganizationResponse' from JSON`,
133
+ );
134
+ }
@@ -0,0 +1,79 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { organizationsCreate } from "../funcs/organizationsCreate.js";
6
+ import { organizationsDelete } from "../funcs/organizationsDelete.js";
7
+ import { organizationsOrganizationsGet } from "../funcs/organizationsOrganizationsGet.js";
8
+ import { organizationsUpdate } from "../funcs/organizationsUpdate.js";
9
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
10
+ import * as components from "../models/components/index.js";
11
+ import { unwrapAsync } from "../types/fp.js";
12
+
13
+ export class Organizations extends ClientSDK {
14
+ /**
15
+ * Get Current Organization
16
+ *
17
+ * @remarks
18
+ * Fetch the current organization.
19
+ */
20
+ async organizationsGet(
21
+ options?: RequestOptions,
22
+ ): Promise<components.OrganizationResponse> {
23
+ return unwrapAsync(organizationsOrganizationsGet(
24
+ this,
25
+ options,
26
+ ));
27
+ }
28
+
29
+ /**
30
+ * Update Current Organization
31
+ *
32
+ * @remarks
33
+ * Update the current organization.
34
+ */
35
+ async update(
36
+ request: components.BodyOrganizationsUpdate,
37
+ options?: RequestOptions,
38
+ ): Promise<components.OrganizationResponse> {
39
+ return unwrapAsync(organizationsUpdate(
40
+ this,
41
+ request,
42
+ options,
43
+ ));
44
+ }
45
+
46
+ /**
47
+ * Create Organization
48
+ *
49
+ * @remarks
50
+ * Create a new organization.
51
+ */
52
+ async create(
53
+ request: components.BodyOrganizationsCreate,
54
+ options?: RequestOptions,
55
+ ): Promise<components.OrganizationResponse> {
56
+ return unwrapAsync(organizationsCreate(
57
+ this,
58
+ request,
59
+ options,
60
+ ));
61
+ }
62
+
63
+ /**
64
+ * Delete Current Organization
65
+ *
66
+ * @remarks
67
+ * Delete the current organization and all its users.
68
+ */
69
+ async delete(
70
+ request?: components.BodyOrganizationsDelete | undefined,
71
+ options?: RequestOptions,
72
+ ): Promise<any> {
73
+ return unwrapAsync(organizationsDelete(
74
+ this,
75
+ request,
76
+ options,
77
+ ));
78
+ }
79
+ }
package/src/sdk/sdk.ts CHANGED
@@ -13,6 +13,7 @@ import { Events } from "./events.js";
13
13
  import { Incidents } from "./incidents.js";
14
14
  import { Insights } from "./insights.js";
15
15
  import { LanguageGroups } from "./languagegroups.js";
16
+ import { Organizations } from "./organizations.js";
16
17
  import { Outbound } from "./outbound.js";
17
18
  import { Permissions } from "./permissions.js";
18
19
  import { Prompts } from "./prompts.js";
@@ -112,6 +113,11 @@ export class SyllableSDK extends ClientSDK {
112
113
  return (this._dashboards ??= new Dashboards(this._options));
113
114
  }
114
115
 
116
+ private _organizations?: Organizations;
117
+ get organizations(): Organizations {
118
+ return (this._organizations ??= new Organizations(this._options));
119
+ }
120
+
115
121
  private _outbound?: Outbound;
116
122
  get outbound(): Outbound {
117
123
  return (this._outbound ??= new Outbound(this._options));