@meetkai/mka1 0.54.42 → 0.54.44

package/src/models/components/analyticsqueryrequest.ts

@@ -24,7 +24,7 @@ export type AnalyticsQueryRequestMetric = ClosedEnum<
 >;
 
 /**
- * Split results into UTC time buckets. Weeks start on Monday. Empty buckets are omitted.
+ * Split results into time buckets. Hours, days, and Monday-start weeks begin on the clock of timezone, which defaults to UTC. Empty buckets are omitted.
  */
 export const Bucket = {
   Hour: "hour",
@@ -32,7 +32,7 @@ export const Bucket = {
   Week: "week",
 } as const;
 /**
- * Split results into UTC time buckets. Weeks start on Monday. Empty buckets are omitted.
+ * Split results into time buckets. Hours, days, and Monday-start weeks begin on the clock of timezone, which defaults to UTC. Empty buckets are omitted.
  */
 export type Bucket = ClosedEnum<typeof Bucket>;
 
@@ -92,9 +92,13 @@ export type AnalyticsQueryRequest = {
    */
   eventName?: string | undefined;
   /**
-   * Split results into UTC time buckets. Weeks start on Monday. Empty buckets are omitted.
+   * Split results into time buckets. Hours, days, and Monday-start weeks begin on the clock of timezone, which defaults to UTC. Empty buckets are omitted.
    */
   bucket?: Bucket | undefined;
+  /**
+   * IANA time zone name that sets where buckets start. Defaults to UTC. A day is a local calendar day and lasts 23 or 25 hours when the clocks change. In zones offset by 30 or 45 minutes, hours start on the local clock. UTC offsets such as +05:30 are rejected, as are identifiers outside the IANA database such as PST or BST, and names the service's time zone database does not know, which can lag the newest IANA zones; fall back to UTC when the 400 names timezone. Only bucket boundaries change: from, to, filters, and the UTC format of each row's bucket stay the same. Has no effect without bucket.
+   */
+  timezone?: string | undefined;
   /**
    * Group results by one event property. Missing values and null share a group.
    */
@@ -221,6 +225,7 @@ export const AnalyticsQueryRequest$inboundSchema: z.ZodType<
   to: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   event_name: z.string().optional(),
   bucket: Bucket$inboundSchema.optional(),
+  timezone: z.string().optional(),
   group_by: z.string().optional(),
   filters: z.array(z.lazy(() => AnalyticsQueryRequestFilters$inboundSchema))
     .optional(),
@@ -238,6 +243,7 @@ export type AnalyticsQueryRequest$Outbound = {
   to: string;
   event_name?: string | undefined;
   bucket?: string | undefined;
+  timezone?: string | undefined;
   group_by?: string | undefined;
   filters?: Array<AnalyticsQueryRequestFilters$Outbound> | undefined;
   limit: number;
@@ -254,6 +260,7 @@ export const AnalyticsQueryRequest$outboundSchema: z.ZodType<
   to: z.date().transform(v => v.toISOString()),
   eventName: z.string().optional(),
   bucket: Bucket$outboundSchema.optional(),
+  timezone: z.string().optional(),
   groupBy: z.string().optional(),
   filters: z.array(z.lazy(() => AnalyticsQueryRequestFilters$outboundSchema))
     .optional(),

package/src/models/components/analyticsqueryresponse.ts

@@ -19,6 +19,9 @@ export type AnalyticsQueryResponseMetric = ClosedEnum<
 export type Group = string | number | boolean;
 
 export type Rows = {
+  /**
+   * Start of the bucket as an ISO 8601 UTC timestamp ending in Z. With a timezone, this is the UTC instant at which the local hour, day, or week starts. Format it in that time zone for display.
+   */
   bucket?: string | undefined;
   group?: string | number | boolean | null | undefined;
   value: number;

package/src/models/operations/analyticsprojectslist.ts

@@ -15,10 +15,30 @@ export const IncludeArchived = {
 } as const;
 export type IncludeArchived = ClosedEnum<typeof IncludeArchived>;
 
+/**
+ * Return only team-owned projects (team) or organization-level projects with a null team_id (organization). organization cannot be combined with team_id.
+ */
+export const Ownership = {
+  Team: "team",
+  Organization: "organization",
+} as const;
+/**
+ * Return only team-owned projects (team) or organization-level projects with a null team_id (organization). organization cannot be combined with team_id.
+ */
+export type Ownership = ClosedEnum<typeof Ownership>;
+
 export type AnalyticsProjectsListRequest = {
   limit?: number | undefined;
   after?: string | undefined;
   includeArchived?: IncludeArchived | undefined;
+  /**
+   * Return only projects owned by this team. Filters narrow the projects the caller can already access; a team the caller cannot access returns an empty list.
+   */
+  teamId?: string | undefined;
+  /**
+   * Return only team-owned projects (team) or organization-level projects with a null team_id (organization). organization cannot be combined with team_id.
+   */
+  ownership?: Ownership | undefined;
 };
 
 /** @internal */
@@ -30,6 +50,13 @@ export const IncludeArchived$outboundSchema: z.ZodNativeEnum<
   typeof IncludeArchived
 > = IncludeArchived$inboundSchema;
 
+/** @internal */
+export const Ownership$inboundSchema: z.ZodNativeEnum<typeof Ownership> = z
+  .nativeEnum(Ownership);
+/** @internal */
+export const Ownership$outboundSchema: z.ZodNativeEnum<typeof Ownership> =
+  Ownership$inboundSchema;
+
 /** @internal */
 export const AnalyticsProjectsListRequest$inboundSchema: z.ZodType<
   AnalyticsProjectsListRequest,
@@ -39,9 +66,12 @@ export const AnalyticsProjectsListRequest$inboundSchema: z.ZodType<
   limit: z.number().int().default(50),
   after: z.string().optional(),
   include_archived: IncludeArchived$inboundSchema.default("false"),
+  team_id: z.string().optional(),
+  ownership: Ownership$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "include_archived": "includeArchived",
+    "team_id": "teamId",
   });
 });
 /** @internal */
@@ -49,6 +79,8 @@ export type AnalyticsProjectsListRequest$Outbound = {
   limit: number;
   after?: string | undefined;
   include_archived: string;
+  team_id?: string | undefined;
+  ownership?: string | undefined;
 };
 
 /** @internal */
@@ -60,9 +92,12 @@ export const AnalyticsProjectsListRequest$outboundSchema: z.ZodType<
   limit: z.number().int().default(50),
   after: z.string().optional(),
   includeArchived: IncludeArchived$outboundSchema.default("false"),
+  teamId: z.string().optional(),
+  ownership: Ownership$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     includeArchived: "include_archived",
+    teamId: "team_id",
   });
 });
 

package/src/react-query/analyticsProjectsCreate.ts

@@ -47,6 +47,9 @@ export type AnalyticsProjectsCreateMutationError =
 
 /**
  * Create an analytics project
+ *
+ * @remarks
+ * Create a project in the caller's organization. Without team_id the project belongs to the authenticated team. Organization owners and admins can create a project for any team in their organization, including teams they are not a member of, or pass team_id: null for an organization-level project. Service accounts can only create projects for their own team; any other team_id returns 403. team_id is trimmed. Ownership cannot be changed after creation.
  */
 export function useAnalyticsProjectsCreateMutation(
   options?: MutationHookOptions<

package/src/react-query/analyticsProjectsList.core.ts

@@ -46,6 +46,8 @@ export function buildAnalyticsProjectsListQuery(
       limit: request.limit,
       after: request.after,
       includeArchived: request.includeArchived,
+      teamId: request.teamId,
+      ownership: request.ownership,
     }),
     queryFn: async function analyticsProjectsListQueryFn(
       ctx,
@@ -75,6 +77,8 @@ export function queryKeyAnalyticsProjectsList(
     limit?: number | undefined;
     after?: string | undefined;
     includeArchived?: operations.IncludeArchived | undefined;
+    teamId?: string | undefined;
+    ownership?: operations.Ownership | undefined;
   },
 ): QueryKey {
   return ["@meetkai/mka1", "projects", "list", parameters];

package/src/react-query/analyticsProjectsList.ts

@@ -54,6 +54,9 @@ export type AnalyticsProjectsListQueryError =
 
 /**
  * List accessible analytics projects
+ *
+ * @remarks
+ * Organization owners and admins see every project in their organization: all teams' projects and organization-level projects, regardless of their active team. This also applies to an owner's or admin's API keys and exchanged JWTs, whichever team the key was issued for; use a service account for a team-confined credential. Service accounts see only their own team's projects. team_id and ownership narrow that set and never widen it, so filtering by a team the caller cannot access returns an empty list. ownership=organization combined with team_id returns 400. Unknown or repeated query parameters also return 400.
  */
 export function useAnalyticsProjectsList(
   request: operations.AnalyticsProjectsListRequest,
@@ -78,6 +81,9 @@ export function useAnalyticsProjectsList(
 
 /**
  * List accessible analytics projects
+ *
+ * @remarks
+ * Organization owners and admins see every project in their organization: all teams' projects and organization-level projects, regardless of their active team. This also applies to an owner's or admin's API keys and exchanged JWTs, whichever team the key was issued for; use a service account for a team-confined credential. Service accounts see only their own team's projects. team_id and ownership narrow that set and never widen it, so filtering by a team the caller cannot access returns an empty list. ownership=organization combined with team_id returns 400. Unknown or repeated query parameters also return 400.
  */
 export function useAnalyticsProjectsListSuspense(
   request: operations.AnalyticsProjectsListRequest,
@@ -107,6 +113,8 @@ export function setAnalyticsProjectsListData(
       limit?: number | undefined;
       after?: string | undefined;
       includeArchived?: operations.IncludeArchived | undefined;
+      teamId?: string | undefined;
+      ownership?: operations.Ownership | undefined;
     },
   ],
   data: AnalyticsProjectsListQueryData,
@@ -123,6 +131,8 @@ export function invalidateAnalyticsProjectsList(
       limit?: number | undefined;
       after?: string | undefined;
       includeArchived?: operations.IncludeArchived | undefined;
+      teamId?: string | undefined;
+      ownership?: operations.Ownership | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

package/src/react-query/analyticsQuery.ts

@@ -50,7 +50,7 @@ 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.
+ * Count events or unique visitors in a time range. Optionally filter by event name or properties, group by one property, and split results into hour, day, or week buckets that start on the clock of an IANA time zone, UTC by default. Each bucket is returned as the UTC instant at which it starts. The range includes from and excludes to. Duplicate event IDs are counted once. An unknown time zone returns 400.
  */
 export function useAnalyticsQueryMutation(
   options?: MutationHookOptions<

package/src/sdk/analytics.ts

@@ -45,7 +45,7 @@ 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.
+   * Count events or unique visitors in a time range. Optionally filter by event name or properties, group by one property, and split results into hour, day, or week buckets that start on the clock of an IANA time zone, UTC by default. Each bucket is returned as the UTC instant at which it starts. The range includes from and excludes to. Duplicate event IDs are counted once. An unknown time zone returns 400.
    */
   async query(
     request: operations.AnalyticsQueryRequest,

package/src/sdk/projects.ts

@@ -15,6 +15,9 @@ import { unwrapAsync } from "../types/fp.js";
 export class Projects extends ClientSDK {
   /**
    * Create an analytics project
+   *
+   * @remarks
+   * Create a project in the caller's organization. Without team_id the project belongs to the authenticated team. Organization owners and admins can create a project for any team in their organization, including teams they are not a member of, or pass team_id: null for an organization-level project. Service accounts can only create projects for their own team; any other team_id returns 403. team_id is trimmed. Ownership cannot be changed after creation.
    */
   async create(
     request: components.AnalyticsProjectCreate,
@@ -29,6 +32,9 @@ export class Projects extends ClientSDK {
 
   /**
    * List accessible analytics projects
+   *
+   * @remarks
+   * Organization owners and admins see every project in their organization: all teams' projects and organization-level projects, regardless of their active team. This also applies to an owner's or admin's API keys and exchanged JWTs, whichever team the key was issued for; use a service account for a team-confined credential. Service accounts see only their own team's projects. team_id and ownership narrow that set and never widen it, so filtering by a team the caller cannot access returns an empty list. ownership=organization combined with team_id returns 400. Unknown or repeated query parameters also return 400.
    */
   async list(
     request: operations.AnalyticsProjectsListRequest,