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

package/src/funcs/organizationsUpdate.ts

@@ -0,0 +1,162 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import { appendForm } from "../lib/encodings.js";
+import { readableStreamToArrayBuffer } from "../lib/files.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 { isBlobLike } from "../types/blobs.js";
+import { Result } from "../types/fp.js";
+import { isReadableStream } from "../types/streams.js";
+
+/**
+ * Update Current Organization
+ *
+ * @remarks
+ * Update the current organization.
+ */
+export async function organizationsUpdate(
+  client: SyllableSDKCore,
+  request: components.BodyOrganizationsUpdate,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.OrganizationResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.BodyOrganizationsUpdate$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = new FormData();
+
+  appendForm(body, "display_name", payload.display_name);
+  appendForm(body, "domains", payload.domains);
+  if (payload.description !== undefined) {
+    appendForm(body, "description", payload.description);
+  }
+  if (payload.logo !== undefined) {
+    if (isBlobLike(payload.logo)) {
+      appendForm(body, "logo", payload.logo);
+    } else if (isReadableStream(payload.logo.content)) {
+      const buffer = await readableStreamToArrayBuffer(payload.logo.content);
+      const blob = new Blob([buffer], { type: "application/octet-stream" });
+      appendForm(body, "logo", blob);
+    } else {
+      appendForm(
+        body,
+        "logo",
+        new Blob([payload.logo.content], { type: "application/octet-stream" }),
+        payload.logo.fileName,
+      );
+    }
+  }
+  if (payload.update_comments !== undefined) {
+    appendForm(body, "update_comments", payload.update_comments);
+  }
+
+  const path = pathToFunc("/api/v1/organizations/")();
+
+  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: "organizations_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.OrganizationResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.OrganizationResponse$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/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.186",
+  sdkVersion: "0.1.0-alpha.190",
   genVersion: "2.512.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.186 2.512.4 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.190 2.512.4 0.0.2 syllable-sdk",
 } as const;

package/src/models/components/bodyorganizationscreate.ts

@@ -0,0 +1,176 @@
+/*
+ * 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 { blobLikeSchema } from "../../types/blobs.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type BodyOrganizationsCreateLogo = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+export type BodyOrganizationsCreate = {
+  /**
+   * The human-readable display name of the organization
+   */
+  displayName: string;
+  /**
+   * Comma-delimited list of domains that users at the organization may have in their email addresses
+   */
+  domains: string;
+  /**
+   * The organization logo image file to upload. Must be a PNG file and 120x120 pixels.
+   */
+  logo: BodyOrganizationsCreateLogo | Blob;
+  /**
+   * Description of the organization
+   */
+  description?: string | null | undefined;
+};
+
+/** @internal */
+export const BodyOrganizationsCreateLogo$inboundSchema: z.ZodType<
+  BodyOrganizationsCreateLogo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+});
+
+/** @internal */
+export type BodyOrganizationsCreateLogo$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const BodyOrganizationsCreateLogo$outboundSchema: z.ZodType<
+  BodyOrganizationsCreateLogo$Outbound,
+  z.ZodTypeDef,
+  BodyOrganizationsCreateLogo
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BodyOrganizationsCreateLogo$ {
+  /** @deprecated use `BodyOrganizationsCreateLogo$inboundSchema` instead. */
+  export const inboundSchema = BodyOrganizationsCreateLogo$inboundSchema;
+  /** @deprecated use `BodyOrganizationsCreateLogo$outboundSchema` instead. */
+  export const outboundSchema = BodyOrganizationsCreateLogo$outboundSchema;
+  /** @deprecated use `BodyOrganizationsCreateLogo$Outbound` instead. */
+  export type Outbound = BodyOrganizationsCreateLogo$Outbound;
+}
+
+export function bodyOrganizationsCreateLogoToJSON(
+  bodyOrganizationsCreateLogo: BodyOrganizationsCreateLogo,
+): string {
+  return JSON.stringify(
+    BodyOrganizationsCreateLogo$outboundSchema.parse(
+      bodyOrganizationsCreateLogo,
+    ),
+  );
+}
+
+export function bodyOrganizationsCreateLogoFromJSON(
+  jsonString: string,
+): SafeParseResult<BodyOrganizationsCreateLogo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BodyOrganizationsCreateLogo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BodyOrganizationsCreateLogo' from JSON`,
+  );
+}
+
+/** @internal */
+export const BodyOrganizationsCreate$inboundSchema: z.ZodType<
+  BodyOrganizationsCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  display_name: z.string(),
+  domains: z.string(),
+  logo: z.lazy(() => BodyOrganizationsCreateLogo$inboundSchema),
+  description: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+  });
+});
+
+/** @internal */
+export type BodyOrganizationsCreate$Outbound = {
+  display_name: string;
+  domains: string;
+  logo: BodyOrganizationsCreateLogo$Outbound | Blob;
+  description?: string | null | undefined;
+};
+
+/** @internal */
+export const BodyOrganizationsCreate$outboundSchema: z.ZodType<
+  BodyOrganizationsCreate$Outbound,
+  z.ZodTypeDef,
+  BodyOrganizationsCreate
+> = z.object({
+  displayName: z.string(),
+  domains: z.string(),
+  logo: z.lazy(() => BodyOrganizationsCreateLogo$outboundSchema).or(
+    blobLikeSchema,
+  ),
+  description: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BodyOrganizationsCreate$ {
+  /** @deprecated use `BodyOrganizationsCreate$inboundSchema` instead. */
+  export const inboundSchema = BodyOrganizationsCreate$inboundSchema;
+  /** @deprecated use `BodyOrganizationsCreate$outboundSchema` instead. */
+  export const outboundSchema = BodyOrganizationsCreate$outboundSchema;
+  /** @deprecated use `BodyOrganizationsCreate$Outbound` instead. */
+  export type Outbound = BodyOrganizationsCreate$Outbound;
+}
+
+export function bodyOrganizationsCreateToJSON(
+  bodyOrganizationsCreate: BodyOrganizationsCreate,
+): string {
+  return JSON.stringify(
+    BodyOrganizationsCreate$outboundSchema.parse(bodyOrganizationsCreate),
+  );
+}
+
+export function bodyOrganizationsCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<BodyOrganizationsCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BodyOrganizationsCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BodyOrganizationsCreate' from JSON`,
+  );
+}

package/src/models/components/bodyorganizationsdelete.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 BodyOrganizationsDelete = {
+  /**
+   * Comments explaining the deletion
+   */
+  deleteComments?: string | null | undefined;
+};
+
+/** @internal */
+export const BodyOrganizationsDelete$inboundSchema: z.ZodType<
+  BodyOrganizationsDelete,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  delete_comments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "delete_comments": "deleteComments",
+  });
+});
+
+/** @internal */
+export type BodyOrganizationsDelete$Outbound = {
+  delete_comments?: string | null | undefined;
+};
+
+/** @internal */
+export const BodyOrganizationsDelete$outboundSchema: z.ZodType<
+  BodyOrganizationsDelete$Outbound,
+  z.ZodTypeDef,
+  BodyOrganizationsDelete
+> = z.object({
+  deleteComments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    deleteComments: "delete_comments",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BodyOrganizationsDelete$ {
+  /** @deprecated use `BodyOrganizationsDelete$inboundSchema` instead. */
+  export const inboundSchema = BodyOrganizationsDelete$inboundSchema;
+  /** @deprecated use `BodyOrganizationsDelete$outboundSchema` instead. */
+  export const outboundSchema = BodyOrganizationsDelete$outboundSchema;
+  /** @deprecated use `BodyOrganizationsDelete$Outbound` instead. */
+  export type Outbound = BodyOrganizationsDelete$Outbound;
+}
+
+export function bodyOrganizationsDeleteToJSON(
+  bodyOrganizationsDelete: BodyOrganizationsDelete,
+): string {
+  return JSON.stringify(
+    BodyOrganizationsDelete$outboundSchema.parse(bodyOrganizationsDelete),
+  );
+}
+
+export function bodyOrganizationsDeleteFromJSON(
+  jsonString: string,
+): SafeParseResult<BodyOrganizationsDelete, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BodyOrganizationsDelete$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BodyOrganizationsDelete' from JSON`,
+  );
+}

package/src/models/components/bodyorganizationsupdate.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 { blobLikeSchema } from "../../types/blobs.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Logo = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+export type BodyOrganizationsUpdate = {
+  /**
+   * The human-readable display name of the organization
+   */
+  displayName: string;
+  /**
+   * Comma-delimited list of domains that users at the organization may have in their email addresses
+   */
+  domains: string;
+  /**
+   * Description of the organization
+   */
+  description?: string | null | undefined;
+  /**
+   * The organization logo image file to upload. Must be a PNG file and 120x120 pixels. If not provided, the logo will not be updated.
+   */
+  logo?: Logo | Blob | undefined;
+  /**
+   * Comments about the update
+   */
+  updateComments?: string | null | undefined;
+};
+
+/** @internal */
+export const Logo$inboundSchema: z.ZodType<Logo, z.ZodTypeDef, unknown> = z
+  .object({
+    fileName: z.string(),
+    content: z.union([
+      z.instanceof(ReadableStream<Uint8Array>),
+      z.instanceof(Blob),
+      z.instanceof(ArrayBuffer),
+      z.instanceof(Uint8Array),
+    ]),
+  });
+
+/** @internal */
+export type Logo$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const Logo$outboundSchema: z.ZodType<Logo$Outbound, z.ZodTypeDef, Logo> =
+  z.object({
+    fileName: z.string(),
+    content: z.union([
+      z.instanceof(ReadableStream<Uint8Array>),
+      z.instanceof(Blob),
+      z.instanceof(ArrayBuffer),
+      z.instanceof(Uint8Array),
+    ]),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Logo$ {
+  /** @deprecated use `Logo$inboundSchema` instead. */
+  export const inboundSchema = Logo$inboundSchema;
+  /** @deprecated use `Logo$outboundSchema` instead. */
+  export const outboundSchema = Logo$outboundSchema;
+  /** @deprecated use `Logo$Outbound` instead. */
+  export type Outbound = Logo$Outbound;
+}
+
+export function logoToJSON(logo: Logo): string {
+  return JSON.stringify(Logo$outboundSchema.parse(logo));
+}
+
+export function logoFromJSON(
+  jsonString: string,
+): SafeParseResult<Logo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Logo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Logo' from JSON`,
+  );
+}
+
+/** @internal */
+export const BodyOrganizationsUpdate$inboundSchema: z.ZodType<
+  BodyOrganizationsUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  display_name: z.string(),
+  domains: z.string(),
+  description: z.nullable(z.string()).optional(),
+  logo: z.lazy(() => Logo$inboundSchema).optional(),
+  update_comments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "update_comments": "updateComments",
+  });
+});
+
+/** @internal */
+export type BodyOrganizationsUpdate$Outbound = {
+  display_name: string;
+  domains: string;
+  description?: string | null | undefined;
+  logo?: Logo$Outbound | Blob | undefined;
+  update_comments?: string | null | undefined;
+};
+
+/** @internal */
+export const BodyOrganizationsUpdate$outboundSchema: z.ZodType<
+  BodyOrganizationsUpdate$Outbound,
+  z.ZodTypeDef,
+  BodyOrganizationsUpdate
+> = z.object({
+  displayName: z.string(),
+  domains: z.string(),
+  description: z.nullable(z.string()).optional(),
+  logo: z.lazy(() => Logo$outboundSchema).or(blobLikeSchema).optional(),
+  updateComments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    updateComments: "update_comments",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BodyOrganizationsUpdate$ {
+  /** @deprecated use `BodyOrganizationsUpdate$inboundSchema` instead. */
+  export const inboundSchema = BodyOrganizationsUpdate$inboundSchema;
+  /** @deprecated use `BodyOrganizationsUpdate$outboundSchema` instead. */
+  export const outboundSchema = BodyOrganizationsUpdate$outboundSchema;
+  /** @deprecated use `BodyOrganizationsUpdate$Outbound` instead. */
+  export type Outbound = BodyOrganizationsUpdate$Outbound;
+}
+
+export function bodyOrganizationsUpdateToJSON(
+  bodyOrganizationsUpdate: BodyOrganizationsUpdate,
+): string {
+  return JSON.stringify(
+    BodyOrganizationsUpdate$outboundSchema.parse(bodyOrganizationsUpdate),
+  );
+}
+
+export function bodyOrganizationsUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<BodyOrganizationsUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BodyOrganizationsUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BodyOrganizationsUpdate' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -22,6 +22,9 @@ export * from "./batchdetails.js";
 export * from "./batchproperties.js";
 export * from "./batchstatus.js";
 export * from "./bodyinsightsfolderuploadfile.js";
+export * from "./bodyorganizationscreate.js";
+export * from "./bodyorganizationsdelete.js";
+export * from "./bodyorganizationsupdate.js";
 export * from "./bodyoutboundbatchdelete.js";
 export * from "./bodyoutboundbatchupload.js";
 export * from "./campaignproperties.js";
@@ -125,6 +128,7 @@ export * from "./listresponsesessionlabel.js";
 export * from "./listresponsetoolresponse.js";
 export * from "./listresponseuserresponse.js";
 export * from "./orderbydirection.js";
+export * from "./organizationresponse.js";
 export * from "./outboundcampaign.js";
 export * from "./outboundcampaigninput.js";
 export * from "./permissiongroupresponse.js";