syllable-sdk 0.1.0-alpha.39 → 0.1.0-alpha.40

package/src/funcs/v1PostListDashboard.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.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 * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Post List Dashboards
+ *
+ * @remarks
+ * METHOD: POST
+ * URL: /dashboard/list
+ * ARGUMENTS: None
+ * RETURNS: List of dashboards
+ */
+export async function v1PostListDashboard(
+  client: SyllableSDKCore,
+  request: operations.PostListDashboardRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.ListResponseDashboardResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.PostListDashboardRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/api/v1/dashboards/list")();
+
+  const query = encodeFormQuery({
+    "end_datetime": payload.end_datetime,
+    "fields": payload.fields,
+    "limit": payload.limit,
+    "order_by": payload.order_by,
+    "order_by_direction": payload.order_by_direction,
+    "page": payload.page,
+    "search_field_values": payload.search_field_values,
+    "search_fields": payload.search_fields,
+    "start_datetime": payload.start_datetime,
+  });
+
+  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 = {
+    operationID: "post_list_dashboard",
+    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: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    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.ListResponseDashboardResponse,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.ListResponseDashboardResponse$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/funcs/v1PostSessionEventsDashboard.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
  * URL: /dashboard/session_events
  * ARGUMENTS: None
  * RETURNS: Dashboard info for embedding
+ * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export async function v1PostSessionEventsDashboard(
   client: SyllableSDKCore,

package/src/funcs/v1PostSessionSummaryDashboard.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
  * URL: /dashboard/session_summary
  * ARGUMENTS: None
  * RETURNS: Dashboard info for embedding
+ * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export async function v1PostSessionSummaryDashboard(
   client: SyllableSDKCore,

package/src/funcs/v1PostSessionTransfersDashboard.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
  * URL: /dashboard/session_transfers
  * ARGUMENTS: None
  * RETURNS: Dashboard info for embedding
+ * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export async function v1PostSessionTransfersDashboard(
   client: SyllableSDKCore,

package/src/funcs/v1PostSessionsDashboard.ts

@@ -28,6 +28,9 @@ import { Result } from "../types/fp.js";
  * URL: /dashboard/sessions
  * ARGUMENTS: None
  * RETURNS: Dashboard info for embedding
+ * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export async function v1PostSessionsDashboard(
   client: SyllableSDKCore,

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.39",
+  sdkVersion: "0.1.0-alpha.40",
   genVersion: "2.506.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.39 2.506.0 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.40 2.506.0 0.0.2 syllable-sdk",
 } as const;

package/src/models/components/dashboard.ts

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
+ * Deprecated.  Please update to use DashboardTokenResponse.
+ *
+ * @remarks
  * Basic information about a dashboard.
  */
 export type Dashboard = {

package/src/models/components/dashboardproperties.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const DashboardProperties = {
+  Id: "id",
+  Name: "name",
+  DisplayName: "display_name",
+  Rank: "rank",
+  Label: "label",
+} as const;
+export type DashboardProperties = ClosedEnum<typeof DashboardProperties>;
+
+/** @internal */
+export const DashboardProperties$inboundSchema: z.ZodNativeEnum<
+  typeof DashboardProperties
+> = z.nativeEnum(DashboardProperties);
+
+/** @internal */
+export const DashboardProperties$outboundSchema: z.ZodNativeEnum<
+  typeof DashboardProperties
+> = DashboardProperties$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DashboardProperties$ {
+  /** @deprecated use `DashboardProperties$inboundSchema` instead. */
+  export const inboundSchema = DashboardProperties$inboundSchema;
+  /** @deprecated use `DashboardProperties$outboundSchema` instead. */
+  export const outboundSchema = DashboardProperties$outboundSchema;
+}

package/src/models/components/dashboardresponse.ts

@@ -0,0 +1,102 @@
+/*
+ * 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";
+
+/**
+ * Basic information about a dashboard with a description.
+ */
+export type DashboardResponse = {
+  /**
+   * Name of the dashboard
+   */
+  name: string;
+  /**
+   * Display name of the dashboard
+   */
+  displayName: string;
+  /**
+   * Dashboard importance, 0 is the highest
+   */
+  rank: number;
+  /**
+   * Dashboard label.  Typically report or dashboard
+   */
+  label: string;
+};
+
+/** @internal */
+export const DashboardResponse$inboundSchema: z.ZodType<
+  DashboardResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  display_name: z.string(),
+  rank: z.number().int(),
+  label: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+  });
+});
+
+/** @internal */
+export type DashboardResponse$Outbound = {
+  name: string;
+  display_name: string;
+  rank: number;
+  label: string;
+};
+
+/** @internal */
+export const DashboardResponse$outboundSchema: z.ZodType<
+  DashboardResponse$Outbound,
+  z.ZodTypeDef,
+  DashboardResponse
+> = z.object({
+  name: z.string(),
+  displayName: z.string(),
+  rank: z.number().int(),
+  label: z.string(),
+}).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 DashboardResponse$ {
+  /** @deprecated use `DashboardResponse$inboundSchema` instead. */
+  export const inboundSchema = DashboardResponse$inboundSchema;
+  /** @deprecated use `DashboardResponse$outboundSchema` instead. */
+  export const outboundSchema = DashboardResponse$outboundSchema;
+  /** @deprecated use `DashboardResponse$Outbound` instead. */
+  export type Outbound = DashboardResponse$Outbound;
+}
+
+export function dashboardResponseToJSON(
+  dashboardResponse: DashboardResponse,
+): string {
+  return JSON.stringify(
+    DashboardResponse$outboundSchema.parse(dashboardResponse),
+  );
+}
+
+export function dashboardResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DashboardResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DashboardResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DashboardResponse' from JSON`,
+  );
+}

package/src/models/components/dashboardtokenresponse.ts

@@ -0,0 +1,129 @@
+/*
+ * 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";
+
+/**
+ * Basic information about a dashboard.
+ */
+export type DashboardTokenResponse = {
+  /**
+   * Superset embedded ID of the dashboard
+   */
+  embeddedId: string;
+  /**
+   * Superset guest token of the dashboard
+   */
+  guestToken: string;
+  /**
+   * Name of the dashboard
+   */
+  name: string;
+  /**
+   * Display name of the dashboard
+   */
+  displayName: string;
+  /**
+   * Superset URL of the dashboard
+   */
+  supersetUrl: string;
+  /**
+   * Dashboard importance, 0 is the highest
+   */
+  rank: number;
+  /**
+   * Dashboard label.  Typically report or dashboard
+   */
+  label: string;
+};
+
+/** @internal */
+export const DashboardTokenResponse$inboundSchema: z.ZodType<
+  DashboardTokenResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  embedded_id: z.string(),
+  guest_token: z.string(),
+  name: z.string(),
+  display_name: z.string(),
+  superset_url: z.string(),
+  rank: z.number().int(),
+  label: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "embedded_id": "embeddedId",
+    "guest_token": "guestToken",
+    "display_name": "displayName",
+    "superset_url": "supersetUrl",
+  });
+});
+
+/** @internal */
+export type DashboardTokenResponse$Outbound = {
+  embedded_id: string;
+  guest_token: string;
+  name: string;
+  display_name: string;
+  superset_url: string;
+  rank: number;
+  label: string;
+};
+
+/** @internal */
+export const DashboardTokenResponse$outboundSchema: z.ZodType<
+  DashboardTokenResponse$Outbound,
+  z.ZodTypeDef,
+  DashboardTokenResponse
+> = z.object({
+  embeddedId: z.string(),
+  guestToken: z.string(),
+  name: z.string(),
+  displayName: z.string(),
+  supersetUrl: z.string(),
+  rank: z.number().int(),
+  label: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    embeddedId: "embedded_id",
+    guestToken: "guest_token",
+    displayName: "display_name",
+    supersetUrl: "superset_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DashboardTokenResponse$ {
+  /** @deprecated use `DashboardTokenResponse$inboundSchema` instead. */
+  export const inboundSchema = DashboardTokenResponse$inboundSchema;
+  /** @deprecated use `DashboardTokenResponse$outboundSchema` instead. */
+  export const outboundSchema = DashboardTokenResponse$outboundSchema;
+  /** @deprecated use `DashboardTokenResponse$Outbound` instead. */
+  export type Outbound = DashboardTokenResponse$Outbound;
+}
+
+export function dashboardTokenResponseToJSON(
+  dashboardTokenResponse: DashboardTokenResponse,
+): string {
+  return JSON.stringify(
+    DashboardTokenResponse$outboundSchema.parse(dashboardTokenResponse),
+  );
+}
+
+export function dashboardTokenResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DashboardTokenResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DashboardTokenResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DashboardTokenResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -27,6 +27,9 @@ export * from "./custommessageresponse.js";
 export * from "./custommessagerule.js";
 export * from "./custommessageupdaterequest.js";
 export * from "./dashboard.js";
+export * from "./dashboardproperties.js";
+export * from "./dashboardresponse.js";
+export * from "./dashboardtokenresponse.js";
 export * from "./datasourcecreaterequest.js";
 export * from "./datasourcedetailresponse.js";
 export * from "./datasourcemetadataresponse.js";
@@ -42,6 +45,7 @@ export * from "./listresponsechannel.js";
 export * from "./listresponsechanneltargetresponse.js";
 export * from "./listresponseconversation.js";
 export * from "./listresponsecustommessageresponse.js";
+export * from "./listresponsedashboardresponse.js";
 export * from "./listresponsedatasourcemetadataresponse.js";
 export * from "./listresponseevent.js";
 export * from "./listresponsepromptresponse.js";

package/src/models/components/listresponsedashboardresponse.ts

@@ -0,0 +1,103 @@
+/*
+ * 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";
+import {
+  DashboardResponse,
+  DashboardResponse$inboundSchema,
+  DashboardResponse$Outbound,
+  DashboardResponse$outboundSchema,
+} from "./dashboardresponse.js";
+
+export type ListResponseDashboardResponse = {
+  items: Array<DashboardResponse>;
+  page: number;
+  pageSize: number;
+  totalPages?: number | null | undefined;
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseDashboardResponse$inboundSchema: z.ZodType<
+  ListResponseDashboardResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(DashboardResponse$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseDashboardResponse$Outbound = {
+  items: Array<DashboardResponse$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseDashboardResponse$outboundSchema: z.ZodType<
+  ListResponseDashboardResponse$Outbound,
+  z.ZodTypeDef,
+  ListResponseDashboardResponse
+> = z.object({
+  items: z.array(DashboardResponse$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseDashboardResponse$ {
+  /** @deprecated use `ListResponseDashboardResponse$inboundSchema` instead. */
+  export const inboundSchema = ListResponseDashboardResponse$inboundSchema;
+  /** @deprecated use `ListResponseDashboardResponse$outboundSchema` instead. */
+  export const outboundSchema = ListResponseDashboardResponse$outboundSchema;
+  /** @deprecated use `ListResponseDashboardResponse$Outbound` instead. */
+  export type Outbound = ListResponseDashboardResponse$Outbound;
+}
+
+export function listResponseDashboardResponseToJSON(
+  listResponseDashboardResponse: ListResponseDashboardResponse,
+): string {
+  return JSON.stringify(
+    ListResponseDashboardResponse$outboundSchema.parse(
+      listResponseDashboardResponse,
+    ),
+  );
+}
+
+export function listResponseDashboardResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseDashboardResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseDashboardResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseDashboardResponse' from JSON`,
+  );
+}