@meetkai/mka1 0.54.40 → 0.54.42

package/src/models/components/analyticsqueryrequest.ts

@@ -9,21 +9,36 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * count counts events. unique_visitors counts distinct values of distinct_id. Both deduplicate event IDs first.
+ */
 export const AnalyticsQueryRequestMetric = {
   Count: "count",
   UniqueVisitors: "unique_visitors",
 } as const;
+/**
+ * count counts events. unique_visitors counts distinct values of distinct_id. Both deduplicate event IDs first.
+ */
 export type AnalyticsQueryRequestMetric = ClosedEnum<
   typeof AnalyticsQueryRequestMetric
 >;
 
+/**
+ * Split results into UTC time buckets. Weeks start on Monday. Empty buckets are omitted.
+ */
 export const Bucket = {
   Hour: "hour",
   Day: "day",
   Week: "week",
 } as const;
+/**
+ * Split results into UTC time buckets. Weeks start on Monday. Empty buckets are omitted.
+ */
 export type Bucket = ClosedEnum<typeof Bucket>;
 
+/**
+ * Comparison operator. gt, gte, lt, and lte require a numeric value. exists and not_exists check whether the property is present and do not take a value.
+ */
 export const Op = {
   Eq: "eq",
   Neq: "neq",
@@ -34,24 +49,63 @@ export const Op = {
   Exists: "exists",
   NotExists: "not_exists",
 } as const;
+/**
+ * Comparison operator. gt, gte, lt, and lte require a numeric value. exists and not_exists check whether the property is present and do not take a value.
+ */
 export type Op = ClosedEnum<typeof Op>;
 
+/**
+ * Value to compare. The number 1 differs from the string '1'. Omit for exists and not_exists.
+ */
 export type AnalyticsQueryRequestValue = string | number | boolean;
 
 export type AnalyticsQueryRequestFilters = {
+  /**
+   * Event property to filter. Property names are literal keys, not nested paths.
+   */
   property: string;
+  /**
+   * Comparison operator. gt, gte, lt, and lte require a numeric value. exists and not_exists check whether the property is present and do not take a value.
+   */
   op: Op;
+  /**
+   * Value to compare. The number 1 differs from the string '1'. Omit for exists and not_exists.
+   */
   value?: string | number | boolean | null | undefined;
 };
 
 export type AnalyticsQueryRequest = {
+  /**
+   * count counts events. unique_visitors counts distinct values of distinct_id. Both deduplicate event IDs first.
+   */
   metric: AnalyticsQueryRequestMetric;
+  /**
+   * Start of the time range, inclusive. Use an ISO 8601 timestamp with Z for UTC or an offset such as -07:00. Must be before to.
+   */
   from: Date;
+  /**
+   * End of the time range, exclusive. Use an ISO 8601 timestamp with Z for UTC or an offset such as -07:00. Must be after from.
+   */
   to: Date;
+  /**
+   * Only include events with this exact name. Omit to include all event names.
+   */
   eventName?: string | undefined;
+  /**
+   * Split results into UTC time buckets. Weeks start on Monday. Empty buckets are omitted.
+   */
   bucket?: Bucket | undefined;
+  /**
+   * Group results by one event property. Missing values and null share a group.
+   */
   groupBy?: string | undefined;
+  /**
+   * Property filters combined with AND. An event must match every filter.
+   */
   filters?: Array<AnalyticsQueryRequestFilters> | undefined;
+  /**
+   * Maximum number of result rows, including rows created by time buckets and property groups.
+   */
   limit?: number | undefined;
 };
 

package/src/models/components/sessionstatus.ts

@@ -11,6 +11,7 @@ export const SessionStatus = {
   Provisioning: "provisioning",
   Running: "running",
   Idle: "idle",
+  Stopping: "stopping",
   Stopped: "stopped",
   Failed: "failed",
   Terminated: "terminated",

package/src/models/operations/analyticskeyscreate.ts

@@ -10,6 +10,9 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AnalyticsKeysCreateRequest = {
+  /**
+   * ID of the analytics project.
+   */
   id: string;
   analyticsKeyCreate: components.AnalyticsKeyCreate;
 };

package/src/models/operations/analyticskeyslist.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AnalyticsKeysListRequest = {
+  /**
+   * ID of the analytics project.
+   */
   id: string;
   limit?: number | undefined;
   after?: string | undefined;

package/src/models/operations/analyticskeysrevoke.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AnalyticsKeysRevokeRequest = {
+  /**
+   * ID of the analytics project.
+   */
   id: string;
   keyId: string;
 };

package/src/models/operations/analyticsprojectsarchive.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AnalyticsProjectsArchiveRequest = {
+  /**
+   * ID of the analytics project.
+   */
   id: string;
 };
 

package/src/models/operations/analyticsprojectsget.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AnalyticsProjectsGetRequest = {
+  /**
+   * ID of the analytics project.
+   */
   id: string;
 };
 

package/src/models/operations/analyticsprojectsupdate.ts

@@ -10,6 +10,9 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AnalyticsProjectsUpdateRequest = {
+  /**
+   * ID of the analytics project.
+   */
   id: string;
   analyticsProjectUpdate: components.AnalyticsProjectUpdate;
 };

package/src/models/operations/analyticsquery.ts

@@ -10,6 +10,9 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AnalyticsQueryRequest = {
+  /**
+   * ID of the analytics project.
+   */
   id: string;
   analyticsQueryRequest: components.AnalyticsQueryRequest;
 };

package/src/react-query/analyticsCapture.ts

@@ -49,6 +49,9 @@ export type AnalyticsCaptureMutationError =
 
 /**
  * Durably accept a batch of events
+ *
+ * @remarks
+ * Send a batch of events using the project's X-Analytics-Key header. A 202 response confirms the batch is stored; events become available to queries after background processing. Retry with the same idempotency_key and unchanged events if you do not receive a response.
  */
 export function useAnalyticsCaptureMutation(
   options?: MutationHookOptions<

package/src/react-query/analyticsKeysCreate.ts

@@ -49,6 +49,9 @@ export type AnalyticsKeysCreateMutationError =
 
 /**
  * Create a capture key and return its secret once
+ *
+ * @remarks
+ * Create a key that can send events to this project. Save the key from this response; its secret is only returned once. Capture keys cannot read analytics or manage projects.
  */
 export function useAnalyticsKeysCreateMutation(
   options?: MutationHookOptions<

package/src/react-query/analyticsProjectsArchive.ts

@@ -48,6 +48,9 @@ export type AnalyticsProjectsArchiveMutationError =
 
 /**
  * Archive an analytics project
+ *
+ * @remarks
+ * Stop new captures and queries for this project. Previously accepted events continue processing. Archiving does not delete stored events.
  */
 export function useAnalyticsProjectsArchiveMutation(
   options?: MutationHookOptions<

package/src/react-query/analyticsProjectsUpdate.ts

@@ -48,6 +48,9 @@ export type AnalyticsProjectsUpdateMutationError =
 
 /**
  * Rename an active analytics project
+ *
+ * @remarks
+ * Rename an active project. Project ownership cannot be changed.
  */
 export function useAnalyticsProjectsUpdateMutation(
   options?: MutationHookOptions<

package/src/react-query/analyticsQuery.ts

@@ -48,6 +48,9 @@ export type AnalyticsQueryMutationError =
 
 /**
  * Query event counts or unique visitors
+ *
+ * @remarks
+ * Count events or unique visitors in a time range. Optionally filter by event name or properties, group by one property, and split results into UTC time buckets. The range includes from and excludes to. Duplicate event IDs are counted once.
  */
 export function useAnalyticsQueryMutation(
   options?: MutationHookOptions<

package/src/sdk/analytics.ts

@@ -24,6 +24,9 @@ export class Analytics extends ClientSDK {
 
   /**
    * Durably accept a batch of events
+   *
+   * @remarks
+   * Send a batch of events using the project's X-Analytics-Key header. A 202 response confirms the batch is stored; events become available to queries after background processing. Retry with the same idempotency_key and unchanged events if you do not receive a response.
    */
   async capture(
     security: operations.AnalyticsCaptureSecurity,
@@ -40,6 +43,9 @@ export class Analytics extends ClientSDK {
 
   /**
    * Query event counts or unique visitors
+   *
+   * @remarks
+   * Count events or unique visitors in a time range. Optionally filter by event name or properties, group by one property, and split results into UTC time buckets. The range includes from and excludes to. Duplicate event IDs are counted once.
    */
   async query(
     request: operations.AnalyticsQueryRequest,

package/src/sdk/keys.ts

@@ -13,6 +13,9 @@ import { unwrapAsync } from "../types/fp.js";
 export class Keys extends ClientSDK {
   /**
    * Create a capture key and return its secret once
+   *
+   * @remarks
+   * Create a key that can send events to this project. Save the key from this response; its secret is only returned once. Capture keys cannot read analytics or manage projects.
    */
   async create(
     request: operations.AnalyticsKeysCreateRequest,

package/src/sdk/projects.ts

@@ -57,6 +57,9 @@ export class Projects extends ClientSDK {
 
   /**
    * Rename an active analytics project
+   *
+   * @remarks
+   * Rename an active project. Project ownership cannot be changed.
    */
   async update(
     request: operations.AnalyticsProjectsUpdateRequest,
@@ -71,6 +74,9 @@ export class Projects extends ClientSDK {
 
   /**
    * Archive an analytics project
+   *
+   * @remarks
+   * Stop new captures and queries for this project. Previously accepted events continue processing. Archiving does not delete stored events.
    */
   async archive(
     request: operations.AnalyticsProjectsArchiveRequest,