@steamsets/client-ts 0.34.6 → 0.34.8

package/src/lib/config.ts

@@ -59,8 +59,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.34.6",
+  sdkVersion: "0.34.8",
   genVersion: "2.882.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.34.6 2.882.0 1.0.0 @steamsets/client-ts",
+    "speakeasy-sdk/typescript 0.34.8 2.882.0 1.0.0 @steamsets/client-ts",
 } as const;

package/src/models/components/analyticsgetbivariaterequestbody.ts

@@ -26,7 +26,10 @@ export type AnalyticsGetBivariateRequestBody = {
   agg: Agg;
   domain: string;
   scope: string;
-  scopeValue?: number | undefined;
+  /**
+   * Country name/code or region name. Required for non-global scopes.
+   */
+  scopeValue?: string | undefined;
   /**
    * Metric ID for the X axis (bucketed).
    */
@@ -47,7 +50,7 @@ export type AnalyticsGetBivariateRequestBody$Outbound = {
   agg: string;
   domain: string;
   scope: string;
-  scope_value?: number | undefined;
+  scope_value?: string | undefined;
   x: string;
   y: string;
 };
@@ -61,7 +64,7 @@ export const AnalyticsGetBivariateRequestBody$outboundSchema: z.ZodType<
   agg: Agg$outboundSchema,
   domain: z.string(),
   scope: z.string(),
-  scopeValue: z.number().int().optional(),
+  scopeValue: z.string().optional(),
   x: z.string(),
   y: z.string(),
 }).transform((v) => {

package/src/models/components/analyticsgetdistributionrequestbody.ts

@@ -19,9 +19,9 @@ export type AnalyticsGetDistributionRequestBody = {
    */
   scope: string;
   /**
-   * Scope value (e.g. country_id). Required for non-global scopes.
+   * Scope value — country name or ISO code ("Germany" / "DE"), region name ("Europe"). Required for non-global scopes.
    */
-  scopeValue?: number | undefined;
+  scopeValue?: string | undefined;
 };
 
 /** @internal */
@@ -29,7 +29,7 @@ export type AnalyticsGetDistributionRequestBody$Outbound = {
   domain: string;
   metric: string;
   scope: string;
-  scope_value?: number | undefined;
+  scope_value?: string | undefined;
 };
 
 /** @internal */
@@ -41,7 +41,7 @@ export const AnalyticsGetDistributionRequestBody$outboundSchema: z.ZodType<
   domain: z.string(),
   metric: z.string(),
   scope: z.string(),
-  scopeValue: z.number().int().optional(),
+  scopeValue: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     scopeValue: "scope_value",

package/src/models/components/analyticsgetinequalityrequestbody.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 AnalyticsGetInequalityRequestBody = {
+  /**
+   * Analytics domain ID. See analytics.listMetrics.
+   */
+  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;
+};
+
+/** @internal */
+export type AnalyticsGetInequalityRequestBody$Outbound = {
+  domain: string;
+  metric: string;
+  scope: string;
+  scope_value?: string | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetInequalityRequestBody$outboundSchema: z.ZodType<
+  AnalyticsGetInequalityRequestBody$Outbound,
+  z.ZodTypeDef,
+  AnalyticsGetInequalityRequestBody
+> = 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 analyticsGetInequalityRequestBodyToJSON(
+  analyticsGetInequalityRequestBody: AnalyticsGetInequalityRequestBody,
+): string {
+  return JSON.stringify(
+    AnalyticsGetInequalityRequestBody$outboundSchema.parse(
+      analyticsGetInequalityRequestBody,
+    ),
+  );
+}

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

@@ -8,14 +8,17 @@ import { remap as remap$ } from "../../lib/primitives.js";
 export type AnalyticsGetMyPercentilesRequestBody = {
   domain: string;
   scope: string;
-  scopeValue?: number | undefined;
+  /**
+   * 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?: number | undefined;
+  scope_value?: string | undefined;
 };
 
 /** @internal */
@@ -26,7 +29,7 @@ export const AnalyticsGetMyPercentilesRequestBody$outboundSchema: z.ZodType<
 > = z.object({
   domain: z.string(),
   scope: z.string(),
-  scopeValue: z.number().int().optional(),
+  scopeValue: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     scopeValue: "scope_value",

package/src/models/components/analyticsgettrendrequestbody.ts

@@ -34,7 +34,10 @@ export type AnalyticsGetTrendRequestBody = {
    * Scope ID within the domain.
    */
   scope: string;
-  scopeValue?: number | undefined;
+  /**
+   * Country name/code or region name. Required for non-global scopes.
+   */
+  scopeValue?: string | undefined;
   /**
    * Lookback window.
    */
@@ -51,7 +54,7 @@ export type AnalyticsGetTrendRequestBody$Outbound = {
   domain: string;
   metric: string;
   scope: string;
-  scope_value?: number | undefined;
+  scope_value?: string | undefined;
   window: string;
 };
 
@@ -64,7 +67,7 @@ export const AnalyticsGetTrendRequestBody$outboundSchema: z.ZodType<
   domain: z.string(),
   metric: z.string(),
   scope: z.string(),
-  scopeValue: z.number().int().optional(),
+  scopeValue: z.string().optional(),
   window: AnalyticsGetTrendRequestBodyWindow$outboundSchema,
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/analyticsinequality.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 {
+  AnalyticsInequalityPoint,
+  AnalyticsInequalityPoint$inboundSchema,
+} from "./analyticsinequalitypoint.js";
+
+export type AnalyticsInequality = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  dollarSchema?: string | undefined;
+  /**
+   * Number of non-zero contributors.
+   */
+  count: number;
+  /**
+   * Gini coefficient. 0 = perfect equality, 1 = maximum inequality.
+   */
+  gini: number;
+  /**
+   * Lorenz curve sample points, sorted by popShare ascending. Includes (0,0) and (1,1) endpoints.
+   */
+  points: Array<AnalyticsInequalityPoint> | null;
+  /**
+   * Fraction of the metric owned by the top 10% (0–1).
+   */
+  top10PercentShare: number;
+  /**
+   * Fraction of the metric owned by the top 1% of contributors (0–1).
+   */
+  top1PercentShare: number;
+  /**
+   * Fraction of the metric owned by the top 50% (0–1).
+   */
+  top50PercentShare: number;
+  /**
+   * Sum of the metric across all non-zero contributors.
+   */
+  totalValue: number;
+};
+
+/** @internal */
+export const AnalyticsInequality$inboundSchema: z.ZodType<
+  AnalyticsInequality,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  $schema: z.string().optional(),
+  count: z.number().int(),
+  gini: z.number(),
+  points: z.nullable(z.array(AnalyticsInequalityPoint$inboundSchema)),
+  top10PercentShare: z.number(),
+  top1PercentShare: z.number(),
+  top50PercentShare: z.number(),
+  totalValue: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "$schema": "dollarSchema",
+  });
+});
+
+export function analyticsInequalityFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsInequality, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsInequality$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsInequality' from JSON`,
+  );
+}

package/src/models/components/analyticsinequalitypoint.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 AnalyticsInequalityPoint = {
+  /**
+   * Cumulative share of the population, taken from the bottom (0–1).
+   */
+  popShare: number;
+  /**
+   * Cumulative share of the metric owned by that bottom slice (0–1).
+   */
+  valueShare: number;
+};
+
+/** @internal */
+export const AnalyticsInequalityPoint$inboundSchema: z.ZodType<
+  AnalyticsInequalityPoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  popShare: z.number(),
+  valueShare: z.number(),
+});
+
+export function analyticsInequalityPointFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsInequalityPoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsInequalityPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsInequalityPoint' 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/analyticsscopebucket.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 AnalyticsScopeBucket = {
+  /**
+   * Sample size — accounts contributing to this bucket.
+   */
+  count: number;
+  /**
+   * Country ISO alpha-2 code, e.g. "DE". Stable join key for map data.
+   */
+  countryCode?: string | undefined;
+  /**
+   * Country name, e.g. "Germany"
+   */
+  countryName?: string | undefined;
+  /**
+   * Region name, e.g. "Europe"
+   */
+  region?: string | undefined;
+  /**
+   * The metric's aggregated value for this bucket.
+   */
+  value: number;
+};
+
+/** @internal */
+export const AnalyticsScopeBucket$inboundSchema: z.ZodType<
+  AnalyticsScopeBucket,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  countryCode: z.string().optional(),
+  countryName: z.string().optional(),
+  region: z.string().optional(),
+  value: z.number(),
+});
+
+export function analyticsScopeBucketFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsScopeBucket, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsScopeBucket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsScopeBucket' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -17,12 +17,18 @@ export * from "./analyticsdistribution.js";
 export * from "./analyticsdomainentry.js";
 export * from "./analyticsgetbivariaterequestbody.js";
 export * from "./analyticsgetdistributionrequestbody.js";
+export * from "./analyticsgetinequalityrequestbody.js";
+export * from "./analyticsgetmetricbyscoperequestbody.js";
 export * from "./analyticsgetmypercentilesrequestbody.js";
 export * from "./analyticsgettrendrequestbody.js";
+export * from "./analyticsinequality.js";
+export * from "./analyticsinequalitypoint.js";
 export * from "./analyticslistmetricsresponsebody.js";
+export * from "./analyticsmetricbyscope.js";
 export * from "./analyticsmetricentry.js";
 export * from "./analyticsmypercentiles.js";
 export * from "./analyticspercentile.js";
+export * from "./analyticsscopebucket.js";
 export * from "./analyticsscopeentry.js";
 export * from "./analyticssummary.js";
 export * from "./analyticstrackeventrequestbody.js";

package/src/models/operations/analyticsgetinequality.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsGetInequalityResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsInequality?: components.AnalyticsInequality | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetInequalityResponse$inboundSchema: z.ZodType<
+  AnalyticsGetInequalityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsInequality: components.AnalyticsInequality$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsInequality": "analyticsInequality",
+  });
+});
+
+export function analyticsGetInequalityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsGetInequalityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsGetInequalityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsGetInequalityResponse' from JSON`,
+  );
+}

package/src/models/operations/analyticsgetmetricbyscope.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AnalyticsGetMetricByScopeResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * OK
+   */
+  analyticsMetricByScope?: components.AnalyticsMetricByScope | undefined;
+};
+
+/** @internal */
+export const AnalyticsGetMetricByScopeResponse$inboundSchema: z.ZodType<
+  AnalyticsGetMetricByScopeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  HttpMeta: components.HTTPMetadata$inboundSchema,
+  AnalyticsMetricByScope: components.AnalyticsMetricByScope$inboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "HttpMeta": "httpMeta",
+    "AnalyticsMetricByScope": "analyticsMetricByScope",
+  });
+});
+
+export function analyticsGetMetricByScopeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AnalyticsGetMetricByScopeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AnalyticsGetMetricByScopeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AnalyticsGetMetricByScopeResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -60,6 +60,8 @@ export * from "./adminupdateroleoverride.js";
 export * from "./adminupdateroles.js";
 export * from "./analyticsgetbivariate.js";
 export * from "./analyticsgetdistribution.js";
+export * from "./analyticsgetinequality.js";
+export * from "./analyticsgetmetricbyscope.js";
 export * from "./analyticsgetmypercentiles.js";
 export * from "./analyticsgettrend.js";
 export * from "./analyticslistmetrics.js";

package/src/sdk/analytics.ts

@@ -4,6 +4,8 @@
 
 import { analyticsGetBivariate } from "../funcs/analyticsGetBivariate.js";
 import { analyticsGetDistribution } from "../funcs/analyticsGetDistribution.js";
+import { analyticsGetInequality } from "../funcs/analyticsGetInequality.js";
+import { analyticsGetMetricByScope } from "../funcs/analyticsGetMetricByScope.js";
 import { analyticsGetMyPercentiles } from "../funcs/analyticsGetMyPercentiles.js";
 import { analyticsGetTrend } from "../funcs/analyticsGetTrend.js";
 import { analyticsListMetrics } from "../funcs/analyticsListMetrics.js";
@@ -42,6 +44,34 @@ export class Analytics extends ClientSDK {
     ));
   }
 
+  /**
+   * Lorenz curve + Gini + top-X%-own-Y% headlines for one metric in a scope
+   */
+  async getInequality(
+    request: components.AnalyticsGetInequalityRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsGetInequalityResponse> {
+    return unwrapAsync(analyticsGetInequality(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * One metric aggregated per country (or region) — worldmap source
+   */
+  async getMetricByScope(
+    request: components.AnalyticsGetMetricByScopeRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.AnalyticsGetMetricByScopeResponse> {
+    return unwrapAsync(analyticsGetMetricByScope(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Per-metric percentile rank for the logged-in user in the chosen scope
    */