@steamsets/client-ts 0.34.5 → 0.34.7

package/src/models/components/analyticsdistribution.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { AnalyticsBin, AnalyticsBin$inboundSchema } from "./analyticsbin.js";
+import {
+  AnalyticsSummary,
+  AnalyticsSummary$inboundSchema,
+} from "./analyticssummary.js";
+
+export type AnalyticsDistribution = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  bins: Array<AnalyticsBin> | null;
+  summary: AnalyticsSummary;
+};
+
+/** @internal */
+export const AnalyticsDistribution$inboundSchema: z.ZodType<
+  AnalyticsDistribution,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  bins: z.nullable(z.array(AnalyticsBin$inboundSchema)),
+  summary: AnalyticsSummary$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsDistributionFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsDistribution, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsDistribution$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsDistribution' from JSON`,
+  );
+}

package/src/models/components/analyticsdomainentry.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AnalyticsMetricEntry,
+  AnalyticsMetricEntry$inboundSchema,
+} from "./analyticsmetricentry.js";
+import {
+  AnalyticsScopeEntry,
+  AnalyticsScopeEntry$inboundSchema,
+} from "./analyticsscopeentry.js";
+
+export type AnalyticsDomainEntry = {
+  id: string;
+  metrics: Array<AnalyticsMetricEntry> | null;
+  scopes: Array<AnalyticsScopeEntry> | null;
+};
+
+/** @internal */
+export const AnalyticsDomainEntry$inboundSchema: z.ZodType<
+  AnalyticsDomainEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  metrics: z.nullable(z.array(AnalyticsMetricEntry$inboundSchema)),
+  scopes: z.nullable(z.array(AnalyticsScopeEntry$inboundSchema)),
+});
+
+export function analyticsDomainEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsDomainEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsDomainEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsDomainEntry' from JSON`,
+  );
+}

package/src/models/components/analyticsgetbivariaterequestbody.ts

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * How to aggregate Y inside each X bucket.
+ */
+export const Agg = {
+  Avg: "avg",
+  Median: "median",
+  Count: "count",
+} as const;
+/**
+ * How to aggregate Y inside each X bucket.
+ */
+export type Agg = ClosedEnum<typeof Agg>;
+
+export type AnalyticsGetBivariateRequestBody = {
+  /**
+   * How to aggregate Y inside each X bucket.
+   */
+  agg: Agg;
+  domain: string;
+  scope: string;
+  /**
+   * Country name/code or region name. Required for non-global scopes.
+   */
+  scopeValue?: string | undefined;
+  /**
+   * Metric ID for the X axis (bucketed).
+   */
+  x: string;
+  /**
+   * Metric ID for the Y axis (aggregated within each X bucket).
+   */
+  y: string;
+};
+
+/** @internal */
+export const Agg$outboundSchema: z.ZodNativeEnum<typeof Agg> = z.nativeEnum(
+  Agg,
+);
+
+/** @internal */
+export type AnalyticsGetBivariateRequestBody$Outbound = {
+  agg: string;
+  domain: string;
+  scope: string;
+  scope_value?: string | undefined;
+  x: string;
+  y: string;
+};
+
+/** @internal */
+export const AnalyticsGetBivariateRequestBody$outboundSchema: z.ZodType<
+  AnalyticsGetBivariateRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsGetBivariateRequestBody
+> = z.object({
+  agg: Agg$outboundSchema,
+  domain: z.string(),
+  scope: z.string(),
+  scopeValue: z.string().optional(),
+  x: z.string(),
+  y: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    scopeValue: "scope_value",
+  });
+});
+
+export function analyticsGetBivariateRequestBodyToJSON(
+  analyticsGetBivariateRequestBody: AnalyticsGetBivariateRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsGetBivariateRequestBody$outboundSchema.parse(
+      analyticsGetBivariateRequestBody,
+    ),
+  );
+}

package/src/models/components/analyticsgetdistributionrequestbody.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type AnalyticsGetDistributionRequestBody = {
+  /**
+   * Analytics domain ID. See analytics.listMetrics.
+   */
+  domain: string;
+  /**
+   * Metric ID within the domain.
+   */
+  metric: string;
+  /**
+   * Scope ID within the domain (global, country, region, …).
+   */
+  scope: string;
+  /**
+   * Scope value — country name or ISO code ("Germany" / "DE"), region name ("Europe"). Required for non-global scopes.
+   */
+  scopeValue?: string | undefined;
+};
+
+/** @internal */
+export type AnalyticsGetDistributionRequestBody$Outbound = {
+  domain: string;
+  metric: string;
+  scope: string;
+  scope_value?: string | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetDistributionRequestBody$outboundSchema: z.ZodType<
+  AnalyticsGetDistributionRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsGetDistributionRequestBody
+> = z.object({
+  domain: z.string(),
+  metric: z.string(),
+  scope: z.string(),
+  scopeValue: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    scopeValue: "scope_value",
+  });
+});
+
+export function analyticsGetDistributionRequestBodyToJSON(
+  analyticsGetDistributionRequestBody: AnalyticsGetDistributionRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsGetDistributionRequestBody$outboundSchema.parse(
+      analyticsGetDistributionRequestBody,
+    ),
+  );
+}

package/src/models/components/analyticsgetmetricbyscoperequestbody.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Aggregation applied within each dimension bucket.
+ */
+export const AnalyticsGetMetricByScopeRequestBodyAgg = {
+  Avg: "avg",
+  Median: "median",
+  Count: "count",
+} as const;
+/**
+ * Aggregation applied within each dimension bucket.
+ */
+export type AnalyticsGetMetricByScopeRequestBodyAgg = ClosedEnum<
+  typeof AnalyticsGetMetricByScopeRequestBodyAgg
+>;
+
+/**
+ * Group rows by this dimension. One bucket per distinct value.
+ */
+export const Dimension = {
+  Country: "country",
+  Region: "region",
+} as const;
+/**
+ * Group rows by this dimension. One bucket per distinct value.
+ */
+export type Dimension = ClosedEnum<typeof Dimension>;
+
+export type AnalyticsGetMetricByScopeRequestBody = {
+  /**
+   * Aggregation applied within each dimension bucket.
+   */
+  agg: AnalyticsGetMetricByScopeRequestBodyAgg;
+  /**
+   * Group rows by this dimension. One bucket per distinct value.
+   */
+  dimension: Dimension;
+  /**
+   * Analytics domain ID. See analytics.listMetrics.
+   */
+  domain: string;
+  /**
+   * Metric ID within the domain.
+   */
+  metric: string;
+};
+
+/** @internal */
+export const AnalyticsGetMetricByScopeRequestBodyAgg$outboundSchema:
+  z.ZodNativeEnum<typeof AnalyticsGetMetricByScopeRequestBodyAgg> = z
+    .nativeEnum(AnalyticsGetMetricByScopeRequestBodyAgg);
+
+/** @internal */
+export const Dimension$outboundSchema: z.ZodNativeEnum<typeof Dimension> = z
+  .nativeEnum(Dimension);
+
+/** @internal */
+export type AnalyticsGetMetricByScopeRequestBody$Outbound = {
+  agg: string;
+  dimension: string;
+  domain: string;
+  metric: string;
+};
+
+/** @internal */
+export const AnalyticsGetMetricByScopeRequestBody$outboundSchema: z.ZodType<
+  AnalyticsGetMetricByScopeRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsGetMetricByScopeRequestBody
+> = z.object({
+  agg: AnalyticsGetMetricByScopeRequestBodyAgg$outboundSchema,
+  dimension: Dimension$outboundSchema,
+  domain: z.string(),
+  metric: z.string(),
+});
+
+export function analyticsGetMetricByScopeRequestBodyToJSON(
+  analyticsGetMetricByScopeRequestBody: AnalyticsGetMetricByScopeRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsGetMetricByScopeRequestBody$outboundSchema.parse(
+      analyticsGetMetricByScopeRequestBody,
+    ),
+  );
+}

package/src/models/components/analyticsgetmypercentilesrequestbody.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type AnalyticsGetMyPercentilesRequestBody = {
+  domain: string;
+  scope: string;
+  /**
+   * Country name/code or region name. Required for non-global scopes.
+   */
+  scopeValue?: string | undefined;
+};
+
+/** @internal */
+export type AnalyticsGetMyPercentilesRequestBody$Outbound = {
+  domain: string;
+  scope: string;
+  scope_value?: string | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetMyPercentilesRequestBody$outboundSchema: z.ZodType<
+  AnalyticsGetMyPercentilesRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsGetMyPercentilesRequestBody
+> = z.object({
+  domain: z.string(),
+  scope: z.string(),
+  scopeValue: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    scopeValue: "scope_value",
+  });
+});
+
+export function analyticsGetMyPercentilesRequestBodyToJSON(
+  analyticsGetMyPercentilesRequestBody: AnalyticsGetMyPercentilesRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsGetMyPercentilesRequestBody$outboundSchema.parse(
+      analyticsGetMyPercentilesRequestBody,
+    ),
+  );
+}

package/src/models/components/analyticsgettrendrequestbody.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Lookback window.
+ */
+export const AnalyticsGetTrendRequestBodyWindow = {
+  Sevend: "7d",
+  Thirtyd: "30d",
+  Ninetyd: "90d",
+} as const;
+/**
+ * Lookback window.
+ */
+export type AnalyticsGetTrendRequestBodyWindow = ClosedEnum<
+  typeof AnalyticsGetTrendRequestBodyWindow
+>;
+
+export type AnalyticsGetTrendRequestBody = {
+  /**
+   * Analytics domain ID.
+   */
+  domain: string;
+  /**
+   * Metric ID within the domain.
+   */
+  metric: string;
+  /**
+   * Scope ID within the domain.
+   */
+  scope: string;
+  /**
+   * Country name/code or region name. Required for non-global scopes.
+   */
+  scopeValue?: string | undefined;
+  /**
+   * Lookback window.
+   */
+  window: AnalyticsGetTrendRequestBodyWindow;
+};
+
+/** @internal */
+export const AnalyticsGetTrendRequestBodyWindow$outboundSchema: z.ZodNativeEnum<
+  typeof AnalyticsGetTrendRequestBodyWindow
+> = z.nativeEnum(AnalyticsGetTrendRequestBodyWindow);
+
+/** @internal */
+export type AnalyticsGetTrendRequestBody$Outbound = {
+  domain: string;
+  metric: string;
+  scope: string;
+  scope_value?: string | undefined;
+  window: string;
+};
+
+/** @internal */
+export const AnalyticsGetTrendRequestBody$outboundSchema: z.ZodType<
+  AnalyticsGetTrendRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsGetTrendRequestBody
+> = z.object({
+  domain: z.string(),
+  metric: z.string(),
+  scope: z.string(),
+  scopeValue: z.string().optional(),
+  window: AnalyticsGetTrendRequestBodyWindow$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    scopeValue: "scope_value",
+  });
+});
+
+export function analyticsGetTrendRequestBodyToJSON(
+  analyticsGetTrendRequestBody: AnalyticsGetTrendRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsGetTrendRequestBody$outboundSchema.parse(
+      analyticsGetTrendRequestBody,
+    ),
+  );
+}

package/src/models/components/analyticslistmetricsresponsebody.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  AnalyticsDomainEntry,
+  AnalyticsDomainEntry$inboundSchema,
+} from "./analyticsdomainentry.js";
+
+export type AnalyticsListMetricsResponseBody = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  domains: Array<AnalyticsDomainEntry> | null;
+};
+
+/** @internal */
+export const AnalyticsListMetricsResponseBody$inboundSchema: z.ZodType<
+  AnalyticsListMetricsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  domains: z.nullable(z.array(AnalyticsDomainEntry$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsListMetricsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsListMetricsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsListMetricsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsListMetricsResponseBody' from JSON`,
+  );
+}

package/src/models/components/analyticsmetricbyscope.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  AnalyticsScopeBucket,
+  AnalyticsScopeBucket$inboundSchema,
+} from "./analyticsscopebucket.js";
+
+export type AnalyticsMetricByScope = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  buckets: Array<AnalyticsScopeBucket> | null;
+};
+
+/** @internal */
+export const AnalyticsMetricByScope$inboundSchema: z.ZodType<
+  AnalyticsMetricByScope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  buckets: z.nullable(z.array(AnalyticsScopeBucket$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsMetricByScopeFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsMetricByScope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsMetricByScope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsMetricByScope' from JSON`,
+  );
+}

package/src/models/components/analyticsmetricentry.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsMetricEntry = {
+  column: string;
+  id: string;
+  kind: string;
+};
+
+/** @internal */
+export const AnalyticsMetricEntry$inboundSchema: z.ZodType<
+  AnalyticsMetricEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  column: z.string(),
+  id: z.string(),
+  kind: z.string(),
+});
+
+export function analyticsMetricEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsMetricEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsMetricEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsMetricEntry' from JSON`,
+  );
+}

package/src/models/components/analyticsmypercentiles.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  AnalyticsPercentile,
+  AnalyticsPercentile$inboundSchema,
+} from "./analyticspercentile.js";
+
+export type AnalyticsMyPercentiles = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  count: number;
+  percentiles: Array<AnalyticsPercentile> | null;
+};
+
+/** @internal */
+export const AnalyticsMyPercentiles$inboundSchema: z.ZodType<
+  AnalyticsMyPercentiles,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  count: z.number().int(),
+  percentiles: z.nullable(z.array(AnalyticsPercentile$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsMyPercentilesFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsMyPercentiles, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsMyPercentiles$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsMyPercentiles' from JSON`,
+  );
+}

package/src/models/components/analyticspercentile.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsPercentile = {
+  metric: string;
+  percentile: number;
+  value: number;
+};
+
+/** @internal */
+export const AnalyticsPercentile$inboundSchema: z.ZodType<
+  AnalyticsPercentile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metric: z.string(),
+  percentile: z.number(),
+  value: z.number(),
+});
+
+export function analyticsPercentileFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsPercentile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsPercentile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsPercentile' from JSON`,
+  );
+}