diff --git a/packages_generated/account/README.md b/packages_generated/account/README.md new file mode 100644 index 000000000..64e3f7eb0 --- /dev/null +++ b/packages_generated/account/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-account + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-account.svg)](https://www.npmjs.com/package/@scaleway/sdk-account) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-account.svg)](https://www.npmjs.com/package/@scaleway/sdk-account) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-account.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Account 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-account @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-account @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-account @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 { Account } from '@scaleway/sdk-account' + +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 Account.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 { Account } from '@scaleway/sdk-account' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Account.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Account API Documentation](https://www.scaleway.com/en/developers/api/account/) +- 📖 [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. + diff --git a/packages_generated/account/package.json b/packages_generated/account/package.json index 39544a9e0..89375e281 100644 --- a/packages_generated/account/package.json +++ b/packages_generated/account/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK account", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/applesilicon/README.md b/packages_generated/applesilicon/README.md new file mode 100644 index 000000000..27e8cfa7a --- /dev/null +++ b/packages_generated/applesilicon/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-applesilicon + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-applesilicon.svg)](https://www.npmjs.com/package/@scaleway/sdk-applesilicon) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-applesilicon.svg)](https://www.npmjs.com/package/@scaleway/sdk-applesilicon) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-applesilicon.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Applesilicon 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-applesilicon @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-applesilicon @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-applesilicon @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 { Applesilicon } from '@scaleway/sdk-applesilicon' + +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 Applesilicon.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 { Applesilicon } from '@scaleway/sdk-applesilicon' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Applesilicon.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Applesilicon API Documentation](https://www.scaleway.com/en/developers/api/applesilicon/) +- 📖 [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. + diff --git a/packages_generated/applesilicon/package.json b/packages_generated/applesilicon/package.json index 52d2fe74e..6b949803a 100644 --- a/packages_generated/applesilicon/package.json +++ b/packages_generated/applesilicon/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK applesilicon", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/audit_trail/README.md b/packages_generated/audit_trail/README.md new file mode 100644 index 000000000..70310d806 --- /dev/null +++ b/packages_generated/audit_trail/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. + diff --git a/packages_generated/audit_trail/package.json b/packages_generated/audit_trail/package.json index f1b0500b7..77a935919 100644 --- a/packages_generated/audit_trail/package.json +++ b/packages_generated/audit_trail/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK audit-trail", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/autoscaling/README.md b/packages_generated/autoscaling/README.md new file mode 100644 index 000000000..08bc3b78a --- /dev/null +++ b/packages_generated/autoscaling/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-autoscaling + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-autoscaling.svg)](https://www.npmjs.com/package/@scaleway/sdk-autoscaling) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-autoscaling.svg)](https://www.npmjs.com/package/@scaleway/sdk-autoscaling) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-autoscaling.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Autoscaling 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-autoscaling @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-autoscaling @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-autoscaling @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 { Autoscaling } from '@scaleway/sdk-autoscaling' + +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 Autoscaling.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 { Autoscaling } from '@scaleway/sdk-autoscaling' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Autoscaling.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Autoscaling API Documentation](https://www.scaleway.com/en/developers/api/autoscaling/) +- 📖 [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. + diff --git a/packages_generated/autoscaling/package.json b/packages_generated/autoscaling/package.json index ed37c565d..0d5b87cfc 100644 --- a/packages_generated/autoscaling/package.json +++ b/packages_generated/autoscaling/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK autoscaling", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/baremetal/README.md b/packages_generated/baremetal/README.md new file mode 100644 index 000000000..812a47979 --- /dev/null +++ b/packages_generated/baremetal/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-baremetal + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-baremetal.svg)](https://www.npmjs.com/package/@scaleway/sdk-baremetal) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-baremetal.svg)](https://www.npmjs.com/package/@scaleway/sdk-baremetal) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-baremetal.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Baremetal 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-baremetal @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-baremetal @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-baremetal @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 { Baremetal } from '@scaleway/sdk-baremetal' + +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 Baremetal.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 { Baremetal } from '@scaleway/sdk-baremetal' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Baremetal.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Baremetal API Documentation](https://www.scaleway.com/en/developers/api/baremetal/) +- 📖 [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. + diff --git a/packages_generated/baremetal/package.json b/packages_generated/baremetal/package.json index c0ac711d5..9a2fdce30 100644 --- a/packages_generated/baremetal/package.json +++ b/packages_generated/baremetal/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK baremetal", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/billing/README.md b/packages_generated/billing/README.md new file mode 100644 index 000000000..fd0a4da87 --- /dev/null +++ b/packages_generated/billing/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-billing + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-billing.svg)](https://www.npmjs.com/package/@scaleway/sdk-billing) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-billing.svg)](https://www.npmjs.com/package/@scaleway/sdk-billing) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-billing.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Billing 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-billing @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-billing @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-billing @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 { Billing } from '@scaleway/sdk-billing' + +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 Billing.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 { Billing } from '@scaleway/sdk-billing' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Billing.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Billing API Documentation](https://www.scaleway.com/en/developers/api/billing/) +- 📖 [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. + diff --git a/packages_generated/billing/package.json b/packages_generated/billing/package.json index 4bc95976d..3bc983bc4 100644 --- a/packages_generated/billing/package.json +++ b/packages_generated/billing/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK billing", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/block/README.md b/packages_generated/block/README.md new file mode 100644 index 000000000..141f90a0c --- /dev/null +++ b/packages_generated/block/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-block + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-block.svg)](https://www.npmjs.com/package/@scaleway/sdk-block) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-block.svg)](https://www.npmjs.com/package/@scaleway/sdk-block) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-block.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Block 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-block @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-block @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-block @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 { Block } from '@scaleway/sdk-block' + +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 Block.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 { Block } from '@scaleway/sdk-block' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Block.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Block API Documentation](https://www.scaleway.com/en/developers/api/block/) +- 📖 [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. + diff --git a/packages_generated/block/package.json b/packages_generated/block/package.json index 0a488c5cf..786969845 100644 --- a/packages_generated/block/package.json +++ b/packages_generated/block/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK block", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/cockpit/README.md b/packages_generated/cockpit/README.md new file mode 100644 index 000000000..8f08cc1da --- /dev/null +++ b/packages_generated/cockpit/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-cockpit + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-cockpit.svg)](https://www.npmjs.com/package/@scaleway/sdk-cockpit) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-cockpit.svg)](https://www.npmjs.com/package/@scaleway/sdk-cockpit) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-cockpit.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Cockpit 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-cockpit @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-cockpit @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-cockpit @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 { Cockpit } from '@scaleway/sdk-cockpit' + +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 Cockpit.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 { Cockpit } from '@scaleway/sdk-cockpit' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Cockpit.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Cockpit API Documentation](https://www.scaleway.com/en/developers/api/cockpit/) +- 📖 [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. + diff --git a/packages_generated/cockpit/package.json b/packages_generated/cockpit/package.json index 030eced1f..b4952feb0 100644 --- a/packages_generated/cockpit/package.json +++ b/packages_generated/cockpit/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK cockpit", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/container/README.md b/packages_generated/container/README.md new file mode 100644 index 000000000..22d5ef8cf --- /dev/null +++ b/packages_generated/container/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-container + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-container.svg)](https://www.npmjs.com/package/@scaleway/sdk-container) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-container.svg)](https://www.npmjs.com/package/@scaleway/sdk-container) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-container.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Container 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-container @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-container @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-container @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 { Container } from '@scaleway/sdk-container' + +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 Container.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 { Container } from '@scaleway/sdk-container' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Container.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Container API Documentation](https://www.scaleway.com/en/developers/api/container/) +- 📖 [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. + diff --git a/packages_generated/container/package.json b/packages_generated/container/package.json index 53dde83ae..9f6a170dc 100644 --- a/packages_generated/container/package.json +++ b/packages_generated/container/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK container", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/datawarehouse/README.md b/packages_generated/datawarehouse/README.md new file mode 100644 index 000000000..dfcba5f8d --- /dev/null +++ b/packages_generated/datawarehouse/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-datawarehouse + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-datawarehouse.svg)](https://www.npmjs.com/package/@scaleway/sdk-datawarehouse) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-datawarehouse.svg)](https://www.npmjs.com/package/@scaleway/sdk-datawarehouse) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-datawarehouse.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Datawarehouse 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-datawarehouse @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-datawarehouse @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-datawarehouse @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 { Datawarehouse } from '@scaleway/sdk-datawarehouse' + +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 Datawarehouse.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 { Datawarehouse } from '@scaleway/sdk-datawarehouse' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Datawarehouse.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Datawarehouse API Documentation](https://www.scaleway.com/en/developers/api/datawarehouse/) +- 📖 [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. + diff --git a/packages_generated/datawarehouse/package.json b/packages_generated/datawarehouse/package.json index 42db32907..ed361c64a 100644 --- a/packages_generated/datawarehouse/package.json +++ b/packages_generated/datawarehouse/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK datawarehouse", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/dedibox/README.md b/packages_generated/dedibox/README.md new file mode 100644 index 000000000..15bc68999 --- /dev/null +++ b/packages_generated/dedibox/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-dedibox + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-dedibox.svg)](https://www.npmjs.com/package/@scaleway/sdk-dedibox) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-dedibox.svg)](https://www.npmjs.com/package/@scaleway/sdk-dedibox) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-dedibox.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Dedibox 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-dedibox @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-dedibox @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-dedibox @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 { Dedibox } from '@scaleway/sdk-dedibox' + +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 Dedibox.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 { Dedibox } from '@scaleway/sdk-dedibox' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Dedibox.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Dedibox API Documentation](https://www.scaleway.com/en/developers/api/dedibox/) +- 📖 [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. + diff --git a/packages_generated/dedibox/package.json b/packages_generated/dedibox/package.json index a10b9fc63..83b4a451c 100644 --- a/packages_generated/dedibox/package.json +++ b/packages_generated/dedibox/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK dedibox", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/domain/README.md b/packages_generated/domain/README.md new file mode 100644 index 000000000..9419ac0a7 --- /dev/null +++ b/packages_generated/domain/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-domain + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-domain.svg)](https://www.npmjs.com/package/@scaleway/sdk-domain) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-domain.svg)](https://www.npmjs.com/package/@scaleway/sdk-domain) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-domain.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Domain 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-domain @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-domain @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-domain @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 { Domain } from '@scaleway/sdk-domain' + +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 Domain.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 { Domain } from '@scaleway/sdk-domain' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Domain.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Domain API Documentation](https://www.scaleway.com/en/developers/api/domain/) +- 📖 [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. + diff --git a/packages_generated/domain/package.json b/packages_generated/domain/package.json index 284239398..595e0d6ef 100644 --- a/packages_generated/domain/package.json +++ b/packages_generated/domain/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK domain", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/edge_services/README.md b/packages_generated/edge_services/README.md new file mode 100644 index 000000000..b0b5ac7da --- /dev/null +++ b/packages_generated/edge_services/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-edge-services + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-edge-services.svg)](https://www.npmjs.com/package/@scaleway/sdk-edge-services) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-edge-services.svg)](https://www.npmjs.com/package/@scaleway/sdk-edge-services) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-edge-services.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Edge Services 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-edge-services @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-edge-services @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-edge-services @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 { EdgeServices } from '@scaleway/sdk-edge-services' + +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 EdgeServices.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 { EdgeServices } from '@scaleway/sdk-edge-services' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new EdgeServices.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Edge Services API Documentation](https://www.scaleway.com/en/developers/api/edge-services/) +- 📖 [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. + diff --git a/packages_generated/edge_services/package.json b/packages_generated/edge_services/package.json index a1136a5e9..806507542 100644 --- a/packages_generated/edge_services/package.json +++ b/packages_generated/edge_services/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK edge-services", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/environmental_footprint/README.md b/packages_generated/environmental_footprint/README.md new file mode 100644 index 000000000..427cc9024 --- /dev/null +++ b/packages_generated/environmental_footprint/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. + diff --git a/packages_generated/environmental_footprint/package.json b/packages_generated/environmental_footprint/package.json index deb5e3df6..d5e566a3d 100644 --- a/packages_generated/environmental_footprint/package.json +++ b/packages_generated/environmental_footprint/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK environmental-footprint", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/file/README.md b/packages_generated/file/README.md new file mode 100644 index 000000000..9a58eb3a3 --- /dev/null +++ b/packages_generated/file/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-file + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-file.svg)](https://www.npmjs.com/package/@scaleway/sdk-file) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-file.svg)](https://www.npmjs.com/package/@scaleway/sdk-file) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-file.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for File 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-file @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-file @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-file @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 { File } from '@scaleway/sdk-file' + +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 File.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 { File } from '@scaleway/sdk-file' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new File.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway File API Documentation](https://www.scaleway.com/en/developers/api/file/) +- 📖 [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. + diff --git a/packages_generated/file/package.json b/packages_generated/file/package.json index 17f979567..56662a939 100644 --- a/packages_generated/file/package.json +++ b/packages_generated/file/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK file", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/flexibleip/README.md b/packages_generated/flexibleip/README.md new file mode 100644 index 000000000..36054fd23 --- /dev/null +++ b/packages_generated/flexibleip/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-flexibleip + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-flexibleip.svg)](https://www.npmjs.com/package/@scaleway/sdk-flexibleip) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-flexibleip.svg)](https://www.npmjs.com/package/@scaleway/sdk-flexibleip) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-flexibleip.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Flexibleip 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-flexibleip @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-flexibleip @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-flexibleip @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 { Flexibleip } from '@scaleway/sdk-flexibleip' + +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 Flexibleip.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 { Flexibleip } from '@scaleway/sdk-flexibleip' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Flexibleip.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Flexibleip API Documentation](https://www.scaleway.com/en/developers/api/flexibleip/) +- 📖 [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. + diff --git a/packages_generated/flexibleip/package.json b/packages_generated/flexibleip/package.json index 0a93fd2ce..eea895c44 100644 --- a/packages_generated/flexibleip/package.json +++ b/packages_generated/flexibleip/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK flexibleip", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/function/README.md b/packages_generated/function/README.md new file mode 100644 index 000000000..c9008fefd --- /dev/null +++ b/packages_generated/function/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-function + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-function.svg)](https://www.npmjs.com/package/@scaleway/sdk-function) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-function.svg)](https://www.npmjs.com/package/@scaleway/sdk-function) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-function.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Function 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-function @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-function @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-function @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 { Function } from '@scaleway/sdk-function' + +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 Function.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 { Function } from '@scaleway/sdk-function' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Function.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Function API Documentation](https://www.scaleway.com/en/developers/api/function/) +- 📖 [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. + diff --git a/packages_generated/function/package.json b/packages_generated/function/package.json index 288369f62..35aac8a27 100644 --- a/packages_generated/function/package.json +++ b/packages_generated/function/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK function", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/iam/README.md b/packages_generated/iam/README.md new file mode 100644 index 000000000..0c4608c22 --- /dev/null +++ b/packages_generated/iam/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-iam + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-iam.svg)](https://www.npmjs.com/package/@scaleway/sdk-iam) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-iam.svg)](https://www.npmjs.com/package/@scaleway/sdk-iam) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-iam.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Iam 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-iam @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-iam @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-iam @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 { Iam } from '@scaleway/sdk-iam' + +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 Iam.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 { Iam } from '@scaleway/sdk-iam' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Iam.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Iam API Documentation](https://www.scaleway.com/en/developers/api/iam/) +- 📖 [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. + diff --git a/packages_generated/iam/package.json b/packages_generated/iam/package.json index bf0cca2d7..4e1db3caf 100644 --- a/packages_generated/iam/package.json +++ b/packages_generated/iam/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK iam", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/inference/README.md b/packages_generated/inference/README.md new file mode 100644 index 000000000..5e9c135f0 --- /dev/null +++ b/packages_generated/inference/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-inference + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-inference.svg)](https://www.npmjs.com/package/@scaleway/sdk-inference) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-inference.svg)](https://www.npmjs.com/package/@scaleway/sdk-inference) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-inference.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Inference 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-inference @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-inference @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-inference @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 { Inference } from '@scaleway/sdk-inference' + +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 Inference.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 { Inference } from '@scaleway/sdk-inference' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Inference.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Inference API Documentation](https://www.scaleway.com/en/developers/api/inference/) +- 📖 [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. + diff --git a/packages_generated/inference/package.json b/packages_generated/inference/package.json index c2cd9b8d5..9da517160 100644 --- a/packages_generated/inference/package.json +++ b/packages_generated/inference/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK inference", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/instance/README.md b/packages_generated/instance/README.md new file mode 100644 index 000000000..a9ed59732 --- /dev/null +++ b/packages_generated/instance/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-instance + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-instance.svg)](https://www.npmjs.com/package/@scaleway/sdk-instance) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-instance.svg)](https://www.npmjs.com/package/@scaleway/sdk-instance) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-instance.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Instance 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-instance @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-instance @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-instance @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 { Instance } from '@scaleway/sdk-instance' + +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 Instance.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 { Instance } from '@scaleway/sdk-instance' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Instance.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Instance API Documentation](https://www.scaleway.com/en/developers/api/instance/) +- 📖 [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. + diff --git a/packages_generated/instance/package.json b/packages_generated/instance/package.json index 171e57ac9..476064390 100644 --- a/packages_generated/instance/package.json +++ b/packages_generated/instance/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK instance", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/interlink/README.md b/packages_generated/interlink/README.md new file mode 100644 index 000000000..5ea2a36ce --- /dev/null +++ b/packages_generated/interlink/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-interlink + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-interlink.svg)](https://www.npmjs.com/package/@scaleway/sdk-interlink) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-interlink.svg)](https://www.npmjs.com/package/@scaleway/sdk-interlink) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-interlink.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Interlink 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-interlink @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-interlink @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-interlink @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 { Interlink } from '@scaleway/sdk-interlink' + +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 Interlink.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 { Interlink } from '@scaleway/sdk-interlink' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Interlink.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Interlink API Documentation](https://www.scaleway.com/en/developers/api/interlink/) +- 📖 [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. + diff --git a/packages_generated/interlink/package.json b/packages_generated/interlink/package.json index ed588fe3f..985a2d49d 100644 --- a/packages_generated/interlink/package.json +++ b/packages_generated/interlink/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK interlink", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/iot/README.md b/packages_generated/iot/README.md new file mode 100644 index 000000000..cc6101c85 --- /dev/null +++ b/packages_generated/iot/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-iot + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-iot.svg)](https://www.npmjs.com/package/@scaleway/sdk-iot) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-iot.svg)](https://www.npmjs.com/package/@scaleway/sdk-iot) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-iot.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Iot 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-iot @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-iot @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-iot @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 { Iot } from '@scaleway/sdk-iot' + +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 Iot.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 { Iot } from '@scaleway/sdk-iot' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Iot.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Iot API Documentation](https://www.scaleway.com/en/developers/api/iot/) +- 📖 [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. + diff --git a/packages_generated/iot/package.json b/packages_generated/iot/package.json index 788aea44d..ddd8c66aa 100644 --- a/packages_generated/iot/package.json +++ b/packages_generated/iot/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK iot", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/ipam/README.md b/packages_generated/ipam/README.md new file mode 100644 index 000000000..e6c6f7ad7 --- /dev/null +++ b/packages_generated/ipam/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-ipam + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-ipam.svg)](https://www.npmjs.com/package/@scaleway/sdk-ipam) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-ipam.svg)](https://www.npmjs.com/package/@scaleway/sdk-ipam) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-ipam.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Ipam 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-ipam @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-ipam @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-ipam @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 { Ipam } from '@scaleway/sdk-ipam' + +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 Ipam.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 { Ipam } from '@scaleway/sdk-ipam' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Ipam.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Ipam API Documentation](https://www.scaleway.com/en/developers/api/ipam/) +- 📖 [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. + diff --git a/packages_generated/ipam/package.json b/packages_generated/ipam/package.json index 0cd51d543..d1df9ab27 100644 --- a/packages_generated/ipam/package.json +++ b/packages_generated/ipam/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK ipam", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/jobs/README.md b/packages_generated/jobs/README.md new file mode 100644 index 000000000..db78a804b --- /dev/null +++ b/packages_generated/jobs/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-jobs + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-jobs.svg)](https://www.npmjs.com/package/@scaleway/sdk-jobs) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-jobs.svg)](https://www.npmjs.com/package/@scaleway/sdk-jobs) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-jobs.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Jobs 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-jobs @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-jobs @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-jobs @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 { Jobs } from '@scaleway/sdk-jobs' + +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 Jobs.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 { Jobs } from '@scaleway/sdk-jobs' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Jobs.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Jobs API Documentation](https://www.scaleway.com/en/developers/api/jobs/) +- 📖 [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. + diff --git a/packages_generated/jobs/package.json b/packages_generated/jobs/package.json index 2f5deada8..75865cef4 100644 --- a/packages_generated/jobs/package.json +++ b/packages_generated/jobs/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK jobs", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/k8s/README.md b/packages_generated/k8s/README.md new file mode 100644 index 000000000..f082dac0d --- /dev/null +++ b/packages_generated/k8s/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-k8s + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-k8s.svg)](https://www.npmjs.com/package/@scaleway/sdk-k8s) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-k8s.svg)](https://www.npmjs.com/package/@scaleway/sdk-k8s) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-k8s.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for K8S 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-k8s @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-k8s @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-k8s @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 { K8S } from '@scaleway/sdk-k8s' + +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 K8S.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 { K8S } from '@scaleway/sdk-k8s' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new K8S.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway K8S API Documentation](https://www.scaleway.com/en/developers/api/k8s/) +- 📖 [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. + diff --git a/packages_generated/k8s/package.json b/packages_generated/k8s/package.json index 48ce36529..65ce6e780 100644 --- a/packages_generated/k8s/package.json +++ b/packages_generated/k8s/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK k8s", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/key_manager/README.md b/packages_generated/key_manager/README.md new file mode 100644 index 000000000..ab4f54680 --- /dev/null +++ b/packages_generated/key_manager/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-key-manager + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-key-manager.svg)](https://www.npmjs.com/package/@scaleway/sdk-key-manager) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-key-manager.svg)](https://www.npmjs.com/package/@scaleway/sdk-key-manager) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-key-manager.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Key Manager 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-key-manager @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-key-manager @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-key-manager @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 { KeyManager } from '@scaleway/sdk-key-manager' + +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 KeyManager.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 { KeyManager } from '@scaleway/sdk-key-manager' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new KeyManager.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Key Manager API Documentation](https://www.scaleway.com/en/developers/api/key-manager/) +- 📖 [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. + diff --git a/packages_generated/key_manager/package.json b/packages_generated/key_manager/package.json index e2e4a36d3..77ffda33c 100644 --- a/packages_generated/key_manager/package.json +++ b/packages_generated/key_manager/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK key-manager", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/lb/README.md b/packages_generated/lb/README.md new file mode 100644 index 000000000..0133a9fab --- /dev/null +++ b/packages_generated/lb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-lb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-lb.svg)](https://www.npmjs.com/package/@scaleway/sdk-lb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-lb.svg)](https://www.npmjs.com/package/@scaleway/sdk-lb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-lb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Lb 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-lb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-lb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-lb @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 { Lb } from '@scaleway/sdk-lb' + +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 Lb.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 { Lb } from '@scaleway/sdk-lb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Lb.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Lb API Documentation](https://www.scaleway.com/en/developers/api/lb/) +- 📖 [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. + diff --git a/packages_generated/lb/package.json b/packages_generated/lb/package.json index 53f67a673..a5488cd57 100644 --- a/packages_generated/lb/package.json +++ b/packages_generated/lb/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK lb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/marketplace/README.md b/packages_generated/marketplace/README.md new file mode 100644 index 000000000..8a0b32056 --- /dev/null +++ b/packages_generated/marketplace/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-marketplace + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-marketplace.svg)](https://www.npmjs.com/package/@scaleway/sdk-marketplace) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-marketplace.svg)](https://www.npmjs.com/package/@scaleway/sdk-marketplace) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-marketplace.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Marketplace 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-marketplace @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-marketplace @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-marketplace @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 { Marketplace } from '@scaleway/sdk-marketplace' + +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 Marketplace.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 { Marketplace } from '@scaleway/sdk-marketplace' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Marketplace.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Marketplace API Documentation](https://www.scaleway.com/en/developers/api/marketplace/) +- 📖 [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. + diff --git a/packages_generated/marketplace/package.json b/packages_generated/marketplace/package.json index e2fa0a1f8..8536f2fa5 100644 --- a/packages_generated/marketplace/package.json +++ b/packages_generated/marketplace/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK marketplace", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/mnq/README.md b/packages_generated/mnq/README.md new file mode 100644 index 000000000..eab48098a --- /dev/null +++ b/packages_generated/mnq/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-mnq + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-mnq.svg)](https://www.npmjs.com/package/@scaleway/sdk-mnq) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-mnq.svg)](https://www.npmjs.com/package/@scaleway/sdk-mnq) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-mnq.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Mnq 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-mnq @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-mnq @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-mnq @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 { Mnq } from '@scaleway/sdk-mnq' + +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 Mnq.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 { Mnq } from '@scaleway/sdk-mnq' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Mnq.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Mnq API Documentation](https://www.scaleway.com/en/developers/api/mnq/) +- 📖 [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. + diff --git a/packages_generated/mnq/package.json b/packages_generated/mnq/package.json index 488c17704..9011fa81c 100644 --- a/packages_generated/mnq/package.json +++ b/packages_generated/mnq/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK mnq", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/mongodb/README.md b/packages_generated/mongodb/README.md new file mode 100644 index 000000000..11826f85d --- /dev/null +++ b/packages_generated/mongodb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-mongodb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-mongodb.svg)](https://www.npmjs.com/package/@scaleway/sdk-mongodb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-mongodb.svg)](https://www.npmjs.com/package/@scaleway/sdk-mongodb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-mongodb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Mongodb 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-mongodb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-mongodb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-mongodb @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 { Mongodb } from '@scaleway/sdk-mongodb' + +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 Mongodb.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 { Mongodb } from '@scaleway/sdk-mongodb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Mongodb.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Mongodb API Documentation](https://www.scaleway.com/en/developers/api/mongodb/) +- 📖 [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. + diff --git a/packages_generated/mongodb/package.json b/packages_generated/mongodb/package.json index cf1aeb405..30f49ac8e 100644 --- a/packages_generated/mongodb/package.json +++ b/packages_generated/mongodb/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK mongodb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/product_catalog/README.md b/packages_generated/product_catalog/README.md new file mode 100644 index 000000000..6c0ba955b --- /dev/null +++ b/packages_generated/product_catalog/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-product-catalog + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-product-catalog.svg)](https://www.npmjs.com/package/@scaleway/sdk-product-catalog) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-product-catalog.svg)](https://www.npmjs.com/package/@scaleway/sdk-product-catalog) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-product-catalog.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Product Catalog 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-product-catalog @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-product-catalog @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-product-catalog @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 { ProductCatalog } from '@scaleway/sdk-product-catalog' + +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 ProductCatalog.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 { ProductCatalog } from '@scaleway/sdk-product-catalog' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new ProductCatalog.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Product Catalog API Documentation](https://www.scaleway.com/en/developers/api/product-catalog/) +- 📖 [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. + diff --git a/packages_generated/product_catalog/package.json b/packages_generated/product_catalog/package.json index 7bd935a0b..6ffe3a1a8 100644 --- a/packages_generated/product_catalog/package.json +++ b/packages_generated/product_catalog/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK product-catalog", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/qaas/README.md b/packages_generated/qaas/README.md new file mode 100644 index 000000000..487c54c39 --- /dev/null +++ b/packages_generated/qaas/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-qaas + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-qaas.svg)](https://www.npmjs.com/package/@scaleway/sdk-qaas) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-qaas.svg)](https://www.npmjs.com/package/@scaleway/sdk-qaas) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-qaas.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Qaas 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-qaas @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-qaas @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-qaas @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 { Qaas } from '@scaleway/sdk-qaas' + +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 Qaas.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 { Qaas } from '@scaleway/sdk-qaas' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Qaas.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Qaas API Documentation](https://www.scaleway.com/en/developers/api/qaas/) +- 📖 [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. + diff --git a/packages_generated/qaas/package.json b/packages_generated/qaas/package.json index 144b3950b..220112b29 100644 --- a/packages_generated/qaas/package.json +++ b/packages_generated/qaas/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK qaas", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/rdb/README.md b/packages_generated/rdb/README.md new file mode 100644 index 000000000..6b54edde5 --- /dev/null +++ b/packages_generated/rdb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-rdb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-rdb.svg)](https://www.npmjs.com/package/@scaleway/sdk-rdb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-rdb.svg)](https://www.npmjs.com/package/@scaleway/sdk-rdb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-rdb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Rdb 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-rdb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-rdb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-rdb @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 { Rdb } from '@scaleway/sdk-rdb' + +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 Rdb.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 { Rdb } from '@scaleway/sdk-rdb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Rdb.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Rdb API Documentation](https://www.scaleway.com/en/developers/api/rdb/) +- 📖 [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. + diff --git a/packages_generated/rdb/package.json b/packages_generated/rdb/package.json index 7f8325b3a..2ffec0cc1 100644 --- a/packages_generated/rdb/package.json +++ b/packages_generated/rdb/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK rdb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/redis/README.md b/packages_generated/redis/README.md new file mode 100644 index 000000000..46e8b96b7 --- /dev/null +++ b/packages_generated/redis/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-redis + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-redis.svg)](https://www.npmjs.com/package/@scaleway/sdk-redis) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-redis.svg)](https://www.npmjs.com/package/@scaleway/sdk-redis) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-redis.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Redis 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-redis @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-redis @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-redis @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 { Redis } from '@scaleway/sdk-redis' + +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 Redis.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 { Redis } from '@scaleway/sdk-redis' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Redis.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Redis API Documentation](https://www.scaleway.com/en/developers/api/redis/) +- 📖 [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. + diff --git a/packages_generated/redis/package.json b/packages_generated/redis/package.json index 3b4b2b3ee..0cea9f7d6 100644 --- a/packages_generated/redis/package.json +++ b/packages_generated/redis/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK redis", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/registry/README.md b/packages_generated/registry/README.md new file mode 100644 index 000000000..a129f5342 --- /dev/null +++ b/packages_generated/registry/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-registry + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-registry.svg)](https://www.npmjs.com/package/@scaleway/sdk-registry) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-registry.svg)](https://www.npmjs.com/package/@scaleway/sdk-registry) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-registry.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Registry 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-registry @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-registry @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-registry @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 { Registry } from '@scaleway/sdk-registry' + +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 Registry.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 { Registry } from '@scaleway/sdk-registry' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Registry.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Registry API Documentation](https://www.scaleway.com/en/developers/api/registry/) +- 📖 [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. + diff --git a/packages_generated/registry/package.json b/packages_generated/registry/package.json index a8fd04894..15e79ca74 100644 --- a/packages_generated/registry/package.json +++ b/packages_generated/registry/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK registry", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/s2s_vpn/README.md b/packages_generated/s2s_vpn/README.md new file mode 100644 index 000000000..2c905c417 --- /dev/null +++ b/packages_generated/s2s_vpn/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-s2s-vpn + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-s2s-vpn.svg)](https://www.npmjs.com/package/@scaleway/sdk-s2s-vpn) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-s2s-vpn.svg)](https://www.npmjs.com/package/@scaleway/sdk-s2s-vpn) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-s2s-vpn.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for S2S Vpn 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-s2s-vpn @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-s2s-vpn @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-s2s-vpn @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 { S2SVpn } from '@scaleway/sdk-s2s-vpn' + +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 S2SVpn.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 { S2SVpn } from '@scaleway/sdk-s2s-vpn' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new S2SVpn.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway S2S Vpn API Documentation](https://www.scaleway.com/en/developers/api/s2s-vpn/) +- 📖 [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. + diff --git a/packages_generated/s2s_vpn/package.json b/packages_generated/s2s_vpn/package.json index e2e66455f..3716a004a 100644 --- a/packages_generated/s2s_vpn/package.json +++ b/packages_generated/s2s_vpn/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK s2s-vpn", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/secret/README.md b/packages_generated/secret/README.md new file mode 100644 index 000000000..49b63ef3c --- /dev/null +++ b/packages_generated/secret/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-secret + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-secret.svg)](https://www.npmjs.com/package/@scaleway/sdk-secret) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-secret.svg)](https://www.npmjs.com/package/@scaleway/sdk-secret) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-secret.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Secret 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-secret @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-secret @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-secret @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 { Secret } from '@scaleway/sdk-secret' + +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 Secret.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 { Secret } from '@scaleway/sdk-secret' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Secret.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Secret API Documentation](https://www.scaleway.com/en/developers/api/secret/) +- 📖 [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. + diff --git a/packages_generated/secret/package.json b/packages_generated/secret/package.json index b3a038131..51d153f05 100644 --- a/packages_generated/secret/package.json +++ b/packages_generated/secret/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK secret", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/serverless_sqldb/README.md b/packages_generated/serverless_sqldb/README.md new file mode 100644 index 000000000..4fa5e8d3d --- /dev/null +++ b/packages_generated/serverless_sqldb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-serverless-sqldb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-serverless-sqldb.svg)](https://www.npmjs.com/package/@scaleway/sdk-serverless-sqldb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-serverless-sqldb.svg)](https://www.npmjs.com/package/@scaleway/sdk-serverless-sqldb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-serverless-sqldb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Serverless Sqldb 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-serverless-sqldb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-serverless-sqldb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-serverless-sqldb @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 { ServerlessSqldb } from '@scaleway/sdk-serverless-sqldb' + +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 ServerlessSqldb.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 { ServerlessSqldb } from '@scaleway/sdk-serverless-sqldb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new ServerlessSqldb.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Serverless Sqldb API Documentation](https://www.scaleway.com/en/developers/api/serverless-sqldb/) +- 📖 [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. + diff --git a/packages_generated/serverless_sqldb/package.json b/packages_generated/serverless_sqldb/package.json index 961becf0d..85ca51529 100644 --- a/packages_generated/serverless_sqldb/package.json +++ b/packages_generated/serverless_sqldb/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK serverless-sqldb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/std/package.json b/packages_generated/std/package.json index 3ef76eaa2..55504c271 100644 --- a/packages_generated/std/package.json +++ b/packages_generated/std/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK Std", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/tem/README.md b/packages_generated/tem/README.md new file mode 100644 index 000000000..6a8913052 --- /dev/null +++ b/packages_generated/tem/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-tem + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-tem.svg)](https://www.npmjs.com/package/@scaleway/sdk-tem) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-tem.svg)](https://www.npmjs.com/package/@scaleway/sdk-tem) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-tem.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Tem 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-tem @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-tem @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-tem @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 { Tem } from '@scaleway/sdk-tem' + +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 Tem.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 { Tem } from '@scaleway/sdk-tem' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Tem.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Tem API Documentation](https://www.scaleway.com/en/developers/api/tem/) +- 📖 [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. + diff --git a/packages_generated/tem/package.json b/packages_generated/tem/package.json index a70709e2a..cbedddcd4 100644 --- a/packages_generated/tem/package.json +++ b/packages_generated/tem/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK tem", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/test/README.md b/packages_generated/test/README.md new file mode 100644 index 000000000..a67899e79 --- /dev/null +++ b/packages_generated/test/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-test + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-test.svg)](https://www.npmjs.com/package/@scaleway/sdk-test) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-test.svg)](https://www.npmjs.com/package/@scaleway/sdk-test) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-test.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Test 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-test @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-test @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-test @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 { Test } from '@scaleway/sdk-test' + +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 Test.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 { Test } from '@scaleway/sdk-test' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Test.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Test API Documentation](https://www.scaleway.com/en/developers/api/test/) +- 📖 [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. + diff --git a/packages_generated/test/package.json b/packages_generated/test/package.json index 17cf7fcba..c05c76236 100644 --- a/packages_generated/test/package.json +++ b/packages_generated/test/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK test", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/vpc/README.md b/packages_generated/vpc/README.md new file mode 100644 index 000000000..df2b00d8f --- /dev/null +++ b/packages_generated/vpc/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-vpc + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-vpc.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpc) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-vpc.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpc) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-vpc.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Vpc 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-vpc @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-vpc @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-vpc @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 { Vpc } from '@scaleway/sdk-vpc' + +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 Vpc.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 { Vpc } from '@scaleway/sdk-vpc' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Vpc.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Vpc API Documentation](https://www.scaleway.com/en/developers/api/vpc/) +- 📖 [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. + diff --git a/packages_generated/vpc/package.json b/packages_generated/vpc/package.json index a62189f56..a7f8de2f9 100644 --- a/packages_generated/vpc/package.json +++ b/packages_generated/vpc/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK vpc", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/vpcgw/README.md b/packages_generated/vpcgw/README.md new file mode 100644 index 000000000..d954ca54d --- /dev/null +++ b/packages_generated/vpcgw/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-vpcgw + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-vpcgw.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpcgw) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-vpcgw.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpcgw) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-vpcgw.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Vpcgw 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-vpcgw @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-vpcgw @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-vpcgw @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 { Vpcgw } from '@scaleway/sdk-vpcgw' + +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 Vpcgw.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 { Vpcgw } from '@scaleway/sdk-vpcgw' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Vpcgw.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Vpcgw API Documentation](https://www.scaleway.com/en/developers/api/vpcgw/) +- 📖 [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. + diff --git a/packages_generated/vpcgw/package.json b/packages_generated/vpcgw/package.json index dfa54d84f..ae2f3966b 100644 --- a/packages_generated/vpcgw/package.json +++ b/packages_generated/vpcgw/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK vpcgw", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/webhosting/README.md b/packages_generated/webhosting/README.md new file mode 100644 index 000000000..d264976a2 --- /dev/null +++ b/packages_generated/webhosting/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-webhosting + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-webhosting.svg)](https://www.npmjs.com/package/@scaleway/sdk-webhosting) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-webhosting.svg)](https://www.npmjs.com/package/@scaleway/sdk-webhosting) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-webhosting.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Webhosting 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-webhosting @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-webhosting @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-webhosting @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 { Webhosting } from '@scaleway/sdk-webhosting' + +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 Webhosting.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 { Webhosting } from '@scaleway/sdk-webhosting' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Webhosting.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Webhosting API Documentation](https://www.scaleway.com/en/developers/api/webhosting/) +- 📖 [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. + diff --git a/packages_generated/webhosting/package.json b/packages_generated/webhosting/package.json index c8e49d9fe..8654aba36 100644 --- a/packages_generated/webhosting/package.json +++ b/packages_generated/webhosting/package.json @@ -4,6 +4,7 @@ "description": "Scaleway SDK webhosting", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/scripts/generatePackages.ts b/scripts/generatePackages.ts index a71548317..4e2ea1df5 100644 --- a/scripts/generatePackages.ts +++ b/scripts/generatePackages.ts @@ -14,7 +14,9 @@ import type { ParseArgsConfig } from 'node:util' import { parseArgs } from 'node:util' import { SDKS } from './constants' import { + renderTemplate, renderTemplatePackageJson, + snakeToDisplayName, snakeToPascal, snakeToSlug, } from './helpers' @@ -24,6 +26,7 @@ import { * - package.json * - vite.config.ts * - tsconfig.json + * - README.md */ const TEMPLATES = { @@ -31,9 +34,11 @@ const TEMPLATES = { TS_CONFIG: join(cwd(), 'scripts/templates', 'tsconfig.json'), TS_CONFIG_BUILD: join(cwd(), 'scripts/templates', 'tsconfig.build.json'), VITE_CONFIG: join(cwd(), 'scripts/templates', 'vite.config.ts'), + README: join(cwd(), 'scripts/templates', 'README.tmpl'), } const templateString = readFileSync(TEMPLATES.PACKAGE_JSON, 'utf8') +const readmeTemplateString = readFileSync(TEMPLATES.README, 'utf8') // npx tsx scripts/generatePackages.ts ) --src="packages_generated" const options: ParseArgsConfig['options'] = { @@ -143,6 +148,21 @@ const main = () => { join(fullPath, 'tsconfig.build.json'), ) copyFileSync(TEMPLATES.VITE_CONFIG, join(fullPath, 'vite.config.ts')) + + // Generate README.md only if it doesn't exist + const readmeFilePath = join(fullPath, 'README.md') + access(readmeFilePath, constants.F_OK, err => { + if (err) { + const slugName = snakeToSlug(productDir) + const readme = renderTemplate(readmeTemplateString, { + name: slugName, + displayName: snakeToDisplayName(productDir), + pascalName: snakeToPascal(productDir), + }) + writeFileSync(readmeFilePath, readme) + console.log(`Generated README.md for ${productDir}`) + } + }) } } } diff --git a/scripts/helpers.ts b/scripts/helpers.ts index a12ee2a13..81a01ec62 100644 --- a/scripts/helpers.ts +++ b/scripts/helpers.ts @@ -23,6 +23,26 @@ export const unionTocamelCase = (str: string) => export const snakeToSlug = (str: string) => str.split('_').join('-') +export const snakeToDisplayName = (str: string) => + str + .split('_') + .map(s => handleAcronym(s.split('/').map(handleAcronym).join('/'))) + .join(' ') + +export const renderTemplate = ( + template: string, + params: Record, +): string => { + let result = template + for (const [key, value] of Object.entries(params)) { + const placeholder = `{{${key}}}` + const stringValue = + typeof value === 'object' ? JSON.stringify(value) : value.toString() + result = result.replace(new RegExp(placeholder, 'g'), stringValue) + } + return result +} + export const renderTemplatePackageJson = ( template: string, params: Record, diff --git a/scripts/templates/README.tmpl b/scripts/templates/README.tmpl new file mode 100644 index 000000000..54f716af1 --- /dev/null +++ b/scripts/templates/README.tmpl @@ -0,0 +1,95 @@ +# @scaleway/sdk-{{name}} + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-{{name}}.svg)](https://www.npmjs.com/package/@scaleway/sdk-{{name}}) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-{{name}}.svg)](https://www.npmjs.com/package/@scaleway/sdk-{{name}}) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-{{name}}.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for {{displayName}} 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-{{name}} @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-{{name}} @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-{{name}} @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 { {{pascalName}} } from '@scaleway/sdk-{{name}}' + +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 {{pascalName}}.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 { {{pascalName}} } from '@scaleway/sdk-{{name}}' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new {{pascalName}}.v1.API(client) +``` + +## Documentation + +- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway {{displayName}} API Documentation](https://www.scaleway.com/en/developers/api/{{name}}/) +- 📖 [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. diff --git a/scripts/templates/package.tmpl b/scripts/templates/package.tmpl index 3afb81db6..1927455dd 100644 --- a/scripts/templates/package.tmpl +++ b/scripts/templates/package.tmpl @@ -4,7 +4,8 @@ "description": "Scaleway SDK {{name}}", "license": "Apache-2.0", "files": [ - "dist" + "dist", + "README.md" ], "type": "module", "exports": {