@scaleway/sdk-audit-trail 1.3.0 → 1.5.0

package/dist/index.gen.d.ts

@@ -2,4 +2,4 @@
  * This file is automatically generated
  * PLEASE DO NOT EDIT HERE
  */
-export * as AuditTrailv1alpha1 from './v1alpha1/index.gen';
+export * as AuditTrailv1alpha1 from './v1alpha1/index.gen.js';

package/dist/v1alpha1/api.gen.cjs

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const sdkClient = require("@scaleway/sdk-client");
 const marshalling_gen = require("./marshalling.gen.cjs");
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
 class API extends sdkClient.API {
   /**
    * Locality of this API.
@@ -32,17 +35,70 @@ class API extends sdkClient.API {
           request.pageSize ?? this.client.settings.defaultPageSize
         ],
         ["page_token", request.pageToken],
+        ["principal_id", request.principalId],
         ["product_name", request.productName],
         ["project_id", request.projectId],
         ["recorded_after", request.recordedAfter],
         ["recorded_before", request.recordedBefore],
+        ["resource_id", request.resourceId],
         ["resource_type", request.resourceType],
         ["service_name", request.serviceName],
+        ["source_ip", request.sourceIp],
         ["status", request.status]
       )
     },
     marshalling_gen.unmarshalListEventsResponse
   );
+  /**
+   * List authentication events. Retrieve the list of Audit Trail authentication events for a Scaleway Organization. You must specify the `organization_id`.
+   *
+   * @param request - The request {@link ListAuthenticationEventsRequest}
+   * @returns A Promise of ListAuthenticationEventsResponse
+   */
+  listAuthenticationEvents = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/authentication-events`,
+      urlParams: sdkClient.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],
+        ["recorded_after", request.recordedAfter],
+        ["recorded_before", request.recordedBefore]
+      )
+    },
+    marshalling_gen.unmarshalListAuthenticationEventsResponse
+  );
+  listCombinedEvents = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/combined-events`,
+      urlParams: sdkClient.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]
+      )
+    },
+    marshalling_gen.unmarshalListCombinedEventsResponse
+  );
   /**
    * Retrieve the list of Scaleway resources for which you have Audit Trail events.
    *
@@ -60,5 +116,53 @@ class API extends sdkClient.API {
     },
     marshalling_gen.unmarshalListProductsResponse
   );
+  /**
+   * Create an export job. Create an export job for a specified organization. This allows you to export audit trail events to a destination, such as an S3 bucket. The request requires the organization ID, a name for the export, and a destination configuration.
+   *
+   * @param request - The request {@link CreateExportJobRequest}
+   * @returns A Promise of ExportJob
+   */
+  createExportJob = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateExportJobRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/audit-trail/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/export-jobs`
+    },
+    marshalling_gen.unmarshalExportJob
+  );
+  /**
+   * Delete an export job. Deletes an export job for a specified id.
+   *
+   * @param request - The request {@link DeleteExportJobRequest}
+   */
+  deleteExportJob = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/audit-trail/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/export-jobs/${sdkClient.validatePathParam("exportJobId", request.exportJobId)}`
+  });
+  pageOfListExportJobs = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/export-jobs`,
+      urlParams: sdkClient.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["tags", request.tags]
+      )
+    },
+    marshalling_gen.unmarshalListExportJobsResponse
+  );
+  listExportJobs = (request = {}) => sdkClient.enrichForPagination("exportJobs", this.pageOfListExportJobs, request);
 }
 exports.API = API;

package/dist/v1alpha1/api.gen.d.ts

@@ -1,6 +1,6 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality } from '@scaleway/sdk-client';
-import type { ListEventsRequest, ListEventsResponse, ListProductsRequest, ListProductsResponse } from './types.gen';
+import type { CreateExportJobRequest, DeleteExportJobRequest, ExportJob, ListAuthenticationEventsRequest, ListAuthenticationEventsResponse, ListCombinedEventsRequest, ListCombinedEventsResponse, ListEventsRequest, ListEventsResponse, ListExportJobsRequest, ListExportJobsResponse, ListProductsRequest, ListProductsResponse } from './types.gen.js';
 /**
  * Audit Trail API.
 
@@ -19,6 +19,14 @@ export declare class API extends ParentAPI {
      * @returns A Promise of ListEventsResponse
      */
     listEvents: (request?: Readonly<ListEventsRequest>) => Promise<ListEventsResponse>;
+    /**
+     * List authentication events. Retrieve the list of Audit Trail authentication events for a Scaleway Organization. You must specify the `organization_id`.
+     *
+     * @param request - The request {@link ListAuthenticationEventsRequest}
+     * @returns A Promise of ListAuthenticationEventsResponse
+     */
+    listAuthenticationEvents: (request?: Readonly<ListAuthenticationEventsRequest>) => Promise<ListAuthenticationEventsResponse>;
+    listCombinedEvents: (request?: Readonly<ListCombinedEventsRequest>) => Promise<ListCombinedEventsResponse>;
     /**
      * Retrieve the list of Scaleway resources for which you have Audit Trail events.
      *
@@ -26,4 +34,22 @@ export declare class API extends ParentAPI {
      * @returns A Promise of ListProductsResponse
      */
     listProducts: (request?: Readonly<ListProductsRequest>) => Promise<ListProductsResponse>;
+    /**
+     * Create an export job. Create an export job for a specified organization. This allows you to export audit trail events to a destination, such as an S3 bucket. The request requires the organization ID, a name for the export, and a destination configuration.
+     *
+     * @param request - The request {@link CreateExportJobRequest}
+     * @returns A Promise of ExportJob
+     */
+    createExportJob: (request: Readonly<CreateExportJobRequest>) => Promise<ExportJob>;
+    /**
+     * Delete an export job. Deletes an export job for a specified id.
+     *
+     * @param request - The request {@link DeleteExportJobRequest}
+     */
+    deleteExportJob: (request: Readonly<DeleteExportJobRequest>) => Promise<void>;
+    protected pageOfListExportJobs: (request?: Readonly<ListExportJobsRequest>) => Promise<ListExportJobsResponse>;
+    listExportJobs: (request?: Readonly<ListExportJobsRequest>) => Promise<ListExportJobsResponse> & {
+        all: () => Promise<ExportJob[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<ExportJob[], void, void>;
+    };
 }

package/dist/v1alpha1/api.gen.js

@@ -1,5 +1,8 @@
-import { API as API$1, toApiLocality, urlParams, validatePathParam } from "@scaleway/sdk-client";
-import { unmarshalListEventsResponse, unmarshalListProductsResponse } from "./marshalling.gen.js";
+import { API as API$1, toApiLocality, urlParams, validatePathParam, enrichForPagination } from "@scaleway/sdk-client";
+import { unmarshalListEventsResponse, unmarshalListAuthenticationEventsResponse, unmarshalListCombinedEventsResponse, unmarshalListProductsResponse, marshalCreateExportJobRequest, unmarshalExportJob, unmarshalListExportJobsResponse } from "./marshalling.gen.js";
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
 class API extends API$1 {
   /**
    * Locality of this API.
@@ -30,17 +33,70 @@ class API extends API$1 {
           request.pageSize ?? this.client.settings.defaultPageSize
         ],
         ["page_token", request.pageToken],
+        ["principal_id", request.principalId],
         ["product_name", request.productName],
         ["project_id", request.projectId],
         ["recorded_after", request.recordedAfter],
         ["recorded_before", request.recordedBefore],
+        ["resource_id", request.resourceId],
         ["resource_type", request.resourceType],
         ["service_name", request.serviceName],
+        ["source_ip", request.sourceIp],
         ["status", request.status]
       )
     },
     unmarshalListEventsResponse
   );
+  /**
+   * List authentication events. Retrieve the list of Audit Trail authentication events for a Scaleway Organization. You must specify the `organization_id`.
+   *
+   * @param request - The request {@link ListAuthenticationEventsRequest}
+   * @returns A Promise of ListAuthenticationEventsResponse
+   */
+  listAuthenticationEvents = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/authentication-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],
+        ["recorded_after", request.recordedAfter],
+        ["recorded_before", request.recordedBefore]
+      )
+    },
+    unmarshalListAuthenticationEventsResponse
+  );
+  listCombinedEvents = (request = {}) => this.client.fetch(
+    {
+      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.
    *
@@ -58,6 +114,54 @@ class API extends API$1 {
     },
     unmarshalListProductsResponse
   );
+  /**
+   * Create an export job. Create an export job for a specified organization. This allows you to export audit trail events to a destination, such as an S3 bucket. The request requires the organization ID, a name for the export, and a destination configuration.
+   *
+   * @param request - The request {@link CreateExportJobRequest}
+   * @returns A Promise of ExportJob
+   */
+  createExportJob = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateExportJobRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/audit-trail/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/export-jobs`
+    },
+    unmarshalExportJob
+  );
+  /**
+   * Delete an export job. Deletes an export job for a specified id.
+   *
+   * @param request - The request {@link DeleteExportJobRequest}
+   */
+  deleteExportJob = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/audit-trail/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/export-jobs/${validatePathParam("exportJobId", request.exportJobId)}`
+  });
+  pageOfListExportJobs = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/export-jobs`,
+      urlParams: urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["tags", request.tags]
+      )
+    },
+    unmarshalListExportJobsResponse
+  );
+  listExportJobs = (request = {}) => enrichForPagination("exportJobs", this.pageOfListExportJobs, request);
 }
 export {
   API

package/dist/v1alpha1/index.gen.cjs

@@ -4,8 +4,13 @@ const api_gen = require("./api.gen.cjs");
 const marshalling_gen = require("./marshalling.gen.cjs");
 const validationRules_gen = require("./validation-rules.gen.cjs");
 exports.API = api_gen.API;
+exports.marshalCreateExportJobRequest = marshalling_gen.marshalCreateExportJobRequest;
 exports.unmarshalEvent = marshalling_gen.unmarshalEvent;
+exports.unmarshalExportJob = marshalling_gen.unmarshalExportJob;
+exports.unmarshalListAuthenticationEventsResponse = marshalling_gen.unmarshalListAuthenticationEventsResponse;
+exports.unmarshalListCombinedEventsResponse = marshalling_gen.unmarshalListCombinedEventsResponse;
 exports.unmarshalListEventsResponse = marshalling_gen.unmarshalListEventsResponse;
+exports.unmarshalListExportJobsResponse = marshalling_gen.unmarshalListExportJobsResponse;
 exports.unmarshalListProductsResponse = marshalling_gen.unmarshalListProductsResponse;
 exports.unmarshalResource = marshalling_gen.unmarshalResource;
 exports.ValidationRules = validationRules_gen;

package/dist/v1alpha1/index.gen.d.ts

@@ -1,4 +1,4 @@
-export { API } from './api.gen';
-export * from './marshalling.gen';
-export type { AccountOrganizationInfo, AccountUserInfo, Event, EventPrincipal, InstanceServerInfo, KeyManagerKeyInfo, KubernetesACLInfo, KubernetesClusterInfo, KubernetesNodeInfo, KubernetesPoolInfo, ListEventsRequest, ListEventsRequestOrderBy, ListEventsResponse, ListProductsRequest, ListProductsResponse, Product, ProductService, Resource, ResourceType, SecretManagerSecretInfo, SecretManagerSecretVersionInfo, } from './types.gen';
-export * as ValidationRules from './validation-rules.gen';
+export { API } from './api.gen.js';
+export * from './marshalling.gen.js';
+export type { AccountOrganizationInfo, AccountProjectInfo, AccountUserInfo, AppleSiliconServerInfo, AuthenticationEvent, AuthenticationEventFailureReason, AuthenticationEventMFAType, AuthenticationEventMethod, AuthenticationEventOrigin, AuthenticationEventResult, BaremetalServerInfo, BaremetalSettingInfo, CreateExportJobRequest, DeleteExportJobRequest, Event, EventPrincipal, ExportJob, ExportJobS3, ExportJobStatus, ExportJobStatusCode, InstanceServerInfo, IpamIpInfo, KeyManagerKeyInfo, KubernetesACLInfo, KubernetesClusterInfo, KubernetesNodeInfo, KubernetesPoolInfo, ListAuthenticationEventsRequest, ListAuthenticationEventsRequestOrderBy, ListAuthenticationEventsResponse, ListCombinedEventsRequest, ListCombinedEventsRequestOrderBy, ListCombinedEventsResponse, ListCombinedEventsResponseCombinedEvent, ListEventsRequest, ListEventsRequestOrderBy, ListEventsResponse, ListExportJobsRequest, ListExportJobsRequestOrderBy, ListExportJobsResponse, ListProductsRequest, ListProductsResponse, LoadBalancerAclInfo, LoadBalancerBackendInfo, LoadBalancerCertificateInfo, LoadBalancerFrontendInfo, LoadBalancerIpInfo, LoadBalancerLbInfo, LoadBalancerRouteInfo, Product, ProductService, Resource, ResourceType, SecretManagerSecretInfo, SecretManagerSecretVersionInfo, SystemEvent, SystemEventKind, } from './types.gen.js';
+export * as ValidationRules from './validation-rules.gen.js';

package/dist/v1alpha1/index.gen.js

@@ -1,11 +1,16 @@
 import { API } from "./api.gen.js";
-import { unmarshalEvent, unmarshalListEventsResponse, unmarshalListProductsResponse, unmarshalResource } from "./marshalling.gen.js";
+import { marshalCreateExportJobRequest, unmarshalEvent, unmarshalExportJob, unmarshalListAuthenticationEventsResponse, unmarshalListCombinedEventsResponse, unmarshalListEventsResponse, unmarshalListExportJobsResponse, unmarshalListProductsResponse, unmarshalResource } from "./marshalling.gen.js";
 import * as validationRules_gen from "./validation-rules.gen.js";
 export {
   API,
   validationRules_gen as ValidationRules,
+  marshalCreateExportJobRequest,
   unmarshalEvent,
+  unmarshalExportJob,
+  unmarshalListAuthenticationEventsResponse,
+  unmarshalListCombinedEventsResponse,
   unmarshalListEventsResponse,
+  unmarshalListExportJobsResponse,
   unmarshalListProductsResponse,
   unmarshalResource
 };