Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions packages_generated/account/README.md
Original file line number Diff line number Diff line change
@@ -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.

1 change: 1 addition & 0 deletions packages_generated/account/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Scaleway SDK account",
"license": "Apache-2.0",
"files": [
"README.md",
"dist"
],
"type": "module",
Expand Down
96 changes: 96 additions & 0 deletions packages_generated/applesilicon/README.md
Original file line number Diff line number Diff line change
@@ -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.

1 change: 1 addition & 0 deletions packages_generated/applesilicon/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Scaleway SDK applesilicon",
"license": "Apache-2.0",
"files": [
"README.md",
"dist"
],
"type": "module",
Expand Down
96 changes: 96 additions & 0 deletions packages_generated/audit_trail/README.md
Original file line number Diff line number Diff line change
@@ -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.

1 change: 1 addition & 0 deletions packages_generated/audit_trail/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Scaleway SDK audit-trail",
"license": "Apache-2.0",
"files": [
"README.md",
"dist"
],
"type": "module",
Expand Down
Loading
Loading