@scaleway/sdk-audit-trail 1.6.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-audit-trail
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-audit-trail.svg)](https://www.npmjs.com/package/@scaleway/sdk-audit-trail)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-audit-trail.svg)](https://www.npmjs.com/package/@scaleway/sdk-audit-trail)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-audit-trail.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Audit Trail API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-audit-trail @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-audit-trail @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-audit-trail @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { AuditTrail } from '@scaleway/sdk-audit-trail'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new AuditTrail.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { AuditTrail } from '@scaleway/sdk-audit-trail'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new AuditTrail.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Audit Trail API Documentation](https://www.scaleway.com/en/developers/api/audit-trail/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

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

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CreateExportJobRequest, DeleteExportJobRequest, ExportJob, ListAuthenticationEventsRequest, ListAuthenticationEventsResponse, ListCombinedEventsRequest, ListCombinedEventsResponse, ListEventsRequest, ListEventsResponse, ListExportJobsRequest, ListExportJobsResponse, ListProductsRequest, ListProductsResponse } from './types.gen.js';
 /**
  * Audit Trail API.

package/dist/v1alpha1/api.gen.js

@@ -9,7 +9,10 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par", "nl-ams"]
+    regions: [
+      "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`.
@@ -24,14 +27,8 @@ class API extends API$1 {
       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
-        ],
+        ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["page_token", request.pageToken],
         ["principal_id", request.principalId],
         ["product_name", request.productName],
@@ -59,14 +56,8 @@ class API extends API$1 {
       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
-        ],
+        ["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]
@@ -80,14 +71,8 @@ class API extends API$1 {
       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
-        ],
+        ["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],
@@ -107,10 +92,9 @@ class API extends API$1 {
     {
       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
-      ])
+      urlParams: urlParams(
+        ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId]
+      )
     },
     unmarshalListProductsResponse
   );
@@ -136,10 +120,12 @@ class API extends API$1 {
    *
    * @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)}`
-  });
+  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",
@@ -147,15 +133,9 @@ class API extends API$1 {
       urlParams: urlParams(
         ["name", request.name],
         ["order_by", request.orderBy],
-        [
-          "organization_id",
-          request.organizationId ?? this.client.settings.defaultOrganizationId
-        ],
+        ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["tags", request.tags]
       )
     },

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

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+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 type { AccountContractSignatureInfo, AccountContractSignatureInfoAccountContractInfo, AccountOrganizationInfo, AccountProjectInfo, AccountUserInfo, AppleSiliconServerInfo, AuthenticationEvent, AuthenticationEventFailureReason, AuthenticationEventMethod, AuthenticationEventMFAType, AuthenticationEventOrigin, AuthenticationEventResult, BaremetalServerInfo, BaremetalSettingInfo, CreateExportJobRequest, DeleteExportJobRequest, EdgeServicesBackendStageInfo, EdgeServicesCacheStageInfo, EdgeServicesDNSStageInfo, EdgeServicesPipelineInfo, EdgeServicesPlanInfo, EdgeServicesRouteRulesInfo, EdgeServicesRouteStageInfo, EdgeServicesTLSStageInfo, EdgeServicesWAFStageInfo, 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/marshalling.gen.js

@@ -40,6 +40,34 @@ const unmarshalExportJob = (data) => {
     tags: data.tags
   };
 };
+const unmarshalAccountContractSignatureInfoAccountContractInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'AccountContractSignatureInfoAccountContractInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    type: data.type,
+    updatedAt: unmarshalDate(data.updated_at),
+    version: data.version
+  };
+};
+const unmarshalAccountContractSignatureInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'AccountContractSignatureInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    contract: data.contract ? unmarshalAccountContractSignatureInfoAccountContractInfo(data.contract) : void 0,
+    expiresAt: unmarshalDate(data.expires_at),
+    signedAt: unmarshalDate(data.signed_at),
+    signedByAccountRootUserId: data.signed_by_account_root_user_id
+  };
+};
 const unmarshalAccountOrganizationInfo = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -101,6 +129,94 @@ const unmarshalBaremetalSettingInfo = (data) => {
     type: data.type
   };
 };
+const unmarshalEdgeServicesBackendStageInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesBackendStageInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    pipelineId: data.pipeline_id
+  };
+};
+const unmarshalEdgeServicesCacheStageInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesCacheStageInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    pipelineId: data.pipeline_id
+  };
+};
+const unmarshalEdgeServicesDNSStageInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesDNSStageInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    pipelineId: data.pipeline_id
+  };
+};
+const unmarshalEdgeServicesPipelineInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesPipelineInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name
+  };
+};
+const unmarshalEdgeServicesPlanInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesPlanInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {};
+};
+const unmarshalEdgeServicesRouteRulesInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesRouteRulesInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    routeStageId: data.route_stage_id
+  };
+};
+const unmarshalEdgeServicesRouteStageInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesRouteStageInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    pipelineId: data.pipeline_id
+  };
+};
+const unmarshalEdgeServicesTLSStageInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesTLSStageInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    pipelineId: data.pipeline_id
+  };
+};
+const unmarshalEdgeServicesWAFStageInfo = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'EdgeServicesWAFStageInfo' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    pipelineId: data.pipeline_id
+  };
+};
 const unmarshalInstanceServerInfo = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -270,6 +386,7 @@ const unmarshalResource = (data) => {
     );
   }
   return {
+    accountContractSignatureInfo: data.account_contract_signature_info ? unmarshalAccountContractSignatureInfo(data.account_contract_signature_info) : void 0,
     accountOrganizationInfo: data.account_organization_info ? unmarshalAccountOrganizationInfo(data.account_organization_info) : void 0,
     accountProjectInfo: data.account_project_info ? unmarshalAccountProjectInfo(data.account_project_info) : void 0,
     accountUserInfo: data.account_user_info ? unmarshalAccountUserInfo(data.account_user_info) : void 0,
@@ -278,6 +395,15 @@ const unmarshalResource = (data) => {
     baremetalSettingInfo: data.baremetal_setting_info ? unmarshalBaremetalSettingInfo(data.baremetal_setting_info) : void 0,
     createdAt: unmarshalDate(data.created_at),
     deletedAt: unmarshalDate(data.deleted_at),
+    edgeServicesBackendStageInfo: data.edge_services_backend_stage_info ? unmarshalEdgeServicesBackendStageInfo(data.edge_services_backend_stage_info) : void 0,
+    edgeServicesCacheStageInfo: data.edge_services_cache_stage_info ? unmarshalEdgeServicesCacheStageInfo(data.edge_services_cache_stage_info) : void 0,
+    edgeServicesDnsStageInfo: data.edge_services_dns_stage_info ? unmarshalEdgeServicesDNSStageInfo(data.edge_services_dns_stage_info) : void 0,
+    edgeServicesPipelineInfo: data.edge_services_pipeline_info ? unmarshalEdgeServicesPipelineInfo(data.edge_services_pipeline_info) : void 0,
+    edgeServicesPlanInfo: data.edge_services_plan_info ? unmarshalEdgeServicesPlanInfo(data.edge_services_plan_info) : void 0,
+    edgeServicesRouteRulesInfo: data.edge_services_route_rules_info ? unmarshalEdgeServicesRouteRulesInfo(data.edge_services_route_rules_info) : void 0,
+    edgeServicesRouteStageInfo: data.edge_services_route_stage_info ? unmarshalEdgeServicesRouteStageInfo(data.edge_services_route_stage_info) : void 0,
+    edgeServicesTlsStageInfo: data.edge_services_tls_stage_info ? unmarshalEdgeServicesTLSStageInfo(data.edge_services_tls_stage_info) : void 0,
+    edgeServicesWafStageInfo: data.edge_services_waf_stage_info ? unmarshalEdgeServicesWAFStageInfo(data.edge_services_waf_stage_info) : void 0,
     id: data.id,
     instanceServerInfo: data.instance_server_info ? unmarshalInstanceServerInfo(data.instance_server_info) : void 0,
     ipamIpInfo: data.ipam_ip_info ? unmarshalIpamIpInfo(data.ipam_ip_info) : void 0,
@@ -289,9 +415,7 @@ const unmarshalResource = (data) => {
     kubePoolInfo: data.kube_pool_info ? unmarshalKubernetesPoolInfo(data.kube_pool_info) : void 0,
     loadBalancerAclInfo: data.load_balancer_acl_info ? unmarshalLoadBalancerAclInfo(data.load_balancer_acl_info) : void 0,
     loadBalancerBackendInfo: data.load_balancer_backend_info ? unmarshalLoadBalancerBackendInfo(data.load_balancer_backend_info) : void 0,
-    loadBalancerCertificateInfo: data.load_balancer_certificate_info ? unmarshalLoadBalancerCertificateInfo(
-      data.load_balancer_certificate_info
-    ) : void 0,
+    loadBalancerCertificateInfo: data.load_balancer_certificate_info ? unmarshalLoadBalancerCertificateInfo(data.load_balancer_certificate_info) : void 0,
     loadBalancerFrontendInfo: data.load_balancer_frontend_info ? unmarshalLoadBalancerFrontendInfo(data.load_balancer_frontend_info) : void 0,
     loadBalancerIpInfo: data.load_balancer_ip_info ? unmarshalLoadBalancerIpInfo(data.load_balancer_ip_info) : void 0,
     loadBalancerLbInfo: data.load_balancer_lb_info ? unmarshalLoadBalancerLbInfo(data.load_balancer_lb_info) : void 0,
@@ -300,9 +424,7 @@ const unmarshalResource = (data) => {
     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,
+    secretManagerVersionInfo: data.secret_manager_version_info ? unmarshalSecretManagerSecretVersionInfo(data.secret_manager_version_info) : void 0,
     type: data.type,
     updatedAt: unmarshalDate(data.updated_at)
   };
@@ -411,10 +533,7 @@ const unmarshalListCombinedEventsResponse = (data) => {
     );
   }
   return {
-    events: unmarshalArrayOfObject(
-      data.events,
-      unmarshalListCombinedEventsResponseCombinedEvent
-    ),
+    events: unmarshalArrayOfObject(data.events, unmarshalListCombinedEventsResponseCombinedEvent),
     nextPageToken: data.next_page_token
   };
 };