@s2-dev/streamstore 0.13.3 → 0.15.0

package/src/models/operations/basinmetrics.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type BasinMetricsRequest = {
+  /**
+   * Metric type to return.
+   */
+  set: components.BasinMetricSet;
+  /**
+   * Start timestamp, in Unix epoch seconds, if applicable for metric set.
+   */
+  start?: number | undefined;
+  /**
+   * End timestamp, in Unix epoch seconds, if applicable for metric set.
+   */
+  end?: number | undefined;
+  /**
+   * For timeseries metric sets, the interval to aggregate over.
+   */
+  interval?: components.TimeseriesInterval | undefined;
+  /**
+   * Basin name.
+   */
+  basin: string;
+};
+
+/** @internal */
+export const BasinMetricsRequest$inboundSchema: z.ZodType<
+  BasinMetricsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  set: components.BasinMetricSet$inboundSchema,
+  start: z.number().int().optional(),
+  end: z.number().int().optional(),
+  interval: components.TimeseriesInterval$inboundSchema.optional(),
+  basin: z.string(),
+});
+
+/** @internal */
+export type BasinMetricsRequest$Outbound = {
+  set: string;
+  start?: number | undefined;
+  end?: number | undefined;
+  interval?: string | undefined;
+  basin: string;
+};
+
+/** @internal */
+export const BasinMetricsRequest$outboundSchema: z.ZodType<
+  BasinMetricsRequest$Outbound,
+  z.ZodTypeDef,
+  BasinMetricsRequest
+> = z.object({
+  set: components.BasinMetricSet$outboundSchema,
+  start: z.number().int().optional(),
+  end: z.number().int().optional(),
+  interval: components.TimeseriesInterval$outboundSchema.optional(),
+  basin: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BasinMetricsRequest$ {
+  /** @deprecated use `BasinMetricsRequest$inboundSchema` instead. */
+  export const inboundSchema = BasinMetricsRequest$inboundSchema;
+  /** @deprecated use `BasinMetricsRequest$outboundSchema` instead. */
+  export const outboundSchema = BasinMetricsRequest$outboundSchema;
+  /** @deprecated use `BasinMetricsRequest$Outbound` instead. */
+  export type Outbound = BasinMetricsRequest$Outbound;
+}
+
+export function basinMetricsRequestToJSON(
+  basinMetricsRequest: BasinMetricsRequest,
+): string {
+  return JSON.stringify(
+    BasinMetricsRequest$outboundSchema.parse(basinMetricsRequest),
+  );
+}
+
+export function basinMetricsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<BasinMetricsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BasinMetricsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BasinMetricsRequest' from JSON`,
+  );
+}

package/src/models/operations/checktail.ts

@@ -17,10 +17,7 @@ export const CheckTailServerList = [
 
 export type CheckTailRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/createorreconfigurebasin.ts

@@ -15,11 +15,7 @@ export type CreateOrReconfigureBasinRequest = {
    */
   s2RequestToken?: string | undefined;
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
   createOrReconfigureBasinRequest?:

package/src/models/operations/createorreconfigurestream.ts

@@ -18,10 +18,7 @@ export const CreateOrReconfigureStreamServerList = [
 
 export type CreateOrReconfigureStreamRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/deletebasin.ts

@@ -9,11 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type DeleteBasinRequest = {
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
 };

package/src/models/operations/deletestream.ts

@@ -17,10 +17,7 @@ export const DeleteStreamServerList = [
 
 export type DeleteStreamRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/getbasinconfig.ts

@@ -9,11 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetBasinConfigRequest = {
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
 };

package/src/models/operations/getstreamconfig.ts

@@ -17,10 +17,7 @@ export const GetStreamConfigServerList = [
 
 export type GetStreamConfigRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/index.ts

@@ -2,7 +2,9 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./accountmetrics.js";
 export * from "./append.js";
+export * from "./basinmetrics.js";
 export * from "./checktail.js";
 export * from "./createorreconfigurebasin.js";
 export * from "./createorreconfigurestream.js";
@@ -18,3 +20,4 @@ export * from "./read.js";
 export * from "./reconfigurebasin.js";
 export * from "./reconfigurestream.js";
 export * from "./revokeaccesstoken.js";
+export * from "./streammetrics.js";

package/src/models/operations/read.ts

@@ -19,18 +19,14 @@ export const ReadServerList = [
 
 export type ReadRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**
-   * Recognized when the Content-Type is `application/json`.
+   * Define treatment of blob fields when exchanging records as JSON.
    *
    * @remarks
-   * json: UTF-8 data
-   * json-binsafe: Base64-encoded binary data
+   * The default is `raw`.
    */
   s2Format?: components.S2Format | undefined;
   /**

package/src/models/operations/reconfigurebasin.ts

@@ -11,11 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ReconfigureBasinRequest = {
   /**
-   * Basin name, which must be globally unique.
-   *
-   * @remarks
-   * The name must be between 8 and 48 characters, comprising lowercase
-   * letters, numbers and hyphens. It cannot begin or end with a hyphen.
+   * Basin name.
    */
   basin: string;
   basinReconfiguration: components.BasinReconfiguration;

package/src/models/operations/reconfigurestream.ts

@@ -18,10 +18,7 @@ export const ReconfigureStreamServerList = [
 
 export type ReconfigureStreamRequest = {
   /**
-   * Stream name, which must be unique within the basin.
-   *
-   * @remarks
-   * It can be an arbitrary string up to 512 characters.
+   * Stream name.
    */
   stream: string;
   /**

package/src/models/operations/revokeaccesstoken.ts

@@ -10,9 +10,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type RevokeAccessTokenRequest = {
   /**
    * Access token ID.
-   *
-   * @remarks
-   * It must be unique to the account and between 1 and 96 characters.
    */
   id: string;
 };

package/src/models/operations/streammetrics.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type StreamMetricsRequest = {
+  /**
+   * Basin name.
+   */
+  basin: string;
+  /**
+   * Stream name.
+   */
+  stream: string;
+};
+
+/** @internal */
+export const StreamMetricsRequest$inboundSchema: z.ZodType<
+  StreamMetricsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  basin: z.string(),
+  stream: z.string(),
+});
+
+/** @internal */
+export type StreamMetricsRequest$Outbound = {
+  basin: string;
+  stream: string;
+};
+
+/** @internal */
+export const StreamMetricsRequest$outboundSchema: z.ZodType<
+  StreamMetricsRequest$Outbound,
+  z.ZodTypeDef,
+  StreamMetricsRequest
+> = z.object({
+  basin: z.string(),
+  stream: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StreamMetricsRequest$ {
+  /** @deprecated use `StreamMetricsRequest$inboundSchema` instead. */
+  export const inboundSchema = StreamMetricsRequest$inboundSchema;
+  /** @deprecated use `StreamMetricsRequest$outboundSchema` instead. */
+  export const outboundSchema = StreamMetricsRequest$outboundSchema;
+  /** @deprecated use `StreamMetricsRequest$Outbound` instead. */
+  export type Outbound = StreamMetricsRequest$Outbound;
+}
+
+export function streamMetricsRequestToJSON(
+  streamMetricsRequest: StreamMetricsRequest,
+): string {
+  return JSON.stringify(
+    StreamMetricsRequest$outboundSchema.parse(streamMetricsRequest),
+  );
+}
+
+export function streamMetricsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<StreamMetricsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreamMetricsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreamMetricsRequest' from JSON`,
+  );
+}

package/src/sdk/metrics.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { metricsAccountMetrics } from "../funcs/metricsAccountMetrics.js";
+import { metricsBasinMetrics } from "../funcs/metricsBasinMetrics.js";
+import { metricsStreamMetrics } from "../funcs/metricsStreamMetrics.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Metrics extends ClientSDK {
+  /**
+   * Get account level metrics.
+   */
+  async accountMetrics(
+    request: operations.AccountMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MetricSetResponse> {
+    return unwrapAsync(metricsAccountMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get metrics for a basin.
+   */
+  async basinMetrics(
+    request: operations.BasinMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MetricSetResponse> {
+    return unwrapAsync(metricsBasinMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get metrics for a stream.
+   */
+  async streamMetrics(
+    request: operations.StreamMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<components.MetricSetResponse> {
+    return unwrapAsync(metricsStreamMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -5,6 +5,7 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { AccessTokens } from "./accesstokens.js";
 import { Basins } from "./basins.js";
+import { Metrics } from "./metrics.js";
 import { Records } from "./records.js";
 import { Streams } from "./streams.js";
 
@@ -19,6 +20,11 @@ export class S2 extends ClientSDK {
     return (this._basins ??= new Basins(this._options));
   }
 
+  private _metrics?: Metrics;
+  get metrics(): Metrics {
+    return (this._metrics ??= new Metrics(this._options));
+  }
+
   private _streams?: Streams;
   get streams(): Streams {
     return (this._streams ??= new Streams(this._options));