@scaleway/sdk-audit-trail 1.0.1

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2019 Scaleway.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.gen.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const index_gen = require("./v1alpha1/index.gen.cjs");
+exports.AuditTrailv1alpha1 = index_gen;

package/dist/index.gen.d.ts

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

package/dist/index.gen.js

@@ -0,0 +1,4 @@
+import * as index_gen from "./v1alpha1/index.gen.js";
+export {
+  index_gen as AuditTrailv1alpha1
+};

package/dist/v1alpha1/api.gen.cjs

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const sdkClient = require("@scaleway/sdk-client");
+const marshalling_gen = require("./marshalling.gen.cjs");
+class API extends sdkClient.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams"];
+  /**
+   * List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`.
+   *
+   * @param request - The request {@link ListEventsRequest}
+   * @returns A Promise of ListEventsResponse
+   */
+  listEvents = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/events`,
+      urlParams: sdkClient.urlParams(
+        ["method_name", request.methodName],
+        ["order_by", request.orderBy],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["page_token", request.pageToken],
+        ["product_name", request.productName],
+        ["project_id", request.projectId],
+        ["recorded_after", request.recordedAfter],
+        ["recorded_before", request.recordedBefore],
+        ["resource_type", request.resourceType],
+        ["service_name", request.serviceName],
+        ["status", request.status]
+      )
+    },
+    marshalling_gen.unmarshalListEventsResponse
+  );
+  /**
+   * Retrieve the list of Scaleway resources for which you have Audit Trail events.
+   *
+   * @param request - The request {@link ListProductsRequest}
+   * @returns A Promise of ListProductsResponse
+   */
+  listProducts = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/products`,
+      urlParams: sdkClient.urlParams([
+        "organization_id",
+        request.organizationId ?? this.client.settings.defaultOrganizationId
+      ])
+    },
+    marshalling_gen.unmarshalListProductsResponse
+  );
+}
+exports.API = API;

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

@@ -0,0 +1,26 @@
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { Region as ScwRegion } from '@scaleway/sdk-client';
+import type { ListEventsRequest, ListEventsResponse, ListProductsRequest, ListProductsResponse } from './types.gen';
+/**
+ * Audit Trail API.
+
+This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.
+ */
+export declare class API extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`.
+     *
+     * @param request - The request {@link ListEventsRequest}
+     * @returns A Promise of ListEventsResponse
+     */
+    listEvents: (request?: Readonly<ListEventsRequest>) => Promise<ListEventsResponse>;
+    /**
+     * Retrieve the list of Scaleway resources for which you have Audit Trail events.
+     *
+     * @param request - The request {@link ListProductsRequest}
+     * @returns A Promise of ListProductsResponse
+     */
+    listProducts: (request?: Readonly<ListProductsRequest>) => Promise<ListProductsResponse>;
+}

package/dist/v1alpha1/api.gen.js

@@ -0,0 +1,59 @@
+import { API as API$1, urlParams, validatePathParam } from "@scaleway/sdk-client";
+import { unmarshalListEventsResponse, unmarshalListProductsResponse } from "./marshalling.gen.js";
+class API extends API$1 {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams"];
+  /**
+   * List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`.
+   *
+   * @param request - The request {@link ListEventsRequest}
+   * @returns A Promise of ListEventsResponse
+   */
+  listEvents = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/events`,
+      urlParams: urlParams(
+        ["method_name", request.methodName],
+        ["order_by", request.orderBy],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["page_token", request.pageToken],
+        ["product_name", request.productName],
+        ["project_id", request.projectId],
+        ["recorded_after", request.recordedAfter],
+        ["recorded_before", request.recordedBefore],
+        ["resource_type", request.resourceType],
+        ["service_name", request.serviceName],
+        ["status", request.status]
+      )
+    },
+    unmarshalListEventsResponse
+  );
+  /**
+   * Retrieve the list of Scaleway resources for which you have Audit Trail events.
+   *
+   * @param request - The request {@link ListProductsRequest}
+   * @returns A Promise of ListProductsResponse
+   */
+  listProducts = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/audit-trail/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/products`,
+      urlParams: urlParams([
+        "organization_id",
+        request.organizationId ?? this.client.settings.defaultOrganizationId
+      ])
+    },
+    unmarshalListProductsResponse
+  );
+}
+export {
+  API
+};

package/dist/v1alpha1/index.gen.cjs

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+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.unmarshalEvent = marshalling_gen.unmarshalEvent;
+exports.unmarshalListEventsResponse = marshalling_gen.unmarshalListEventsResponse;
+exports.unmarshalListProductsResponse = marshalling_gen.unmarshalListProductsResponse;
+exports.unmarshalResource = marshalling_gen.unmarshalResource;
+exports.ValidationRules = validationRules_gen;

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

@@ -0,0 +1,4 @@
+export { API } from './api.gen';
+export * from './marshalling.gen';
+export type { Event, EventPrincipal, 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';

package/dist/v1alpha1/index.gen.js

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

package/dist/v1alpha1/marshalling.gen.cjs

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const sdkClient = require("@scaleway/sdk-client");
+const unmarshalKeyManagerKeyInfo = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KeyManagerKeyInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {};
+};
+const unmarshalKubernetesACLInfo = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesACLInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {};
+};
+const unmarshalKubernetesClusterInfo = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesClusterInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {};
+};
+const unmarshalKubernetesNodeInfo = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesNodeInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id,
+    name: data.name
+  };
+};
+const unmarshalKubernetesPoolInfo = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesPoolInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id,
+    name: data.name
+  };
+};
+const unmarshalSecretManagerSecretInfo = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SecretManagerSecretInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    path: data.path
+  };
+};
+const unmarshalSecretManagerSecretVersionInfo = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SecretManagerSecretVersionInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    revision: data.revision
+  };
+};
+const unmarshalEventPrincipal = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EventPrincipal' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id
+  };
+};
+const unmarshalResource = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Resource' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: sdkClient.unmarshalDate(data.created_at),
+    deletedAt: sdkClient.unmarshalDate(data.deleted_at),
+    id: data.id,
+    keyManagerKeyInfo: data.key_manager_key_info ? unmarshalKeyManagerKeyInfo(data.key_manager_key_info) : void 0,
+    keymKeyInfo: data.keym_key_info ? unmarshalKeyManagerKeyInfo(data.keym_key_info) : void 0,
+    kubeAclInfo: data.kube_acl_info ? unmarshalKubernetesACLInfo(data.kube_acl_info) : void 0,
+    kubeClusterInfo: data.kube_cluster_info ? unmarshalKubernetesClusterInfo(data.kube_cluster_info) : void 0,
+    kubeNodeInfo: data.kube_node_info ? unmarshalKubernetesNodeInfo(data.kube_node_info) : void 0,
+    kubePoolInfo: data.kube_pool_info ? unmarshalKubernetesPoolInfo(data.kube_pool_info) : void 0,
+    name: data.name,
+    secmSecretInfo: data.secm_secret_info ? unmarshalSecretManagerSecretInfo(data.secm_secret_info) : void 0,
+    secmSecretVersionInfo: data.secm_secret_version_info ? unmarshalSecretManagerSecretVersionInfo(data.secm_secret_version_info) : void 0,
+    secretManagerSecretInfo: data.secret_manager_secret_info ? unmarshalSecretManagerSecretInfo(data.secret_manager_secret_info) : void 0,
+    secretManagerVersionInfo: data.secret_manager_version_info ? unmarshalSecretManagerSecretVersionInfo(
+      data.secret_manager_version_info
+    ) : void 0,
+    type: data.type,
+    updatedAt: sdkClient.unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalEvent = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Event' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id,
+    locality: data.locality,
+    methodName: data.method_name,
+    organizationId: data.organization_id,
+    principal: data.principal ? unmarshalEventPrincipal(data.principal) : void 0,
+    productName: data.product_name,
+    projectId: data.project_id,
+    recordedAt: sdkClient.unmarshalDate(data.recorded_at),
+    requestBody: data.request_body,
+    requestId: data.request_id,
+    resource: data.resource ? unmarshalResource(data.resource) : void 0,
+    resources: sdkClient.unmarshalArrayOfObject(data.resources, unmarshalResource),
+    serviceName: data.service_name,
+    sourceIp: data.source_ip,
+    statusCode: data.status_code,
+    userAgent: data.user_agent
+  };
+};
+const unmarshalListEventsResponse = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListEventsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    events: sdkClient.unmarshalArrayOfObject(data.events, unmarshalEvent),
+    nextPageToken: data.next_page_token
+  };
+};
+const unmarshalProductService = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ProductService' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    methods: data.methods,
+    name: data.name
+  };
+};
+const unmarshalProduct = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Product' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name,
+    services: sdkClient.unmarshalArrayOfObject(data.services, unmarshalProductService),
+    title: data.title
+  };
+};
+const unmarshalListProductsResponse = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListProductsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    products: sdkClient.unmarshalArrayOfObject(data.products, unmarshalProduct),
+    totalCount: data.total_count
+  };
+};
+exports.unmarshalEvent = unmarshalEvent;
+exports.unmarshalListEventsResponse = unmarshalListEventsResponse;
+exports.unmarshalListProductsResponse = unmarshalListProductsResponse;
+exports.unmarshalResource = unmarshalResource;

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

@@ -0,0 +1,5 @@
+import type { Event, ListEventsResponse, ListProductsResponse, Resource } from './types.gen';
+export declare const unmarshalResource: (data: unknown) => Resource;
+export declare const unmarshalEvent: (data: unknown) => Event;
+export declare const unmarshalListEventsResponse: (data: unknown) => ListEventsResponse;
+export declare const unmarshalListProductsResponse: (data: unknown) => ListProductsResponse;

package/dist/v1alpha1/marshalling.gen.js

@@ -0,0 +1,180 @@
+import { isJSONObject, unmarshalDate, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+const unmarshalKeyManagerKeyInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KeyManagerKeyInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {};
+};
+const unmarshalKubernetesACLInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesACLInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {};
+};
+const unmarshalKubernetesClusterInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesClusterInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {};
+};
+const unmarshalKubernetesNodeInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesNodeInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id,
+    name: data.name
+  };
+};
+const unmarshalKubernetesPoolInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'KubernetesPoolInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id,
+    name: data.name
+  };
+};
+const unmarshalSecretManagerSecretInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SecretManagerSecretInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    path: data.path
+  };
+};
+const unmarshalSecretManagerSecretVersionInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SecretManagerSecretVersionInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    revision: data.revision
+  };
+};
+const unmarshalEventPrincipal = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EventPrincipal' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id
+  };
+};
+const unmarshalResource = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Resource' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    deletedAt: unmarshalDate(data.deleted_at),
+    id: data.id,
+    keyManagerKeyInfo: data.key_manager_key_info ? unmarshalKeyManagerKeyInfo(data.key_manager_key_info) : void 0,
+    keymKeyInfo: data.keym_key_info ? unmarshalKeyManagerKeyInfo(data.keym_key_info) : void 0,
+    kubeAclInfo: data.kube_acl_info ? unmarshalKubernetesACLInfo(data.kube_acl_info) : void 0,
+    kubeClusterInfo: data.kube_cluster_info ? unmarshalKubernetesClusterInfo(data.kube_cluster_info) : void 0,
+    kubeNodeInfo: data.kube_node_info ? unmarshalKubernetesNodeInfo(data.kube_node_info) : void 0,
+    kubePoolInfo: data.kube_pool_info ? unmarshalKubernetesPoolInfo(data.kube_pool_info) : void 0,
+    name: data.name,
+    secmSecretInfo: data.secm_secret_info ? unmarshalSecretManagerSecretInfo(data.secm_secret_info) : void 0,
+    secmSecretVersionInfo: data.secm_secret_version_info ? unmarshalSecretManagerSecretVersionInfo(data.secm_secret_version_info) : void 0,
+    secretManagerSecretInfo: data.secret_manager_secret_info ? unmarshalSecretManagerSecretInfo(data.secret_manager_secret_info) : void 0,
+    secretManagerVersionInfo: data.secret_manager_version_info ? unmarshalSecretManagerSecretVersionInfo(
+      data.secret_manager_version_info
+    ) : void 0,
+    type: data.type,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalEvent = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Event' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id,
+    locality: data.locality,
+    methodName: data.method_name,
+    organizationId: data.organization_id,
+    principal: data.principal ? unmarshalEventPrincipal(data.principal) : void 0,
+    productName: data.product_name,
+    projectId: data.project_id,
+    recordedAt: unmarshalDate(data.recorded_at),
+    requestBody: data.request_body,
+    requestId: data.request_id,
+    resource: data.resource ? unmarshalResource(data.resource) : void 0,
+    resources: unmarshalArrayOfObject(data.resources, unmarshalResource),
+    serviceName: data.service_name,
+    sourceIp: data.source_ip,
+    statusCode: data.status_code,
+    userAgent: data.user_agent
+  };
+};
+const unmarshalListEventsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListEventsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    events: unmarshalArrayOfObject(data.events, unmarshalEvent),
+    nextPageToken: data.next_page_token
+  };
+};
+const unmarshalProductService = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ProductService' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    methods: data.methods,
+    name: data.name
+  };
+};
+const unmarshalProduct = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Product' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name,
+    services: unmarshalArrayOfObject(data.services, unmarshalProductService),
+    title: data.title
+  };
+};
+const unmarshalListProductsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListProductsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    products: unmarshalArrayOfObject(data.products, unmarshalProduct),
+    totalCount: data.total_count
+  };
+};
+export {
+  unmarshalEvent,
+  unmarshalListEventsResponse,
+  unmarshalListProductsResponse,
+  unmarshalResource
+};

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

@@ -0,0 +1,246 @@
+import type { Region as ScwRegion } from '@scaleway/sdk-client';
+export type ListEventsRequestOrderBy = 'recorded_at_desc' | 'recorded_at_asc';
+export type ResourceType = 'unknown_type' | 'secm_secret' | 'secm_secret_version' | 'kube_cluster' | 'kube_pool' | 'kube_node' | 'kube_acl' | 'keym_key' | 'iam_user' | 'iam_application' | 'iam_group' | 'iam_policy' | 'iam_api_key' | 'iam_ssh_key' | 'iam_rule' | 'secret_manager_secret' | 'secret_manager_version' | 'key_manager_key';
+export interface KeyManagerKeyInfo {
+}
+export interface KubernetesACLInfo {
+}
+export interface KubernetesClusterInfo {
+}
+export interface KubernetesNodeInfo {
+    id: string;
+    name: string;
+}
+export interface KubernetesPoolInfo {
+    id: string;
+    name: string;
+}
+export interface SecretManagerSecretInfo {
+    path: string;
+}
+export interface SecretManagerSecretVersionInfo {
+    revision: number;
+}
+export interface EventPrincipal {
+    id: string;
+}
+export interface Resource {
+    id: string;
+    type: ResourceType;
+    createdAt?: Date;
+    updatedAt?: Date;
+    deletedAt?: Date;
+    name?: string;
+    /**
+     * @deprecated
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    secmSecretInfo?: SecretManagerSecretInfo;
+    /**
+     * @deprecated
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    secmSecretVersionInfo?: SecretManagerSecretVersionInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    kubeClusterInfo?: KubernetesClusterInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    kubePoolInfo?: KubernetesPoolInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    kubeNodeInfo?: KubernetesNodeInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    kubeAclInfo?: KubernetesACLInfo;
+    /**
+     * @deprecated
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    keymKeyInfo?: KeyManagerKeyInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    secretManagerSecretInfo?: SecretManagerSecretInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    secretManagerVersionInfo?: SecretManagerSecretVersionInfo;
+    /**
+     *
+     * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set.
+     */
+    keyManagerKeyInfo?: KeyManagerKeyInfo;
+}
+export interface ProductService {
+    name: string;
+    methods: string[];
+}
+export interface Event {
+    /**
+     * ID of the event.
+     */
+    id: string;
+    /**
+     * Timestamp of the event.
+     */
+    recordedAt?: Date;
+    /**
+     * Locality of the resource attached to the event.
+     */
+    locality: string;
+    /**
+     * User or IAM application at the origin of the event.
+     */
+    principal?: EventPrincipal;
+    /**
+     * Organization ID containing the event.
+     */
+    organizationId: string;
+    /**
+     * (Optional) Project of the resource attached to the event.
+     */
+    projectId?: string;
+    /**
+     * IP address at the origin of the event.
+     */
+    sourceIp: string;
+    /**
+     * User Agent at the origin of the event.
+     */
+    userAgent?: string;
+    /**
+     * Product name of the resource attached to the event.
+     */
+    productName: string;
+    /**
+     * API name called to trigger the event.
+     */
+    serviceName: string;
+    /**
+     * API method called to trigger the event.
+     */
+    methodName: string;
+    /**
+     * @deprecated Resource attached to the event.
+     */
+    resource?: Resource;
+    /**
+     * Resources attached to the event.
+     */
+    resources: Resource[];
+    /**
+     * Unique identifier of the request at the origin of the event.
+     */
+    requestId: string;
+    /**
+     * Request at the origin of the event.
+     */
+    requestBody?: Record<string, unknown>;
+    /**
+     * HTTP status code resulting of the API call.
+     */
+    statusCode: number;
+}
+export interface Product {
+    /**
+     * Product title.
+     */
+    title: string;
+    /**
+     * Product name.
+     */
+    name: string;
+    /**
+     * Specifies the API versions of the products integrated with Audit Trail. Each version defines the methods logged by Audit Trail.
+     */
+    services: ProductService[];
+}
+export type ListEventsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * (Optional) ID of the Project containing the Audit Trail events.
+     */
+    projectId?: string;
+    /**
+     * ID of the Organization containing the Audit Trail events.
+     */
+    organizationId?: string;
+    /**
+     * (Optional) Returns a paginated list of Scaleway resources' features.
+     */
+    resourceType?: ResourceType;
+    /**
+     * (Optional) Name of the method of the API call performed.
+     */
+    methodName?: string;
+    /**
+     * (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied.
+     */
+    status?: number;
+    /**
+     * (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default.
+     */
+    recordedAfter?: Date;
+    /**
+     * (Optional) The `recorded_before` parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns `now` by default.
+     */
+    recordedBefore?: Date;
+    orderBy?: ListEventsRequestOrderBy;
+    pageSize?: number;
+    pageToken?: string;
+    /**
+     * (Optional) Name of the Scaleway resource in a hyphenated format.
+     */
+    productName?: string;
+    /**
+     * (Optional) Name of the service of the API call performed.
+     */
+    serviceName?: string;
+};
+export interface ListEventsResponse {
+    /**
+     * Single page of events matching the requested criteria.
+     */
+    events: Event[];
+    /**
+     * Page token to use in following calls to keep listing.
+     */
+    nextPageToken?: string;
+}
+export type ListProductsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * ID of the Organization containing the Audit Trail events.
+     */
+    organizationId?: string;
+};
+export interface ListProductsResponse {
+    /**
+     * List of all products integrated with Audit Trail.
+     */
+    products: Product[];
+    /**
+     * Number of integrated products.
+     */
+    totalCount: number;
+}

package/dist/v1alpha1/validation-rules.gen.cjs

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ListEventsRequest = {
+  methodName: {
+    pattern: /^[a-zA-Z][a-zA-Z0-9_]*$/
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 1e3
+  },
+  productName: {
+    pattern: /^[a-z]+(-[a-z]+)*$/
+  },
+  serviceName: {
+    pattern: /^scaleway(\.[a-zA-Z0-9_-]*)*$/
+  },
+  status: {
+    greaterThanOrEqual: 200,
+    lessThan: 600
+  }
+};
+exports.ListEventsRequest = ListEventsRequest;

package/dist/v1alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,19 @@
+export declare const ListEventsRequest: {
+    methodName: {
+        pattern: RegExp;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    productName: {
+        pattern: RegExp;
+    };
+    serviceName: {
+        pattern: RegExp;
+    };
+    status: {
+        greaterThanOrEqual: number;
+        lessThan: number;
+    };
+};

package/dist/v1alpha1/validation-rules.gen.js

@@ -0,0 +1,22 @@
+const ListEventsRequest = {
+  methodName: {
+    pattern: /^[a-zA-Z][a-zA-Z0-9_]*$/
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 1e3
+  },
+  productName: {
+    pattern: /^[a-z]+(-[a-z]+)*$/
+  },
+  serviceName: {
+    pattern: /^scaleway(\.[a-zA-Z0-9_-]*)*$/
+  },
+  status: {
+    greaterThanOrEqual: 200,
+    lessThan: 600
+  }
+};
+export {
+  ListEventsRequest
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@scaleway/sdk-audit-trail",
+  "version": "1.0.1",
+  "description": "Scaleway SDK audit-trail",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.gen.d.ts",
+      "import": "./dist/index.gen.js",
+      "require": "./dist/index.gen.cjs",
+      "default": "./dist/index.gen.js"
+    },
+    "./*": {
+      "types": "./dist/*/index.gen.d.ts",
+      "import": "./dist/*/index.gen.js",
+      "require": "./dist/*/index.gen.cjs",
+      "default": "./dist/*/index.gen.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "directory": "packages_generated/audit-trail"
+  },
+  "engines": {
+    "node": ">=20.18.3"
+  },
+  "dependencies": {
+    "@scaleway/random-name": "5.1.1",
+    "@scaleway/sdk-std": "1.0.1"
+  },
+  "peerDependencies": {
+    "@scaleway/sdk-client": "^1.2.1"
+  },
+  "devDependencies": {
+    "@scaleway/sdk-client": "^1.2.1"
+  },
+  "bundledDependencies": [
+    "@scaleway/random-name"
+  ],
+  "scripts": {
+    "package:check": "pnpm publint",
+    "typecheck": "tsc --noEmit",
+    "type:generate": "tsc --declaration -p tsconfig.build.json",
+    "build": "vite build --config vite.config.ts && pnpm run type:generate",
+    "build:profile": "npx vite-bundle-visualizer -c vite.config.ts"
+  }
+}