npm - @meetkai/mka1 - Versions diffs - 0.54.40 → 0.54.41 - Mend

@@ -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;
 };

@@ -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;

@@ -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;
 };

@@ -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;
 };

@@ -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;
 };

@@ -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<

@@ -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<

@@ -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<

@@ -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<

@@ -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<

@@ -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,

@meetkai/mka1 0.54.40 → 0.54.41