feat(audit_trail): support system events (#2415)

Author: scaleway-bot

packages_generated/audit_trail/src/v1alpha1/api.gen.ts

@@ -10,12 +10,15 @@ import {
 } from '@scaleway/sdk-client'
 import {
   unmarshalListAuthenticationEventsResponse,
+  unmarshalListCombinedEventsResponse,
   unmarshalListEventsResponse,
   unmarshalListProductsResponse,
 } from './marshalling.gen'
 import type {
   ListAuthenticationEventsRequest,
   ListAuthenticationEventsResponse,
+  ListCombinedEventsRequest,
+  ListCombinedEventsResponse,
   ListEventsRequest,
   ListEventsResponse,
   ListProductsRequest,
@@ -107,6 +110,32 @@ export class API extends ParentAPI {
       unmarshalListAuthenticationEventsResponse,
     )
 
+  listCombinedEvents = (request: Readonly<ListCombinedEventsRequest> = {}) =>
+    this.client.fetch<ListCombinedEventsResponse>(
+      {
+        method: 'GET',
+        path: `/audit-trail/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/combined-events`,
+        urlParams: urlParams(
+          ['order_by', request.orderBy],
+          [
+            'organization_id',
+            request.organizationId ??
+              this.client.settings.defaultOrganizationId,
+          ],
+          [
+            'page_size',
+            request.pageSize ?? this.client.settings.defaultPageSize,
+          ],
+          ['page_token', request.pageToken],
+          ['project_id', request.projectId],
+          ['recorded_after', request.recordedAfter],
+          ['recorded_before', request.recordedBefore],
+          ['resource_type', request.resourceType],
+        ),
+      },
+      unmarshalListCombinedEventsResponse,
+    )
+
   /**
    * Retrieve the list of Scaleway resources for which you have Audit Trail events.
    *

packages_generated/audit_trail/src/v1alpha1/index.gen.ts

@@ -17,7 +17,6 @@ export type {
   BaremetalSettingInfo,
   Event,
   EventPrincipal,
-  EventSystem,
   InstanceServerInfo,
   IpamIpInfo,
   KeyManagerKeyInfo,
@@ -28,6 +27,10 @@ export type {
   ListAuthenticationEventsRequest,
   ListAuthenticationEventsRequestOrderBy,
   ListAuthenticationEventsResponse,
+  ListCombinedEventsRequest,
+  ListCombinedEventsRequestOrderBy,
+  ListCombinedEventsResponse,
+  ListCombinedEventsResponseCombinedEvent,
   ListEventsRequest,
   ListEventsRequestOrderBy,
   ListEventsResponse,
@@ -46,5 +49,7 @@ export type {
   ResourceType,
   SecretManagerSecretInfo,
   SecretManagerSecretVersionInfo,
+  SystemEvent,
+  SystemEventKind,
 } from './types.gen'
 export * as ValidationRules from './validation-rules.gen'

packages_generated/audit_trail/src/v1alpha1/marshalling.gen.ts

@@ -15,7 +15,6 @@ import type {
   BaremetalSettingInfo,
   Event,
   EventPrincipal,
-  EventSystem,
   InstanceServerInfo,
   IpamIpInfo,
   KeyManagerKeyInfo,
@@ -24,6 +23,8 @@ import type {
   KubernetesNodeInfo,
   KubernetesPoolInfo,
   ListAuthenticationEventsResponse,
+  ListCombinedEventsResponse,
+  ListCombinedEventsResponseCombinedEvent,
   ListEventsResponse,
   ListProductsResponse,
   LoadBalancerAclInfo,
@@ -38,6 +39,7 @@ import type {
   Resource,
   SecretManagerSecretInfo,
   SecretManagerSecretVersionInfo,
+  SystemEvent,
 } from './types.gen'
 
 const unmarshalAccountOrganizationInfo = (
@@ -471,18 +473,6 @@ const unmarshalEventPrincipal = (data: unknown): EventPrincipal => {
   } as EventPrincipal
 }
 
-const unmarshalEventSystem = (data: unknown): EventSystem => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'EventSystem' failed as data isn't a dictionary.`,
-    )
-  }
-
-  return {
-    name: data.name,
-  } as EventSystem
-}
-
 export const unmarshalEvent = (data: unknown): Event => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -507,11 +497,65 @@ export const unmarshalEvent = (data: unknown): Event => {
     serviceName: data.service_name,
     sourceIp: data.source_ip,
     statusCode: data.status_code,
-    system: data.system ? unmarshalEventSystem(data.system) : undefined,
     userAgent: data.user_agent,
   } as Event
 }
 
+const unmarshalSystemEvent = (data: unknown): SystemEvent => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SystemEvent' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    id: data.id,
+    kind: data.kind,
+    locality: data.locality,
+    organizationId: data.organization_id,
+    productName: data.product_name,
+    projectId: data.project_id,
+    recordedAt: unmarshalDate(data.recorded_at),
+    resources: unmarshalArrayOfObject(data.resources, unmarshalResource),
+    source: data.source,
+    systemName: data.system_name,
+  } as SystemEvent
+}
+
+const unmarshalListCombinedEventsResponseCombinedEvent = (
+  data: unknown,
+): ListCombinedEventsResponseCombinedEvent => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListCombinedEventsResponseCombinedEvent' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    api: data.api ? unmarshalEvent(data.api) : undefined,
+    auth: data.auth ? unmarshalAuthenticationEvent(data.auth) : undefined,
+    system: data.system ? unmarshalSystemEvent(data.system) : undefined,
+  } as ListCombinedEventsResponseCombinedEvent
+}
+
+export const unmarshalListCombinedEventsResponse = (
+  data: unknown,
+): ListCombinedEventsResponse => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListCombinedEventsResponse' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    events: unmarshalArrayOfObject(
+      data.events,
+      unmarshalListCombinedEventsResponseCombinedEvent,
+    ),
+    nextPageToken: data.next_page_token,
+  } as ListCombinedEventsResponse
+}
+
 export const unmarshalListEventsResponse = (
   data: unknown,
 ): ListEventsResponse => {

packages_generated/audit_trail/src/v1alpha1/types.gen.ts

@@ -28,6 +28,10 @@ export type ListAuthenticationEventsRequestOrderBy =
   | 'recorded_at_desc'
   | 'recorded_at_asc'
 
+export type ListCombinedEventsRequestOrderBy =
+  | 'recorded_at_desc'
+  | 'recorded_at_asc'
+
 export type ListEventsRequestOrderBy = 'recorded_at_desc' | 'recorded_at_asc'
 
 export type ResourceType =
@@ -76,6 +80,8 @@ export type ResourceType =
   | 'sfs_filesystem'
   | 'vpc_private_network'
 
+export type SystemEventKind = 'unknown_kind' | 'cron' | 'notification'
+
 export interface AccountOrganizationInfo {}
 
 export interface AccountProjectInfo {
@@ -309,15 +315,6 @@ export interface EventPrincipal {
   id: string
 }
 
-export interface EventSystem {
-  name: string
-}
-
-export interface ProductService {
-  name: string
-  methods: string[]
-}
-
 export interface AuthenticationEvent {
   /**
    * ID of the event.
@@ -385,15 +382,9 @@ export interface Event {
   /**
    * User or IAM application at the origin of the event.
    *
-   * One-of ('source'): at most one of 'principal', 'system' could be set.
+   * One-of ('source'): at most one of 'principal' could be set.
    */
   principal?: EventPrincipal
-  /**
-   * The Scaleway system that performed an action on behalf of the client.
-   *
-   * One-of ('source'): at most one of 'principal', 'system' could be set.
-   */
-  system?: EventSystem
   /**
    * Organization ID containing the event.
    */
@@ -440,6 +431,42 @@ export interface Event {
   statusCode: number
 }
 
+export interface SystemEvent {
+  id: string
+  recordedAt?: Date
+  locality: string
+  organizationId: string
+  projectId?: string
+  source: string
+  systemName: string
+  resources: Resource[]
+  kind: SystemEventKind
+  productName: string
+}
+
+export interface ProductService {
+  name: string
+  methods: string[]
+}
+
+export interface ListCombinedEventsResponseCombinedEvent {
+  /**
+   *
+   * One-of ('event'): at most one of 'api', 'auth', 'system' could be set.
+   */
+  api?: Event
+  /**
+   *
+   * One-of ('event'): at most one of 'api', 'auth', 'system' could be set.
+   */
+  auth?: AuthenticationEvent
+  /**
+   *
+   * One-of ('event'): at most one of 'api', 'auth', 'system' could be set.
+   */
+  system?: SystemEvent
+}
+
 export interface Product {
   /**
    * Product title.
@@ -473,6 +500,26 @@ export interface ListAuthenticationEventsResponse {
   nextPageToken?: string
 }
 
+export type ListCombinedEventsRequest = {
+  /**
+   * Region to target. If none is passed will use default region from the config.
+   */
+  region?: ScwRegion
+  organizationId?: string
+  projectId?: string
+  resourceType?: ResourceType
+  recordedAfter?: Date
+  recordedBefore?: Date
+  orderBy?: ListCombinedEventsRequestOrderBy
+  pageSize?: number
+  pageToken?: string
+}
+
+export interface ListCombinedEventsResponse {
+  events: ListCombinedEventsResponseCombinedEvent[]
+  nextPageToken?: string
+}
+
 export type ListEventsRequest = {
   /**
    * Region to target. If none is passed will use default region from the config.

packages_generated/audit_trail/src/v1alpha1/validation-rules.gen.ts

@@ -8,6 +8,13 @@ export const ListAuthenticationEventsRequest = {
   },
 }
 
+export const ListCombinedEventsRequest = {
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 1000,
+  },
+}
+
 export const ListEventsRequest = {
   methodName: {
     pattern: /^[a-zA-Z][a-zA-Z0-9_]*$/,