@scaleway/sdk-dedibox 1.3.0 → 2.1.1

package/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.
+

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

@@ -1,6 +1,6 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
-import type { AttachFailoverIPToMacAddressRequest, AttachFailoverIPsRequest, BMCAccess, Backup, BillingApiCanOrderRequest, BillingApiDownloadInvoiceRequest, BillingApiDownloadRefundRequest, BillingApiGetInvoiceRequest, BillingApiGetRefundRequest, BillingApiListInvoicesRequest, BillingApiListRefundsRequest, CanOrderResponse, CancelServerInstallRequest, CreateFailoverIPsRequest, CreateFailoverIPsResponse, CreateServerRequest, DeleteFailoverIPRequest, DeleteServerRequest, DeleteServiceRequest, DetachFailoverIPFromMacAddressRequest, DetachFailoverIPsRequest, FailoverIP, GetBMCAccessRequest, GetFailoverIPRequest, GetIPv6BlockQuotasResponse, GetOSRequest, GetOfferRequest, GetOrderedServiceRequest, GetRaidRequest, GetRemainingQuotaRequest, GetRemainingQuotaResponse, GetRescueRequest, GetRpnStatusResponse, GetServerBackupRequest, GetServerDefaultPartitioningRequest, GetServerInstallRequest, GetServerRequest, GetServiceRequest, IP, IPv6Block, IPv6BlockApiCreateIPv6BlockRequest, IPv6BlockApiCreateIPv6BlockSubnetRequest, IPv6BlockApiDeleteIPv6BlockRequest, IPv6BlockApiGetIPv6BlockQuotasRequest, IPv6BlockApiGetIPv6BlockRequest, IPv6BlockApiListIPv6BlockSubnetsAvailableRequest, IPv6BlockApiListIPv6BlocksRequest, IPv6BlockApiUpdateIPv6BlockRequest, InstallServerRequest, Invoice, ListFailoverIPsRequest, ListFailoverIPsResponse, ListIPv6BlockSubnetsAvailableResponse, ListIPv6BlocksResponse, ListInvoicesResponse, ListIpsResponse, ListOSRequest, ListOSResponse, ListOffersRequest, ListOffersResponse, ListRefundsResponse, ListRpnCapableSanServersResponse, ListRpnCapableServersResponse, ListRpnGroupMembersResponse, ListRpnGroupsResponse, ListRpnInvitesResponse, ListRpnSansResponse, ListRpnServerCapabilitiesResponse, ListRpnV2CapableResourcesResponse, ListRpnV2GroupLogsResponse, ListRpnV2GroupsResponse, ListRpnV2MembersResponse, ListServerDisksRequest, ListServerDisksResponse, ListServerEventsRequest, ListServerEventsResponse, ListServersRequest, ListServersResponse, ListServicesRequest, ListServicesResponse, ListSubscribableServerOptionsRequest, ListSubscribableServerOptionsResponse, OS, Offer, Raid, RebootServerRequest, Refund, Rescue, RpnApiGetRpnStatusRequest, RpnApiListRpnServerCapabilitiesRequest, RpnGroup, RpnSan, RpnSanApiAddIpRequest, RpnSanApiCreateRpnSanRequest, RpnSanApiDeleteRpnSanRequest, RpnSanApiGetRpnSanRequest, RpnSanApiListAvailableIpsRequest, RpnSanApiListIpsRequest, RpnSanApiListRpnSansRequest, RpnSanApiRemoveIpRequest, RpnV1ApiAcceptRpnInviteRequest, RpnV1ApiAddRpnGroupMembersRequest, RpnV1ApiCreateRpnGroupRequest, RpnV1ApiDeleteRpnGroupMembersRequest, RpnV1ApiDeleteRpnGroupRequest, RpnV1ApiGetRpnGroupRequest, RpnV1ApiLeaveRpnGroupRequest, RpnV1ApiListRpnCapableSanServersRequest, RpnV1ApiListRpnCapableServersRequest, RpnV1ApiListRpnGroupMembersRequest, RpnV1ApiListRpnGroupsRequest, RpnV1ApiListRpnInvitesRequest, RpnV1ApiRefuseRpnInviteRequest, RpnV1ApiRpnGroupInviteRequest, RpnV1ApiUpdateRpnGroupNameRequest, RpnV2ApiAddRpnV2MembersRequest, RpnV2ApiCreateRpnV2GroupRequest, RpnV2ApiDeleteRpnV2GroupRequest, RpnV2ApiDeleteRpnV2MembersRequest, RpnV2ApiDisableRpnV2GroupCompatibilityRequest, RpnV2ApiEnableRpnV2GroupCompatibilityRequest, RpnV2ApiGetRpnV2GroupRequest, RpnV2ApiListRpnV2CapableResourcesRequest, RpnV2ApiListRpnV2GroupLogsRequest, RpnV2ApiListRpnV2GroupsRequest, RpnV2ApiListRpnV2MembersRequest, RpnV2ApiUpdateRpnV2GroupNameRequest, RpnV2ApiUpdateRpnV2VlanForMembersRequest, RpnV2Group, Server, ServerDefaultPartitioning, ServerInstall, Service, StartBMCAccessRequest, StartRescueRequest, StartServerRequest, StopBMCAccessRequest, StopRescueRequest, StopServerRequest, SubscribeServerOptionRequest, SubscribeStorageOptionsRequest, SubscribeStorageOptionsResponse, UpdateRaidRequest, UpdateReverseRequest, UpdateServerBackupRequest, UpdateServerRequest, UpdateServerTagsRequest } from './types.gen.js';
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { AttachFailoverIPsRequest, AttachFailoverIPToMacAddressRequest, Backup, BillingApiCanOrderRequest, BillingApiDownloadInvoiceRequest, BillingApiDownloadRefundRequest, BillingApiGetInvoiceRequest, BillingApiGetRefundRequest, BillingApiListInvoicesRequest, BillingApiListRefundsRequest, BMCAccess, CancelServerInstallRequest, CanOrderResponse, CreateFailoverIPsRequest, CreateFailoverIPsResponse, CreateServerRequest, DeleteFailoverIPRequest, DeleteServerRequest, DeleteServiceRequest, DetachFailoverIPFromMacAddressRequest, DetachFailoverIPsRequest, FailoverIP, GetBMCAccessRequest, GetFailoverIPRequest, GetIPv6BlockQuotasResponse, GetOfferRequest, GetOrderedServiceRequest, GetOSRequest, GetRaidRequest, GetRemainingQuotaRequest, GetRemainingQuotaResponse, GetRescueRequest, GetRpnStatusResponse, GetServerBackupRequest, GetServerDefaultPartitioningRequest, GetServerInstallRequest, GetServerRequest, GetServiceRequest, InstallServerRequest, Invoice, IP, IPv6Block, IPv6BlockApiCreateIPv6BlockRequest, IPv6BlockApiCreateIPv6BlockSubnetRequest, IPv6BlockApiDeleteIPv6BlockRequest, IPv6BlockApiGetIPv6BlockQuotasRequest, IPv6BlockApiGetIPv6BlockRequest, IPv6BlockApiListIPv6BlockSubnetsAvailableRequest, IPv6BlockApiListIPv6BlocksRequest, IPv6BlockApiUpdateIPv6BlockRequest, ListFailoverIPsRequest, ListFailoverIPsResponse, ListInvoicesResponse, ListIPv6BlockSubnetsAvailableResponse, ListIPv6BlocksResponse, ListIpsResponse, ListOffersRequest, ListOffersResponse, ListOSRequest, ListOSResponse, ListRefundsResponse, ListRpnCapableSanServersResponse, ListRpnCapableServersResponse, ListRpnGroupMembersResponse, ListRpnGroupsResponse, ListRpnInvitesResponse, ListRpnSansResponse, ListRpnServerCapabilitiesResponse, ListRpnV2CapableResourcesResponse, ListRpnV2GroupLogsResponse, ListRpnV2GroupsResponse, ListRpnV2MembersResponse, ListServerDisksRequest, ListServerDisksResponse, ListServerEventsRequest, ListServerEventsResponse, ListServersRequest, ListServersResponse, ListServicesRequest, ListServicesResponse, ListSubscribableServerOptionsRequest, ListSubscribableServerOptionsResponse, Offer, OS, Raid, RebootServerRequest, Refund, Rescue, RpnApiGetRpnStatusRequest, RpnApiListRpnServerCapabilitiesRequest, RpnGroup, RpnSan, RpnSanApiAddIpRequest, RpnSanApiCreateRpnSanRequest, RpnSanApiDeleteRpnSanRequest, RpnSanApiGetRpnSanRequest, RpnSanApiListAvailableIpsRequest, RpnSanApiListIpsRequest, RpnSanApiListRpnSansRequest, RpnSanApiRemoveIpRequest, RpnV1ApiAcceptRpnInviteRequest, RpnV1ApiAddRpnGroupMembersRequest, RpnV1ApiCreateRpnGroupRequest, RpnV1ApiDeleteRpnGroupMembersRequest, RpnV1ApiDeleteRpnGroupRequest, RpnV1ApiGetRpnGroupRequest, RpnV1ApiLeaveRpnGroupRequest, RpnV1ApiListRpnCapableSanServersRequest, RpnV1ApiListRpnCapableServersRequest, RpnV1ApiListRpnGroupMembersRequest, RpnV1ApiListRpnGroupsRequest, RpnV1ApiListRpnInvitesRequest, RpnV1ApiRefuseRpnInviteRequest, RpnV1ApiRpnGroupInviteRequest, RpnV1ApiUpdateRpnGroupNameRequest, RpnV2ApiAddRpnV2MembersRequest, RpnV2ApiCreateRpnV2GroupRequest, RpnV2ApiDeleteRpnV2GroupRequest, RpnV2ApiDeleteRpnV2MembersRequest, RpnV2ApiDisableRpnV2GroupCompatibilityRequest, RpnV2ApiEnableRpnV2GroupCompatibilityRequest, RpnV2ApiGetRpnV2GroupRequest, RpnV2ApiListRpnV2CapableResourcesRequest, RpnV2ApiListRpnV2GroupLogsRequest, RpnV2ApiListRpnV2GroupsRequest, RpnV2ApiListRpnV2MembersRequest, RpnV2ApiUpdateRpnV2GroupNameRequest, RpnV2ApiUpdateRpnV2VlanForMembersRequest, RpnV2Group, Server, ServerDefaultPartitioning, ServerInstall, Service, StartBMCAccessRequest, StartRescueRequest, StartServerRequest, StopBMCAccessRequest, StopRescueRequest, StopServerRequest, SubscribeServerOptionRequest, SubscribeStorageOptionsRequest, SubscribeStorageOptionsResponse, UpdateRaidRequest, UpdateReverseRequest, UpdateServerBackupRequest, UpdateServerRequest, UpdateServerTagsRequest } from './types.gen.js';
 /**
  * Dedibox Phoenix API.
  */