@scaleway/sdk-instance 1.0.2

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

@@ -0,0 +1,244 @@
+import type { Zone as ScwZone } from '@scaleway/sdk-client';
+import type { Arch, BootType, Image, PlacementGroup, PrivateNIC, SecurityGroup, SecurityGroupPolicy, SecurityGroupRule, SecurityGroupRuleAction, SecurityGroupRuleDirection, SecurityGroupRuleProtocol, SecurityGroupSummary, Server, ServerAction, ServerIp, ServerIpv6, ServerLocation, ServerMaintenance, ServerState, ServerSummary, Snapshot, SnapshotBaseVolume, SnapshotState, Volume, VolumeVolumeType } from './types.gen';
+export interface SetImageResponse {
+    image?: Image;
+}
+export type SetSecurityGroupRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * UUID of the security group.
+     */
+    id: string;
+    /**
+     * Name of the security group.
+     */
+    name: string;
+    /**
+     * Tags of the security group.
+     */
+    tags?: string[];
+    /**
+     * Creation date of the security group (will be ignored).
+     */
+    creationDate?: Date;
+    /**
+     * Modification date of the security group (will be ignored).
+     */
+    modificationDate?: Date;
+    /**
+     * Description of the security group.
+     */
+    description: string;
+    /**
+     * True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
+     */
+    enableDefaultSecurity: boolean;
+    /**
+     * Default inbound policy.
+     */
+    inboundDefaultPolicy?: SecurityGroupPolicy;
+    /**
+     * Default outbound policy.
+     */
+    outboundDefaultPolicy?: SecurityGroupPolicy;
+    /**
+     * Security groups Organization ID.
+     */
+    organization?: string;
+    /**
+     * Security group Project ID.
+     */
+    project?: string;
+    /**
+     * @deprecated Please use project_default instead.
+     */
+    organizationDefault?: boolean;
+    /**
+     * True use this security group for future Instances created in this project.
+     */
+    projectDefault: boolean;
+    /**
+     * Instances attached to this security group.
+     */
+    servers?: ServerSummary[];
+    /**
+     * True to set the security group as stateful.
+     */
+    stateful: boolean;
+};
+export interface SetSecurityGroupResponse {
+    securityGroup?: SecurityGroup;
+}
+export type SetSecurityGroupRuleRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    securityGroupId: string;
+    securityGroupRuleId: string;
+    id: string;
+    protocol?: SecurityGroupRuleProtocol;
+    direction?: SecurityGroupRuleDirection;
+    action?: SecurityGroupRuleAction;
+    ipRange: string;
+    destPortFrom?: number;
+    destPortTo?: number;
+    position: number;
+    editable: boolean;
+};
+export interface SetSecurityGroupRuleResponse {
+    rule?: SecurityGroupRule;
+}
+export type SetServerRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    /**
+     * Instance unique ID.
+     */
+    id: string;
+    /**
+     * Instance name.
+     */
+    name: string;
+    /**
+     * Instance Organization ID.
+     */
+    organization?: string;
+    /**
+     * Instance Project ID.
+     */
+    project?: string;
+    /**
+     * Provide a list of allowed actions on the server.
+     */
+    allowedActions?: ServerAction[];
+    /**
+     * Tags associated with the Instance.
+     */
+    tags?: string[];
+    /**
+     * Instance commercial type (eg. GP1-M).
+     */
+    commercialType: string;
+    /**
+     * Instance creation date.
+     */
+    creationDate?: Date;
+    /**
+     * True if a dynamic IPv4 is required.
+     */
+    dynamicIpRequired: boolean;
+    /**
+     * @deprecated True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False).
+     */
+    routedIpEnabled?: boolean;
+    /**
+     * @deprecated True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`).
+     */
+    enableIpv6?: boolean;
+    /**
+     * Instance host name.
+     */
+    hostname: string;
+    /**
+     * Provide information on the Instance image.
+     */
+    image?: Image;
+    /**
+     * Instance protection option is activated.
+     */
+    protected: boolean;
+    /**
+     * @deprecated Instance private IP address (deprecated and always `null` when `routed_ip_enabled` is `True`).
+     */
+    privateIp?: string;
+    /**
+     * @deprecated Information about the public IP (deprecated in favor of `public_ips`).
+     */
+    publicIp?: ServerIp;
+    /**
+     * Information about all the public IPs attached to the server.
+     */
+    publicIps?: ServerIp[];
+    /**
+     * Instance modification date.
+     */
+    modificationDate?: Date;
+    /**
+     * Instance state.
+     */
+    state?: ServerState;
+    /**
+     * Instance location.
+     */
+    location?: ServerLocation;
+    /**
+     * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`).
+     */
+    ipv6?: ServerIpv6;
+    /**
+     * Instance boot type.
+     */
+    bootType?: BootType;
+    /**
+     * Instance volumes.
+     */
+    volumes?: Record<string, Volume>;
+    /**
+     * Instance security group.
+     */
+    securityGroup?: SecurityGroupSummary;
+    /**
+     * Instance planned maintenances.
+     */
+    maintenances?: ServerMaintenance[];
+    /**
+     * Instance state_detail.
+     */
+    stateDetail: string;
+    /**
+     * Instance architecture (refers to the CPU architecture used for the Instance, e.g. x86_64, arm64).
+     */
+    arch?: Arch;
+    /**
+     * Instance placement group.
+     */
+    placementGroup?: PlacementGroup;
+    /**
+     * Instance private NICs.
+     */
+    privateNics?: PrivateNIC[];
+    /**
+     * The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.
+     */
+    adminPasswordEncryptionSshKeyId?: string;
+};
+export interface SetServerResponse {
+    server?: Server;
+}
+export type SetSnapshotRequest = {
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
+    zone?: ScwZone;
+    snapshotId: string;
+    id: string;
+    name: string;
+    organization?: string;
+    volumeType?: VolumeVolumeType;
+    size: number;
+    state?: SnapshotState;
+    baseVolume?: SnapshotBaseVolume;
+    creationDate?: Date;
+    modificationDate?: Date;
+    project?: string;
+    tags?: string[];
+};
+export interface SetSnapshotResponse {
+    snapshot?: Snapshot;
+}

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

@@ -0,0 +1,35 @@
+import type { Zone } from '@scaleway/sdk-client';
+import type { Server } from './types.gen';
+export interface AttachVolumeRequest {
+    zone?: Zone;
+    serverId: string;
+    volumeId: string;
+}
+/** Contains the updated server after attaching a volume. */
+export interface AttachVolumeResponse {
+    server?: Server;
+}
+export interface DetachVolumeRequest {
+    zone?: Zone;
+    volumeId: string;
+}
+/** Contains the updated server after detaching a volume. */
+export interface DetachVolumeResponse {
+    server?: Server;
+}
+export interface GetServerUserDataRequest {
+    /** Zone to target. If none is passed will use default zone from the config */
+    zone?: Zone;
+    serverId: string;
+    /** The user data key to get */
+    key: string;
+}
+export interface SetServerUserDataRequest {
+    /** Zone to target. If none is passed will use default zone from the config */
+    zone?: Zone;
+    serverId: string;
+    /** The user data key to set */
+    key: string;
+    /** The data encoded in base64 */
+    content: string;
+}

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

@@ -0,0 +1,10 @@
+export declare const UpdateSecurityGroupRuleRequest: {
+    destPortFrom: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    destPortTo: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@scaleway/sdk-instance",
+  "version": "1.0.2",
+  "description": "Scaleway SDK instance",
+  "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/instance"
+  },
+  "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"
+  }
+}