@scaleway/sdk-annotations 1.0.1

package/README.md

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

@@ -0,0 +1,3 @@
+# Licenses
+
+The app does not bundle any dependencies with licenses.

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll };

package/dist/index.gen.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file is automatically generated
+ * PLEASE DO NOT EDIT HERE
+ */
+export * as Annotationsv1 from './v1/index.gen.js';

package/dist/index.gen.js

@@ -0,0 +1,2 @@
+import { index_gen_exports } from "./v1/index.gen.js";
+export { index_gen_exports as Annotationsv1 };

package/dist/metadata.gen.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file is automatically generated
+ * PLEASE DO NOT EDIT HERE
+ */
+export declare const pkgMetadata: {
+    readonly name: "@scaleway/sdk-annotations";
+    readonly namespace: "annotations";
+    readonly displayName: "Annotations";
+    readonly versions: readonly ["v1"];
+};
+export type Metadata = typeof pkgMetadata;
+export default pkgMetadata;

package/dist/metadata.gen.js

@@ -0,0 +1,13 @@
+//#region src/metadata.gen.ts
+/**
+* This file is automatically generated
+* PLEASE DO NOT EDIT HERE
+*/
+const pkgMetadata = {
+	name: "@scaleway/sdk-annotations",
+	namespace: "annotations",
+	displayName: "Annotations",
+	versions: ["v1"]
+};
+//#endregion
+export { pkgMetadata as default, pkgMetadata };

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

@@ -0,0 +1,135 @@
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { Binding, CreateBindingRequest, CreateKeyRequest, CreateValueRequest, DeleteAllBindingsMatchingSRNRequest, DeleteAllBindingsMatchingSRNResponse, DeleteAllBindingsMatchingValueRequest, DeleteAllBindingsMatchingValueResponse, DeleteAllValuesMatchingKeyRequest, DeleteAllValuesMatchingKeyResponse, DeleteBindingRequest, DeleteKeyRequest, DeleteValueRequest, GetKeyRequest, GetValueRequest, Key, ListAllKeysAndValuesRequest, ListAllKeysAndValuesResponse, ListBindingsRequest, ListBindingsResponse, ListKeysRequest, ListKeysResponse, ListValuesRequest, ListValuesResponse, UpdateKeyRequest, UpdateValueRequest, Value } from './types.gen.js';
+/**
+ * Annotations API.
+ */
+export declare class API extends ParentAPI {
+    /**
+     * Create an annotation key.. Create an annotation key.
+     *
+     * @param request - The request {@link CreateKeyRequest}
+     * @returns A Promise of Key
+     */
+    createKey: (request: Readonly<CreateKeyRequest>) => Promise<Key>;
+    protected pageOfListKeys: (request?: Readonly<ListKeysRequest>) => Promise<ListKeysResponse>;
+    /**
+     * List of keys.. List of keys.
+     *
+     * @param request - The request {@link ListKeysRequest}
+     * @returns A Promise of ListKeysResponse
+     */
+    listKeys: (request?: Readonly<ListKeysRequest>) => Promise<ListKeysResponse> & {
+        all: () => Promise<Key[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Key[], void, void>;
+    };
+    /**
+     * Retrieve a specific key.. Retrieve a specific key.
+     *
+     * @param request - The request {@link GetKeyRequest}
+     * @returns A Promise of Key
+     */
+    getKey: (request: Readonly<GetKeyRequest>) => Promise<Key>;
+    /**
+     * Update name or description. All associated resources will immediately display the new name.. Update name or description. All associated resources will immediately display the new name.
+     *
+     * @param request - The request {@link UpdateKeyRequest}
+     * @returns A Promise of Key
+     */
+    updateKey: (request: Readonly<UpdateKeyRequest>) => Promise<Key>;
+    /**
+     * Delete a key definition. Fails if the key has any associated values.. Delete a key definition. Fails if the key has any associated values.
+     *
+     * @param request - The request {@link DeleteKeyRequest}
+     */
+    deleteKey: (request: Readonly<DeleteKeyRequest>) => Promise<void>;
+    /**
+     * Add a value definition to a key.. Add a value definition to a key.
+     *
+     * @param request - The request {@link CreateValueRequest}
+     * @returns A Promise of Value
+     */
+    createValue: (request: Readonly<CreateValueRequest>) => Promise<Value>;
+    protected pageOfListValues: (request?: Readonly<ListValuesRequest>) => Promise<ListValuesResponse>;
+    /**
+     * List all values for a key, sorted alphabetically by name.. List all values for a key, sorted alphabetically by name.
+     *
+     * @param request - The request {@link ListValuesRequest}
+     * @returns A Promise of ListValuesResponse
+     */
+    listValues: (request?: Readonly<ListValuesRequest>) => Promise<ListValuesResponse> & {
+        all: () => Promise<Value[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Value[], void, void>;
+    };
+    /**
+     * Retrieve a specific value.. Retrieve a specific value.
+     *
+     * @param request - The request {@link GetValueRequest}
+     * @returns A Promise of Value
+     */
+    getValue: (request: Readonly<GetValueRequest>) => Promise<Value>;
+    /**
+     * Update name or description. Global update.. Update name or description. Global update.
+     *
+     * @param request - The request {@link UpdateValueRequest}
+     * @returns A Promise of Value
+     */
+    updateValue: (request: Readonly<UpdateValueRequest>) => Promise<Value>;
+    /**
+     * Delete a value definition. Fails if the value is currently bound to any resource.. Delete a value definition. Fails if the value is currently bound to any resource.
+     *
+     * @param request - The request {@link DeleteValueRequest}
+     */
+    deleteValue: (request: Readonly<DeleteValueRequest>) => Promise<void>;
+    /**
+     * Delete ALL values associated with a key. Fails if any of these values are currently bound to any resource.. Delete ALL values associated with a key. Fails if any of these values are currently bound to any resource.
+     *
+     * @param request - The request {@link DeleteAllValuesMatchingKeyRequest}
+     * @returns A Promise of DeleteAllValuesMatchingKeyResponse
+     */
+    deleteAllValuesMatchingKey: (request: Readonly<DeleteAllValuesMatchingKeyRequest>) => Promise<DeleteAllValuesMatchingKeyResponse>;
+    /**
+     * List all keys and values for an organization, sorted alphabetically by key name and value name.. List all keys and values for an organization, sorted alphabetically by key name and value name.
+     *
+     * @param request - The request {@link ListAllKeysAndValuesRequest}
+     * @returns A Promise of ListAllKeysAndValuesResponse
+     */
+    listAllKeysAndValues: (request?: Readonly<ListAllKeysAndValuesRequest>) => Promise<ListAllKeysAndValuesResponse>;
+    /**
+     * Attach a value to a resource. Fails if the resource already has a value for this key.. Attach a value to a resource. Fails if the resource already has a value for this key.
+     *
+     * @param request - The request {@link CreateBindingRequest}
+     * @returns A Promise of Binding
+     */
+    createBinding: (request: Readonly<CreateBindingRequest>) => Promise<Binding>;
+    protected pageOfListBindings: (request?: Readonly<ListBindingsRequest>) => Promise<ListBindingsResponse>;
+    /**
+     * List all bindings, or filter by Scaleway Resource Number or value ID. Response order by ID.. List all bindings, or filter by Scaleway Resource Number or value ID. Response order by ID.
+     *
+     * @param request - The request {@link ListBindingsRequest}
+     * @returns A Promise of ListBindingsResponse
+     */
+    listBindings: (request?: Readonly<ListBindingsRequest>) => Promise<ListBindingsResponse> & {
+        all: () => Promise<Binding[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Binding[], void, void>;
+    };
+    /**
+     * Detach an annotation from a resource.. Detach an annotation from a resource.
+     *
+     * @param request - The request {@link DeleteBindingRequest}
+     */
+    deleteBinding: (request: Readonly<DeleteBindingRequest>) => Promise<void>;
+    /**
+     * Delete ALL bindings associated with a value.. Delete ALL bindings associated with a value.
+     *
+     * @param request - The request {@link DeleteAllBindingsMatchingValueRequest}
+     * @returns A Promise of DeleteAllBindingsMatchingValueResponse
+     */
+    deleteAllBindingsMatchingValue: (request: Readonly<DeleteAllBindingsMatchingValueRequest>) => Promise<DeleteAllBindingsMatchingValueResponse>;
+    /**
+     * Delete ALL bindings associated with a Scaleway Resource Number.. Delete ALL bindings associated with a Scaleway Resource Number.
+     *
+     * @param request - The request {@link DeleteAllBindingsMatchingSRNRequest}
+     * @returns A Promise of DeleteAllBindingsMatchingSRNResponse
+     */
+    deleteAllBindingsMatchingSRN: (request: Readonly<DeleteAllBindingsMatchingSRNRequest>) => Promise<DeleteAllBindingsMatchingSRNResponse>;
+}

package/dist/v1/api.gen.js

@@ -0,0 +1,102 @@
+import { marshalCreateBindingRequest, marshalCreateKeyRequest, marshalCreateValueRequest, marshalUpdateKeyRequest, marshalUpdateValueRequest, unmarshalBinding, unmarshalDeleteAllBindingsMatchingSRNResponse, unmarshalDeleteAllBindingsMatchingValueResponse, unmarshalDeleteAllValuesMatchingKeyResponse, unmarshalKey, unmarshalListAllKeysAndValuesResponse, unmarshalListBindingsResponse, unmarshalListKeysResponse, unmarshalListValuesResponse, unmarshalValue } from "./marshalling.gen.js";
+import { API as API$1, enrichForPagination, urlParams, validatePathParam } from "@scaleway/sdk-client";
+//#region src/v1/api.gen.ts
+const jsonContentHeaders = { "Content-Type": "application/json; charset=utf-8" };
+/**
+* Annotations API.
+*/
+var API = class extends API$1 {
+	constructor(..._args) {
+		super(..._args);
+		this.createKey = (request) => this.client.fetch({
+			body: JSON.stringify(marshalCreateKeyRequest(request, this.client.settings)),
+			headers: jsonContentHeaders,
+			method: "POST",
+			path: `/annotations/v1/keys`
+		}, unmarshalKey);
+		this.pageOfListKeys = (request = {}) => this.client.fetch({
+			method: "GET",
+			path: `/annotations/v1/keys`,
+			urlParams: urlParams(["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId], ["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize])
+		}, unmarshalListKeysResponse);
+		this.listKeys = (request = {}) => enrichForPagination("keys", this.pageOfListKeys, request);
+		this.getKey = (request) => this.client.fetch({
+			method: "GET",
+			path: `/annotations/v1/keys/${validatePathParam("keyId", request.keyId)}`
+		}, unmarshalKey);
+		this.updateKey = (request) => this.client.fetch({
+			body: JSON.stringify(marshalUpdateKeyRequest(request, this.client.settings)),
+			headers: jsonContentHeaders,
+			method: "PATCH",
+			path: `/annotations/v1/keys/${validatePathParam("keyId", request.keyId)}`
+		}, unmarshalKey);
+		this.deleteKey = (request) => this.client.fetch({
+			method: "DELETE",
+			path: `/annotations/v1/keys/${validatePathParam("keyId", request.keyId)}`
+		});
+		this.createValue = (request) => this.client.fetch({
+			body: JSON.stringify(marshalCreateValueRequest(request, this.client.settings)),
+			headers: jsonContentHeaders,
+			method: "POST",
+			path: `/annotations/v1/values`
+		}, unmarshalValue);
+		this.pageOfListValues = (request = {}) => this.client.fetch({
+			method: "GET",
+			path: `/annotations/v1/values`,
+			urlParams: urlParams(["key_id", request.keyId], ["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId], ["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize])
+		}, unmarshalListValuesResponse);
+		this.listValues = (request = {}) => enrichForPagination("values", this.pageOfListValues, request);
+		this.getValue = (request) => this.client.fetch({
+			method: "GET",
+			path: `/annotations/v1/values/${validatePathParam("valueId", request.valueId)}`
+		}, unmarshalValue);
+		this.updateValue = (request) => this.client.fetch({
+			body: JSON.stringify(marshalUpdateValueRequest(request, this.client.settings)),
+			headers: jsonContentHeaders,
+			method: "PATCH",
+			path: `/annotations/v1/values/${validatePathParam("valueId", request.valueId)}`
+		}, unmarshalValue);
+		this.deleteValue = (request) => this.client.fetch({
+			method: "DELETE",
+			path: `/annotations/v1/values/${validatePathParam("valueId", request.valueId)}`
+		});
+		this.deleteAllValuesMatchingKey = (request) => this.client.fetch({
+			method: "DELETE",
+			path: `/annotations/v1/values/delete-all-matching-key`,
+			urlParams: urlParams(["key_id", request.keyId])
+		}, unmarshalDeleteAllValuesMatchingKeyResponse);
+		this.listAllKeysAndValues = (request = {}) => this.client.fetch({
+			method: "GET",
+			path: `/annotations/v1/all-keys-and-values`,
+			urlParams: urlParams(["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId])
+		}, unmarshalListAllKeysAndValuesResponse);
+		this.createBinding = (request) => this.client.fetch({
+			body: JSON.stringify(marshalCreateBindingRequest(request, this.client.settings)),
+			headers: jsonContentHeaders,
+			method: "POST",
+			path: `/annotations/v1/bindings`
+		}, unmarshalBinding);
+		this.pageOfListBindings = (request = {}) => this.client.fetch({
+			method: "GET",
+			path: `/annotations/v1/bindings`,
+			urlParams: urlParams(["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId], ["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize], ["srn", request.srn], ["value_id", request.valueId])
+		}, unmarshalListBindingsResponse);
+		this.listBindings = (request = {}) => enrichForPagination("bindings", this.pageOfListBindings, request);
+		this.deleteBinding = (request) => this.client.fetch({
+			method: "DELETE",
+			path: `/annotations/v1/bindings/${validatePathParam("bindingId", request.bindingId)}`
+		});
+		this.deleteAllBindingsMatchingValue = (request) => this.client.fetch({
+			method: "DELETE",
+			path: `/annotations/v1/bindings/delete-all-matching-value`,
+			urlParams: urlParams(["value_id", request.valueId])
+		}, unmarshalDeleteAllBindingsMatchingValueResponse);
+		this.deleteAllBindingsMatchingSRN = (request) => this.client.fetch({
+			method: "DELETE",
+			path: `/annotations/v1/bindings/delete-all-matching-srn`,
+			urlParams: urlParams(["organization_id", request.organizationId ?? this.client.settings.defaultOrganizationId], ["srn", request.srn])
+		}, unmarshalDeleteAllBindingsMatchingSRNResponse);
+	}
+};
+//#endregion
+export { API };

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

@@ -0,0 +1,4 @@
+export { API, } from './api.gen.js';
+export * from './marshalling.gen.js';
+export type { Binding, BindingKey, BindingValue, CreateBindingRequest, CreateKeyRequest, CreateValueRequest, DeleteAllBindingsMatchingSRNRequest, DeleteAllBindingsMatchingSRNResponse, DeleteAllBindingsMatchingValueRequest, DeleteAllBindingsMatchingValueResponse, DeleteAllValuesMatchingKeyRequest, DeleteAllValuesMatchingKeyResponse, DeleteBindingRequest, DeleteKeyRequest, DeleteValueRequest, GetKeyRequest, GetValueRequest, Key, ListAllKeysAndValuesRequest, ListAllKeysAndValuesResponse, ListAllKeysAndValuesResponseKey, ListAllKeysAndValuesResponseValue, ListBindingsRequest, ListBindingsResponse, ListKeysRequest, ListKeysResponse, ListValuesRequest, ListValuesResponse, UpdateKeyRequest, UpdateValueRequest, Value, } from './types.gen.js';
+export * as ValidationRules from './validation-rules.gen.js';

package/dist/v1/index.gen.js

@@ -0,0 +1,26 @@
+import { __exportAll } from "../_virtual/_rolldown/runtime.js";
+import { marshalCreateBindingRequest, marshalCreateKeyRequest, marshalCreateValueRequest, marshalUpdateKeyRequest, marshalUpdateValueRequest, unmarshalBinding, unmarshalDeleteAllBindingsMatchingSRNResponse, unmarshalDeleteAllBindingsMatchingValueResponse, unmarshalDeleteAllValuesMatchingKeyResponse, unmarshalKey, unmarshalListAllKeysAndValuesResponse, unmarshalListBindingsResponse, unmarshalListKeysResponse, unmarshalListValuesResponse, unmarshalValue } from "./marshalling.gen.js";
+import { API } from "./api.gen.js";
+import { validation_rules_gen_exports } from "./validation-rules.gen.js";
+//#region src/v1/index.gen.ts
+var index_gen_exports = /* @__PURE__ */ __exportAll({
+	API: () => API,
+	ValidationRules: () => validation_rules_gen_exports,
+	marshalCreateBindingRequest: () => marshalCreateBindingRequest,
+	marshalCreateKeyRequest: () => marshalCreateKeyRequest,
+	marshalCreateValueRequest: () => marshalCreateValueRequest,
+	marshalUpdateKeyRequest: () => marshalUpdateKeyRequest,
+	marshalUpdateValueRequest: () => marshalUpdateValueRequest,
+	unmarshalBinding: () => unmarshalBinding,
+	unmarshalDeleteAllBindingsMatchingSRNResponse: () => unmarshalDeleteAllBindingsMatchingSRNResponse,
+	unmarshalDeleteAllBindingsMatchingValueResponse: () => unmarshalDeleteAllBindingsMatchingValueResponse,
+	unmarshalDeleteAllValuesMatchingKeyResponse: () => unmarshalDeleteAllValuesMatchingKeyResponse,
+	unmarshalKey: () => unmarshalKey,
+	unmarshalListAllKeysAndValuesResponse: () => unmarshalListAllKeysAndValuesResponse,
+	unmarshalListBindingsResponse: () => unmarshalListBindingsResponse,
+	unmarshalListKeysResponse: () => unmarshalListKeysResponse,
+	unmarshalListValuesResponse: () => unmarshalListValuesResponse,
+	unmarshalValue: () => unmarshalValue
+});
+//#endregion
+export { API, validation_rules_gen_exports as ValidationRules, index_gen_exports, marshalCreateBindingRequest, marshalCreateKeyRequest, marshalCreateValueRequest, marshalUpdateKeyRequest, marshalUpdateValueRequest, unmarshalBinding, unmarshalDeleteAllBindingsMatchingSRNResponse, unmarshalDeleteAllBindingsMatchingValueResponse, unmarshalDeleteAllValuesMatchingKeyResponse, unmarshalKey, unmarshalListAllKeysAndValuesResponse, unmarshalListBindingsResponse, unmarshalListKeysResponse, unmarshalListValuesResponse, unmarshalValue };

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

@@ -0,0 +1,17 @@
+import type { DefaultValues } from '@scaleway/sdk-client';
+import type { Binding, Key, Value, DeleteAllBindingsMatchingSRNResponse, DeleteAllBindingsMatchingValueResponse, DeleteAllValuesMatchingKeyResponse, ListAllKeysAndValuesResponse, ListBindingsResponse, ListKeysResponse, ListValuesResponse, CreateBindingRequest, CreateKeyRequest, CreateValueRequest, UpdateKeyRequest, UpdateValueRequest } from './types.gen.js';
+export declare const unmarshalBinding: (data: unknown) => Binding;
+export declare const unmarshalKey: (data: unknown) => Key;
+export declare const unmarshalValue: (data: unknown) => Value;
+export declare const unmarshalDeleteAllBindingsMatchingSRNResponse: (data: unknown) => DeleteAllBindingsMatchingSRNResponse;
+export declare const unmarshalDeleteAllBindingsMatchingValueResponse: (data: unknown) => DeleteAllBindingsMatchingValueResponse;
+export declare const unmarshalDeleteAllValuesMatchingKeyResponse: (data: unknown) => DeleteAllValuesMatchingKeyResponse;
+export declare const unmarshalListAllKeysAndValuesResponse: (data: unknown) => ListAllKeysAndValuesResponse;
+export declare const unmarshalListBindingsResponse: (data: unknown) => ListBindingsResponse;
+export declare const unmarshalListKeysResponse: (data: unknown) => ListKeysResponse;
+export declare const unmarshalListValuesResponse: (data: unknown) => ListValuesResponse;
+export declare const marshalCreateBindingRequest: (request: CreateBindingRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalCreateKeyRequest: (request: CreateKeyRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalCreateValueRequest: (request: CreateValueRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateKeyRequest: (request: UpdateKeyRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateValueRequest: (request: UpdateValueRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/v1/marshalling.gen.js

@@ -0,0 +1,120 @@
+import { isJSONObject, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+//#region src/v1/marshalling.gen.ts
+const unmarshalBindingKey = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'BindingKey' failed as data isn't a dictionary.`);
+	return {
+		id: data.id,
+		name: data.name
+	};
+};
+const unmarshalBindingValue = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'BindingValue' failed as data isn't a dictionary.`);
+	return {
+		id: data.id,
+		name: data.name
+	};
+};
+const unmarshalBinding = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Binding' failed as data isn't a dictionary.`);
+	return {
+		id: data.id,
+		key: data.key ? unmarshalBindingKey(data.key) : void 0,
+		srn: data.srn,
+		value: data.value ? unmarshalBindingValue(data.value) : void 0
+	};
+};
+const unmarshalKey = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Key' failed as data isn't a dictionary.`);
+	return {
+		description: data.description,
+		id: data.id,
+		name: data.name
+	};
+};
+const unmarshalValue = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Value' failed as data isn't a dictionary.`);
+	return {
+		description: data.description,
+		id: data.id,
+		keyId: data.key_id,
+		name: data.name
+	};
+};
+const unmarshalDeleteAllBindingsMatchingSRNResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'DeleteAllBindingsMatchingSRNResponse' failed as data isn't a dictionary.`);
+	return { totalDeleted: data.total_deleted };
+};
+const unmarshalDeleteAllBindingsMatchingValueResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'DeleteAllBindingsMatchingValueResponse' failed as data isn't a dictionary.`);
+	return { totalDeleted: data.total_deleted };
+};
+const unmarshalDeleteAllValuesMatchingKeyResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'DeleteAllValuesMatchingKeyResponse' failed as data isn't a dictionary.`);
+	return { totalDeleted: data.total_deleted };
+};
+const unmarshalListAllKeysAndValuesResponseValue = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListAllKeysAndValuesResponseValue' failed as data isn't a dictionary.`);
+	return {
+		description: data.description,
+		id: data.id,
+		name: data.name
+	};
+};
+const unmarshalListAllKeysAndValuesResponseKey = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListAllKeysAndValuesResponseKey' failed as data isn't a dictionary.`);
+	return {
+		description: data.description,
+		id: data.id,
+		name: data.name,
+		values: unmarshalArrayOfObject(data.values, unmarshalListAllKeysAndValuesResponseValue)
+	};
+};
+const unmarshalListAllKeysAndValuesResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListAllKeysAndValuesResponse' failed as data isn't a dictionary.`);
+	return { keys: unmarshalArrayOfObject(data.keys, unmarshalListAllKeysAndValuesResponseKey) };
+};
+const unmarshalListBindingsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListBindingsResponse' failed as data isn't a dictionary.`);
+	return {
+		bindings: unmarshalArrayOfObject(data.bindings, unmarshalBinding),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListKeysResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListKeysResponse' failed as data isn't a dictionary.`);
+	return {
+		keys: unmarshalArrayOfObject(data.keys, unmarshalKey),
+		totalCount: data.total_count
+	};
+};
+const unmarshalListValuesResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListValuesResponse' failed as data isn't a dictionary.`);
+	return {
+		totalCount: data.total_count,
+		values: unmarshalArrayOfObject(data.values, unmarshalValue)
+	};
+};
+const marshalCreateBindingRequest = (request, defaults) => ({
+	srn: request.srn,
+	value_id: request.valueId
+});
+const marshalCreateKeyRequest = (request, defaults) => ({
+	description: request.description,
+	name: request.name,
+	organization_id: request.organizationId ?? defaults.defaultOrganizationId
+});
+const marshalCreateValueRequest = (request, defaults) => ({
+	description: request.description,
+	key_id: request.keyId,
+	name: request.name
+});
+const marshalUpdateKeyRequest = (request, defaults) => ({
+	description: request.description,
+	name: request.name
+});
+const marshalUpdateValueRequest = (request, defaults) => ({
+	description: request.description,
+	name: request.name
+});
+//#endregion
+export { marshalCreateBindingRequest, marshalCreateKeyRequest, marshalCreateValueRequest, marshalUpdateKeyRequest, marshalUpdateValueRequest, unmarshalBinding, unmarshalDeleteAllBindingsMatchingSRNResponse, unmarshalDeleteAllBindingsMatchingValueResponse, unmarshalDeleteAllValuesMatchingKeyResponse, unmarshalKey, unmarshalListAllKeysAndValuesResponse, unmarshalListBindingsResponse, unmarshalListKeysResponse, unmarshalListValuesResponse, unmarshalValue };

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

@@ -0,0 +1,70 @@
+export declare const queriesMetadata: {
+    readonly namespace: 'annotations';
+    readonly version: 'v1';
+    readonly folderName: 'annotationsv1';
+    readonly services: readonly [{
+        readonly apiClass: 'API';
+        readonly methods: readonly [{
+            readonly methodName: 'listKeys';
+            readonly protoName: 'ListKeys';
+            readonly paramsType: 'ListKeysRequest';
+            readonly returnType: 'ListKeysResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Key';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getKey';
+            readonly protoName: 'GetKey';
+            readonly paramsType: 'GetKeyRequest';
+            readonly returnType: 'Key';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listValues';
+            readonly protoName: 'ListValues';
+            readonly paramsType: 'ListValuesRequest';
+            readonly returnType: 'ListValuesResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Value';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'getValue';
+            readonly protoName: 'GetValue';
+            readonly paramsType: 'GetValueRequest';
+            readonly returnType: 'Value';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listAllKeysAndValues';
+            readonly protoName: 'ListAllKeysAndValues';
+            readonly paramsType: 'ListAllKeysAndValuesRequest';
+            readonly returnType: 'ListAllKeysAndValuesResponse';
+            readonly isList: false;
+            readonly paginationType: 'none';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }, {
+            readonly methodName: 'listBindings';
+            readonly protoName: 'ListBindings';
+            readonly paramsType: 'ListBindingsRequest';
+            readonly returnType: 'ListBindingsResponse';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Binding';
+            readonly isPrivate: false;
+            readonly description: '"';
+        }];
+    }];
+};
+export type QueriesMetadata = typeof queriesMetadata;

package/dist/v1/metadata.gen.js

@@ -0,0 +1,79 @@
+//#region src/v1/metadata.gen.ts
+const queriesMetadata = {
+	namespace: "annotations",
+	version: "v1",
+	folderName: "annotationsv1",
+	services: [{
+		apiClass: "API",
+		methods: [
+			{
+				methodName: "listKeys",
+				protoName: "ListKeys",
+				paramsType: "ListKeysRequest",
+				returnType: "ListKeysResponse",
+				isList: true,
+				paginationType: "offset",
+				pageParamKey: "page",
+				listItemType: "Key",
+				isPrivate: false,
+				description: "\""
+			},
+			{
+				methodName: "getKey",
+				protoName: "GetKey",
+				paramsType: "GetKeyRequest",
+				returnType: "Key",
+				isList: false,
+				paginationType: "none",
+				isPrivate: false,
+				description: "\""
+			},
+			{
+				methodName: "listValues",
+				protoName: "ListValues",
+				paramsType: "ListValuesRequest",
+				returnType: "ListValuesResponse",
+				isList: true,
+				paginationType: "offset",
+				pageParamKey: "page",
+				listItemType: "Value",
+				isPrivate: false,
+				description: "\""
+			},
+			{
+				methodName: "getValue",
+				protoName: "GetValue",
+				paramsType: "GetValueRequest",
+				returnType: "Value",
+				isList: false,
+				paginationType: "none",
+				isPrivate: false,
+				description: "\""
+			},
+			{
+				methodName: "listAllKeysAndValues",
+				protoName: "ListAllKeysAndValues",
+				paramsType: "ListAllKeysAndValuesRequest",
+				returnType: "ListAllKeysAndValuesResponse",
+				isList: false,
+				paginationType: "none",
+				isPrivate: false,
+				description: "\""
+			},
+			{
+				methodName: "listBindings",
+				protoName: "ListBindings",
+				paramsType: "ListBindingsRequest",
+				returnType: "ListBindingsResponse",
+				isList: true,
+				paginationType: "offset",
+				pageParamKey: "page",
+				listItemType: "Binding",
+				isPrivate: false,
+				description: "\""
+			}
+		]
+	}]
+};
+//#endregion
+export { queriesMetadata };

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

@@ -0,0 +1,334 @@
+export interface ListAllKeysAndValuesResponseValue {
+    /**
+     * ID of the value.
+     */
+    id: string;
+    /**
+     * Name of the value.
+     */
+    name: string;
+    /**
+     * Description of the value.
+     */
+    description: string;
+}
+export interface BindingKey {
+    /**
+     * ID of the key.
+     */
+    id: string;
+    /**
+     * Name of the key.
+     */
+    name: string;
+}
+export interface BindingValue {
+    /**
+     * ID of the value.
+     */
+    id: string;
+    /**
+     * Name of the value.
+     */
+    name: string;
+}
+export interface ListAllKeysAndValuesResponseKey {
+    /**
+     * ID of the key.
+     */
+    id: string;
+    /**
+     * Name of the key.
+     */
+    name: string;
+    /**
+     * Description of the key.
+     */
+    description: string;
+    /**
+     * List of values associated with the key, sorted alphabetically by name.
+     */
+    values: ListAllKeysAndValuesResponseValue[];
+}
+export interface Binding {
+    /**
+     * ID of the binding.
+     */
+    id: string;
+    /**
+     * Scaleway Resource Number associated to the binding.
+     */
+    srn: string;
+    /**
+     * Key associated to the binding.
+     */
+    key?: BindingKey;
+    /**
+     * Value associated to the binding.
+     */
+    value?: BindingValue;
+}
+export interface Key {
+    /**
+     * ID of the annotation key.
+     */
+    id: string;
+    /**
+     * Name of the annotation key.
+     */
+    name: string;
+    /**
+     * Description of the annotation key.
+     */
+    description: string;
+}
+export interface Value {
+    /**
+     * ID of the value.
+     */
+    id: string;
+    /**
+     * ID of the key the value is associated to.
+     */
+    keyId: string;
+    /**
+     * Name of the value (e.g. "production" for a key "environment").
+     */
+    name: string;
+    /**
+     * Description of the value.
+     */
+    description: string;
+}
+export type CreateBindingRequest = {
+    /**
+     * Scaleway Resource Number to associate.
+     */
+    srn: string;
+    /**
+     * ID of the value to associate.
+     */
+    valueId: string;
+};
+export type CreateKeyRequest = {
+    /**
+     * ID of the organization.
+     */
+    organizationId?: string;
+    /**
+     * Name of the annotation key.
+     */
+    name: string;
+    /**
+     * Description of the annotation key.
+     */
+    description: string;
+};
+export type CreateValueRequest = {
+    /**
+     * ID of the key the value will be bound to.
+     */
+    keyId: string;
+    /**
+     * Name of the value.
+     */
+    name: string;
+    /**
+     * Description of the value.
+     */
+    description: string;
+};
+export type DeleteAllBindingsMatchingSRNRequest = {
+    /**
+     * Scaleway Resource Number for which all bindings should be deleted.
+     */
+    srn: string;
+    /**
+     * ID of the organization.
+     */
+    organizationId?: string;
+};
+export interface DeleteAllBindingsMatchingSRNResponse {
+    /**
+     * Total number of bindings deleted.
+     */
+    totalDeleted: number;
+}
+export type DeleteAllBindingsMatchingValueRequest = {
+    /**
+     * ID of the value for which all bindings should be deleted.
+     */
+    valueId: string;
+};
+export interface DeleteAllBindingsMatchingValueResponse {
+    /**
+     * Total number of bindings deleted.
+     */
+    totalDeleted: number;
+}
+export type DeleteAllValuesMatchingKeyRequest = {
+    /**
+     * ID of the key for which to delete all values.
+     */
+    keyId: string;
+};
+export interface DeleteAllValuesMatchingKeyResponse {
+    /**
+     * Total number of bindings deleted.
+     */
+    totalDeleted: number;
+}
+export type DeleteBindingRequest = {
+    /**
+     * ID of the binding to delete.
+     */
+    bindingId: string;
+};
+export type DeleteKeyRequest = {
+    /**
+     * ID of the key to delete.
+     */
+    keyId: string;
+};
+export type DeleteValueRequest = {
+    /**
+     * ID of the value to delete.
+     */
+    valueId: string;
+};
+export type GetKeyRequest = {
+    /**
+     * ID of the key to retrieve.
+     */
+    keyId: string;
+};
+export type GetValueRequest = {
+    /**
+     * ID of the value to retrieve.
+     */
+    valueId: string;
+};
+export type ListAllKeysAndValuesRequest = {
+    /**
+     * ID of the organization.
+     */
+    organizationId?: string;
+};
+export interface ListAllKeysAndValuesResponse {
+    /**
+     * List of keys with values for an organization, sorted alphabetically by name.
+     */
+    keys: ListAllKeysAndValuesResponseKey[];
+}
+export type ListBindingsRequest = {
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Maximum number of bindings on the page.
+     */
+    pageSize?: number;
+    /**
+     * ID of the organization.
+     */
+    organizationId?: string;
+    /**
+     * Scaleway Resource Number for which to list all bindings.
+     */
+    srn?: string;
+    /**
+     * Value ID for which to list all bindings.
+     */
+    valueId?: string;
+};
+export interface ListBindingsResponse {
+    /**
+     * List of bindings for the organization. Response order by ID.
+     */
+    bindings: Binding[];
+    /**
+     * Total number of bindings returned.
+     */
+    totalCount: number;
+}
+export type ListKeysRequest = {
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Maximum number of keys on the page.
+     */
+    pageSize?: number;
+    /**
+     * ID of the organization.
+     */
+    organizationId?: string;
+};
+export interface ListKeysResponse {
+    /**
+     * List of keys for an organization, sorted alphabetically by name.
+     */
+    keys: Key[];
+    /**
+     * Total number of keys returned.
+     */
+    totalCount: number;
+}
+export type ListValuesRequest = {
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Maximum number of values on the page.
+     */
+    pageSize?: number;
+    /**
+     * ID of the organization.
+     */
+    organizationId?: string;
+    /**
+     * ID of the key to list the values for.
+     */
+    keyId?: string;
+};
+export interface ListValuesResponse {
+    /**
+     * List of values for a key, sorted alphabetically by name.
+     */
+    values: Value[];
+    /**
+     * Total number of values returned.
+     */
+    totalCount: number;
+}
+export type UpdateKeyRequest = {
+    /**
+     * ID of the key to update.
+     */
+    keyId: string;
+    /**
+     * New name of the key.
+     */
+    name?: string;
+    /**
+     * New description of the key.
+     */
+    description?: string;
+};
+export type UpdateValueRequest = {
+    /**
+     * ID of the value to update.
+     */
+    valueId: string;
+    /**
+     * New name of the value.
+     */
+    name?: string;
+    /**
+     * New description of the value.
+     */
+    description?: string;
+};

package/dist/v1/validation-rules.gen.d.ts

@@ -0,0 +1,67 @@
+export declare const CreateKeyRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};
+export declare const CreateValueRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};
+export declare const ListBindingsRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListKeysRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListValuesRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const UpdateKeyRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};
+export declare const UpdateValueRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};

package/dist/v1/validation-rules.gen.js

@@ -0,0 +1,66 @@
+import { __exportAll } from "../_virtual/_rolldown/runtime.js";
+//#region src/v1/validation-rules.gen.ts
+var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({
+	CreateKeyRequest: () => CreateKeyRequest,
+	CreateValueRequest: () => CreateValueRequest,
+	ListBindingsRequest: () => ListBindingsRequest,
+	ListKeysRequest: () => ListKeysRequest,
+	ListValuesRequest: () => ListValuesRequest,
+	UpdateKeyRequest: () => UpdateKeyRequest,
+	UpdateValueRequest: () => UpdateValueRequest
+});
+const CreateKeyRequest = {
+	description: { maxLength: 1024 },
+	name: {
+		maxLength: 128,
+		minLength: 1,
+		pattern: /^[_\pL][_\pL0-9]*$/
+	}
+};
+const CreateValueRequest = {
+	description: { maxLength: 1024 },
+	name: {
+		maxLength: 256,
+		minLength: 1,
+		pattern: /^[_\pL][_\pL0-9]*$/
+	}
+};
+const ListBindingsRequest = {
+	page: { greaterThanOrEqual: 1 },
+	pageSize: {
+		greaterThanOrEqual: 1,
+		lessThanOrEqual: 1e3
+	}
+};
+const ListKeysRequest = {
+	page: { greaterThanOrEqual: 1 },
+	pageSize: {
+		greaterThanOrEqual: 1,
+		lessThanOrEqual: 1e3
+	}
+};
+const ListValuesRequest = {
+	page: { greaterThanOrEqual: 1 },
+	pageSize: {
+		greaterThanOrEqual: 1,
+		lessThanOrEqual: 1e3
+	}
+};
+const UpdateKeyRequest = {
+	description: { maxLength: 1024 },
+	name: {
+		maxLength: 128,
+		minLength: 1,
+		pattern: /^[_\pL][_\pL0-9]*$/
+	}
+};
+const UpdateValueRequest = {
+	description: { maxLength: 1024 },
+	name: {
+		maxLength: 256,
+		minLength: 1,
+		pattern: /^[_\pL][_\pL0-9]*$/
+	}
+};
+//#endregion
+export { CreateKeyRequest, CreateValueRequest, ListBindingsRequest, ListKeysRequest, ListValuesRequest, UpdateKeyRequest, UpdateValueRequest, validation_rules_gen_exports };

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@scaleway/sdk-annotations",
+  "version": "1.0.1",
+  "description": "Scaleway SDK annotations",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "directory": "packages_generated/annotations"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.gen.d.ts",
+      "default": "./dist/index.gen.js"
+    },
+    "./*": {
+      "types": "./dist/*/index.gen.d.ts",
+      "default": "./dist/*/index.gen.js"
+    },
+    "./metadata": {
+      "types": "./dist/metadata.gen.d.ts",
+      "default": "./dist/metadata.gen.js"
+    },
+    "./*/metadata": {
+      "types": "./dist/*/metadata.gen.d.ts",
+      "default": "./dist/*/metadata.gen.js"
+    }
+  },
+  "dependencies": {
+    "@scaleway/random-name": "5.1.4",
+    "@scaleway/sdk-std": "2.4.3"
+  },
+  "devDependencies": {
+    "@scaleway/sdk-client": "^2.4.1"
+  },
+  "peerDependencies": {
+    "@scaleway/sdk-client": "^2.4.1"
+  },
+  "engines": {
+    "node": ">=20.18.3"
+  },
+  "scripts": {
+    "package:check": "pnpm publint",
+    "typecheck": "tsgo --noEmit",
+    "type:generate": "tsgo --declaration -p tsconfig.build.json",
+    "build": "vite build --config vite.config.ts && pnpm run type:generate",
+    "build:profile": "npx vite-bundle-visualizer -c vite.config.ts"
+  }
+}