@scaleway/sdk-flexibleip 1.0.1

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

@@ -0,0 +1,304 @@
+import type { Zone as ScwZone } from '@scaleway/sdk-client';
+export type FlexibleIPStatus = 'unknown' | 'ready' | 'updating' | 'attached' | 'error' | 'detaching' | 'locked';
+export type ListFlexibleIPsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type MACAddressStatus = 'unknown' | 'ready' | 'updating' | 'used' | 'error' | 'deleting';
+export type MACAddressType = 'unknown_type' | 'vmware' | 'xen' | 'kvm';
+export interface MACAddress {
+    /**
+     * ID of the flexible IP.
+     */
+    id: string;
+    /**
+     * MAC address of the Virtual MAC.
+     */
+    macAddress: string;
+    /**
+     * Type of virtual MAC.
+     */
+    macType: MACAddressType;
+    /**
+     * Status of virtual MAC.
+     */
+    status: MACAddressStatus;
+    /**
+     * Date on which the virtual MAC was last updated.
+     */
+    updatedAt?: Date;
+    /**
+     * Date on which the virtual MAC was created.
+     */
+    createdAt?: Date;
+    /**
+     * MAC address IP Availability Zone.
+     */
+    zone: ScwZone;
+}
+export interface FlexibleIP {
+    /**
+     * ID of the flexible IP.
+     */
+    id: string;
+    /**
+     * ID of the Organization the flexible IP is attached to.
+     */
+    organizationId: string;
+    /**
+     * ID of the Project the flexible IP is attached to.
+     */
+    projectId: string;
+    /**
+     * Flexible IP description.
+     */
+    description: string;
+    /**
+     * Flexible IP tags.
+     */
+    tags: string[];
+    /**
+     * Date on which the flexible IP was last updated.
+     */
+    updatedAt?: Date;
+    /**
+     * Date on which the flexible IP was created.
+     */
+    createdAt?: Date;
+    /**
+     * - ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
+  - updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
+  - attached: flexible IP is attached to a server
+  - error: a flexible IP operation resulted in an error
+  - detaching: flexible IP is being detached from a server
+  - locked: the resource of the flexible IP is locked.
+     */
+    status: FlexibleIPStatus;
+    /**
+     * IP of the flexible IP.
+     */
+    ipAddress: string;
+    /**
+     * MAC address of the flexible IP.
+     */
+    macAddress?: MACAddress;
+    /**
+     * ID of the server linked to the flexible IP.
+     */
+    serverId?: string;
+    /**
+     * Reverse DNS value.
+     */
+    reverse: string;
+    /**
+     * Availability Zone of the flexible IP.
+     */
+    zone: ScwZone;
+}
+export type AttachFlexibleIPRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * Multiple IDs can be provided, but note that flexible IPs must belong to the same MAC group (see details about MAC groups).
+     */
+    fipsIds: string[];
+    /**
+     * ID of the server on which to attach the flexible IPs.
+     */
+    serverId: string;
+};
+export interface AttachFlexibleIPsResponse {
+    /**
+     * Total count of flexible IPs that are being updated.
+     */
+    totalCount: number;
+    /**
+     * List of flexible IPs in an updating state.
+     */
+    flexibleIps: FlexibleIP[];
+}
+export type CreateFlexibleIPRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * ID of the project to associate with the Flexible IP.
+     */
+    projectId?: string;
+    /**
+     * Flexible IP description (max. of 255 characters).
+     */
+    description: string;
+    /**
+     * Tags to associate to the flexible IP.
+     */
+    tags?: string[];
+    /**
+     * ID of the server to which the newly created flexible IP will be attached.
+     */
+    serverId?: string;
+    /**
+     * Value of the reverse DNS.
+     */
+    reverse?: string;
+    /**
+     * Defines whether the flexible IP has an IPv6 address.
+     */
+    isIpv6: boolean;
+};
+export type DeleteFlexibleIPRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * ID of the flexible IP to delete.
+     */
+    fipId: string;
+};
+export type DeleteMACAddrRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * If the flexible IP belongs to a MAC group, the MAC will be removed from both the MAC group and flexible IP.
+     */
+    fipId: string;
+};
+export type DetachFlexibleIPRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group.
+     */
+    fipsIds: string[];
+};
+export interface DetachFlexibleIPsResponse {
+    /**
+     * Total count of flexible IPs that are being detached.
+     */
+    totalCount: number;
+    /**
+     * List of flexible IPs in a detaching state.
+     */
+    flexibleIps: FlexibleIP[];
+}
+export type DuplicateMACAddrRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * Note that the flexible IPs need to be attached to the same server.
+     */
+    fipId: string;
+    /**
+     * Note that flexible IPs need to be attached to the same server.
+     */
+    duplicateFromFipId: string;
+};
+export type GenerateMACAddrRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * ID of the flexible IP for which to generate a virtual MAC.
+     */
+    fipId: string;
+    /**
+     * TODO.
+     */
+    macType: MACAddressType;
+};
+export type GetFlexibleIPRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * ID of the flexible IP.
+     */
+    fipId: string;
+};
+export type ListFlexibleIPsRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * Sort order of the returned flexible IPs.
+     */
+    orderBy?: ListFlexibleIPsRequestOrderBy;
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Maximum number of flexible IPs per page.
+     */
+    pageSize?: number;
+    /**
+     * Filter by tag, only flexible IPs with one or more matching tags will be returned.
+     */
+    tags?: string[];
+    /**
+     * Filter by status, only flexible IPs with this status will be returned.
+     */
+    status?: FlexibleIPStatus[];
+    /**
+     * Filter by server IDs, only flexible IPs with these server IDs will be returned.
+     */
+    serverIds?: string[];
+    /**
+     * Filter by Organization ID, only flexible IPs from this Organization will be returned.
+     */
+    organizationId?: string;
+    /**
+     * Filter by Project ID, only flexible IPs from this Project will be returned.
+     */
+    projectId?: string;
+};
+export interface ListFlexibleIPsResponse {
+    /**
+     * Total count of matching flexible IPs.
+     */
+    totalCount: number;
+    /**
+     * List of all flexible IPs.
+     */
+    flexibleIps: FlexibleIP[];
+}
+export type MoveMACAddrRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    fipId: string;
+    dstFipId: string;
+};
+export type UpdateFlexibleIPRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * ID of the flexible IP to update.
+     */
+    fipId: string;
+    /**
+     * Flexible IP description (max. 255 characters).
+     */
+    description?: string;
+    /**
+     * Tags associated with the flexible IP.
+     */
+    tags?: string[];
+    /**
+     * Value of the reverse DNS.
+     */
+    reverse?: string;
+};

package/dist/v1alpha1/validation-rules.gen.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ListFlexibleIPsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+exports.ListFlexibleIPsRequest = ListFlexibleIPsRequest;

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

@@ -0,0 +1,9 @@
+export declare const ListFlexibleIPsRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThan: number;
+        lessThanOrEqual: number;
+    };
+};

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

@@ -0,0 +1,12 @@
+const ListFlexibleIPsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+export {
+  ListFlexibleIPsRequest
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@scaleway/sdk-flexibleip",
+  "version": "1.0.1",
+  "description": "Scaleway SDK flexibleip",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.gen.d.ts",
+      "import": "./dist/index.gen.js",
+      "require": "./dist/index.gen.cjs",
+      "default": "./dist/index.gen.js"
+    },
+    "./*": {
+      "types": "./dist/*/index.gen.d.ts",
+      "import": "./dist/*/index.gen.js",
+      "require": "./dist/*/index.gen.cjs",
+      "default": "./dist/*/index.gen.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "directory": "packages_generated/flexibleip"
+  },
+  "engines": {
+    "node": ">=20.18.3"
+  },
+  "dependencies": {
+    "@scaleway/random-name": "5.1.1",
+    "@scaleway/sdk-std": "1.0.1"
+  },
+  "peerDependencies": {
+    "@scaleway/sdk-client": "^1.2.1"
+  },
+  "devDependencies": {
+    "@scaleway/sdk-client": "^1.2.1"
+  },
+  "bundledDependencies": [
+    "@scaleway/random-name"
+  ],
+  "scripts": {
+    "package:check": "pnpm publint",
+    "typecheck": "tsc --noEmit",
+    "type:generate": "tsc --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"
+  }
+}