@scaleway/sdk-environmental-footprint 1.1.0 → 2.2.0

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-environmental-footprint
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-environmental-footprint.svg)](https://www.npmjs.com/package/@scaleway/sdk-environmental-footprint)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-environmental-footprint.svg)](https://www.npmjs.com/package/@scaleway/sdk-environmental-footprint)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-environmental-footprint.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Environmental Footprint 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-environmental-footprint @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-environmental-footprint @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-environmental-footprint @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 { EnvironmentalFootprint } from '@scaleway/sdk-environmental-footprint'
+
+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 EnvironmentalFootprint.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 { EnvironmentalFootprint } from '@scaleway/sdk-environmental-footprint'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new EnvironmentalFootprint.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Environmental Footprint API Documentation](https://www.scaleway.com/en/developers/api/environmental-footprint/)
+- 📖 [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.js

@@ -16,10 +16,7 @@ class UserAPI extends API {
       path: `/environmental-footprint/v1alpha1/reports/availability`,
       urlParams: urlParams(
         ["end_date", request.endDate],
-        [
-          "organization_id",
-          request.organizationId ?? this.client.settings.defaultOrganizationId
-        ],
+        ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId],
         ["start_date", request.startDate]
       )
     },
@@ -31,27 +28,23 @@ class UserAPI extends API {
    * @param request - The request {@link UserApiDownloadImpactReportRequest}
    * @returns A Promise of Blob
    */
-  downloadImpactReport = (request = {}) => this.client.fetch({
-    body: JSON.stringify(
-      marshalUserApiDownloadImpactReportRequest(
-        request,
-        this.client.settings
-      )
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/environmental-footprint/v1alpha1/reports/download`,
-    urlParams: urlParams(
-      ["dl", 1],
-      ["date", request.date],
-      [
-        "organization_id",
-        request.organizationId ?? this.client.settings.defaultOrganizationId
-      ],
-      ["type", request.type]
-    ),
-    responseType: "blob"
-  });
+  downloadImpactReport = (request = {}) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUserApiDownloadImpactReportRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/environmental-footprint/v1alpha1/reports/download`,
+      urlParams: urlParams(
+        ["dl", 1],
+        ["date", request.date],
+        ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId],
+        ["type", request.type]
+      ),
+      responseType: "blob"
+    }
+  );
   /**
    * Retrieve detailed impact data. Retrieve detailed impact data for your Scaleway projects within a specified date range. Filter by project ID, region, zone, service category, and/or product category.
    *
@@ -64,10 +57,7 @@ class UserAPI extends API {
       path: `/environmental-footprint/v1alpha1/data/query`,
       urlParams: urlParams(
         ["end_date", request.endDate],
-        [
-          "organization_id",
-          request.organizationId ?? this.client.settings.defaultOrganizationId
-        ],
+        ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId],
         ["product_categories", request.productCategories],
         ["project_ids", request.projectIds],
         ["regions", request.regions],

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

@@ -1,3 +1,3 @@
-export { UserAPI } from './api.gen.js';
+export { UserAPI, } from './api.gen.js';
 export * from './marshalling.gen.js';
 export type { Impact, ImpactDataResponse, ImpactReportAvailability, ProductCategory, ProjectImpact, RegionImpact, ReportType, ServiceCategory, SkuImpact, UserApiDownloadImpactReportRequest, UserApiGetImpactDataRequest, UserApiGetImpactReportAvailabilityRequest, ZoneImpact, } from './types.gen.js';

package/dist/v1alpha1/marshalling.gen.js

@@ -79,10 +79,7 @@ const unmarshalImpactReportAvailability = (data) => {
     );
   }
   return {
-    monthSummaryReports: unmarshalArrayOfObject(
-      data.month_summary_reports,
-      unmarshalDate
-    )
+    monthSummaryReports: unmarshalArrayOfObject(data.month_summary_reports, unmarshalDate)
   };
 };
 const marshalUserApiDownloadImpactReportRequest = (request, defaults) => ({

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

@@ -1,7 +1,7 @@
 import type { Region as ScwRegion, Zone as ScwZone } from '@scaleway/sdk-client';
-export type ProductCategory = 'unknown_product_category' | 'apple_silicon' | 'block_storage' | 'dedibox' | 'elastic_metal' | 'instances' | 'object_storage';
+export type ProductCategory = 'unknown_product_category' | 'apple_silicon' | 'block_storage' | 'dedibox' | 'elastic_metal' | 'instances' | 'object_storage' | 'load_balancer';
 export type ReportType = 'unknown_report_type' | 'monthly' | 'yearly';
-export type ServiceCategory = 'unknown_service_category' | 'baremetal' | 'compute' | 'storage';
+export type ServiceCategory = 'unknown_service_category' | 'baremetal' | 'compute' | 'storage' | 'network';
 export interface Impact {
     /**
      * The estimated carbon emissions in kilograms of CO₂ equivalent (kgCO₂e).

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-environmental-footprint",
-  "version": "1.1.0",
+  "version": "2.2.0",
   "description": "Scaleway SDK environmental-footprint",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "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"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/environmental-footprint"
   },
   "engines": {
-    "node": ">=20.18.3"
+    "node": ">=20.19.6"
   },
   "dependencies": {
-    "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.1.0"
+    "@scaleway/random-name": "5.1.2",
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

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

package/dist/v1alpha1/api.gen.cjs

@@ -1,84 +0,0 @@
-"use strict";
-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 UserAPI extends sdkClient.API {
-  /**
-   * Get available impact reports. Returns a list of dates of available impact reports.
-   *
-   * @param request - The request {@link UserApiGetImpactReportAvailabilityRequest}
-   * @returns A Promise of ImpactReportAvailability
-   */
-  getImpactReportAvailability = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/environmental-footprint/v1alpha1/reports/availability`,
-      urlParams: sdkClient.urlParams(
-        ["end_date", request.endDate],
-        [
-          "organization_id",
-          request.organizationId ?? this.client.settings.defaultOrganizationId
-        ],
-        ["start_date", request.startDate]
-      )
-    },
-    marshalling_gen.unmarshalImpactReportAvailability
-  );
-  /**
-   * Download PDF impact report. Download a Scaleway impact PDF report with detailed impact data for your Scaleway projects.
-   *
-   * @param request - The request {@link UserApiDownloadImpactReportRequest}
-   * @returns A Promise of Blob
-   */
-  downloadImpactReport = (request = {}) => this.client.fetch({
-    body: JSON.stringify(
-      marshalling_gen.marshalUserApiDownloadImpactReportRequest(
-        request,
-        this.client.settings
-      )
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/environmental-footprint/v1alpha1/reports/download`,
-    urlParams: sdkClient.urlParams(
-      ["dl", 1],
-      ["date", request.date],
-      [
-        "organization_id",
-        request.organizationId ?? this.client.settings.defaultOrganizationId
-      ],
-      ["type", request.type]
-    ),
-    responseType: "blob"
-  });
-  /**
-   * Retrieve detailed impact data. Retrieve detailed impact data for your Scaleway projects within a specified date range. Filter by project ID, region, zone, service category, and/or product category.
-   *
-   * @param request - The request {@link UserApiGetImpactDataRequest}
-   * @returns A Promise of ImpactDataResponse
-   */
-  getImpactData = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/environmental-footprint/v1alpha1/data/query`,
-      urlParams: sdkClient.urlParams(
-        ["end_date", request.endDate],
-        [
-          "organization_id",
-          request.organizationId ?? this.client.settings.defaultOrganizationId
-        ],
-        ["product_categories", request.productCategories],
-        ["project_ids", request.projectIds],
-        ["regions", request.regions],
-        ["service_categories", request.serviceCategories],
-        ["start_date", request.startDate],
-        ["zones", request.zones]
-      )
-    },
-    marshalling_gen.unmarshalImpactDataResponse
-  );
-}
-exports.UserAPI = UserAPI;

package/dist/v1alpha1/index.gen.cjs

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-exports.UserAPI = api_gen.UserAPI;
-exports.marshalUserApiDownloadImpactReportRequest = marshalling_gen.marshalUserApiDownloadImpactReportRequest;
-exports.unmarshalImpactDataResponse = marshalling_gen.unmarshalImpactDataResponse;
-exports.unmarshalImpactReportAvailability = marshalling_gen.unmarshalImpactReportAvailability;

package/dist/v1alpha1/marshalling.gen.cjs

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const unmarshalImpact = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Impact' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    kgCo2Equivalent: data.kg_co2_equivalent,
-    m3WaterUsage: data.m3_water_usage
-  };
-};
-const unmarshalSkuImpact = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'SkuImpact' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    productCategory: data.product_category,
-    serviceCategory: data.service_category,
-    sku: data.sku,
-    totalSkuImpact: data.total_sku_impact ? unmarshalImpact(data.total_sku_impact) : void 0
-  };
-};
-const unmarshalZoneImpact = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ZoneImpact' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    skus: sdkClient.unmarshalArrayOfObject(data.skus, unmarshalSkuImpact),
-    totalZoneImpact: data.total_zone_impact ? unmarshalImpact(data.total_zone_impact) : void 0,
-    zone: data.zone
-  };
-};
-const unmarshalRegionImpact = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'RegionImpact' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    region: data.region,
-    totalRegionImpact: data.total_region_impact ? unmarshalImpact(data.total_region_impact) : void 0,
-    zones: sdkClient.unmarshalArrayOfObject(data.zones, unmarshalZoneImpact)
-  };
-};
-const unmarshalProjectImpact = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ProjectImpact' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    projectId: data.project_id,
-    regions: sdkClient.unmarshalArrayOfObject(data.regions, unmarshalRegionImpact),
-    totalProjectImpact: data.total_project_impact ? unmarshalImpact(data.total_project_impact) : void 0
-  };
-};
-const unmarshalImpactDataResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ImpactDataResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    endDate: sdkClient.unmarshalDate(data.end_date),
-    projects: sdkClient.unmarshalArrayOfObject(data.projects, unmarshalProjectImpact),
-    startDate: sdkClient.unmarshalDate(data.start_date),
-    totalImpact: data.total_impact ? unmarshalImpact(data.total_impact) : void 0
-  };
-};
-const unmarshalImpactReportAvailability = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ImpactReportAvailability' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    monthSummaryReports: sdkClient.unmarshalArrayOfObject(
-      data.month_summary_reports,
-      sdkClient.unmarshalDate
-    )
-  };
-};
-const marshalUserApiDownloadImpactReportRequest = (request, defaults) => ({
-  date: request.date,
-  organization_id: request.organizationId ?? defaults.defaultOrganizationId,
-  type: request.type
-});
-exports.marshalUserApiDownloadImpactReportRequest = marshalUserApiDownloadImpactReportRequest;
-exports.unmarshalImpactDataResponse = unmarshalImpactDataResponse;
-exports.unmarshalImpactReportAvailability = unmarshalImpactReportAvailability;