@scaleway/sdk 2.26.0 → 2.27.0

package/dist/api/flexibleip/index.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const index_gen = require("./v1alpha1/index.gen.cjs");
+exports.v1alpha1 = index_gen;

package/dist/api/flexibleip/index.d.ts

@@ -0,0 +1 @@
+export * as v1alpha1 from './v1alpha1/index.gen';

package/dist/api/flexibleip/index.js

@@ -1,2 +1,4 @@
-import * as index_gen from './v1alpha1/index.gen.js';
-export { index_gen as v1alpha1 };
+import * as index_gen from "./v1alpha1/index.gen.js";
+export {
+  index_gen as v1alpha1
+};

package/dist/api/flexibleip/v1alpha1/api.gen.cjs

@@ -0,0 +1,227 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends api.API {
+  /** Lists the available zones of the API. */
+  static LOCALITIES = [
+    "fr-par-1",
+    "fr-par-2",
+    "nl-ams-1"
+  ];
+  /**
+   * Create a new flexible IP. Generate a new flexible IP within a given zone,
+   * specifying its configuration including Project ID and description.
+   *
+   * @param request - The request {@link CreateFlexibleIPRequest}
+   * @returns A Promise of FlexibleIP
+   */
+  createFlexibleIP = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateFlexibleIPRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips`
+    },
+    marshalling_gen.unmarshalFlexibleIP
+  );
+  /**
+   * Get an existing flexible IP. Retrieve information about an existing
+   * flexible IP, specified by its ID and zone. Its full details, including
+   * Project ID, description and status, are returned in the response object.
+   *
+   * @param request - The request {@link GetFlexibleIPRequest}
+   * @returns A Promise of FlexibleIP
+   */
+  getFlexibleIP = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}`
+    },
+    marshalling_gen.unmarshalFlexibleIP
+  );
+  /**
+   * Waits for {@link FlexibleIP} to be in a final state.
+   *
+   * @param request - The request {@link GetFlexibleIPRequest}
+   * @param options - The waiting options
+   * @returns A Promise of FlexibleIP
+   */
+  waitForFlexibleIP = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(
+      !content_gen.FLEXIBLE_IP_TRANSIENT_STATUSES.includes(res.status)
+    )),
+    this.getFlexibleIP,
+    request,
+    options
+  );
+  pageOfListFlexibleIPs = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips`,
+      urlParams: marshalling.urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId],
+        ["server_ids", request.serverIds],
+        ["status", request.status],
+        ["tags", request.tags]
+      )
+    },
+    marshalling_gen.unmarshalListFlexibleIPsResponse
+  );
+  /**
+   * List flexible IPs. List all flexible IPs within a given zone.
+   *
+   * @param request - The request {@link ListFlexibleIPsRequest}
+   * @returns A Promise of ListFlexibleIPsResponse
+   */
+  listFlexibleIPs = (request = {}) => resourcePaginator.enrichForPagination("flexibleIps", this.pageOfListFlexibleIPs, request);
+  /**
+   * Update an existing flexible IP. Update the parameters of an existing
+   * flexible IP, specified by its ID and zone. These parameters include tags
+   * and description.
+   *
+   * @param request - The request {@link UpdateFlexibleIPRequest}
+   * @returns A Promise of FlexibleIP
+   */
+  updateFlexibleIP = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateFlexibleIPRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}`
+    },
+    marshalling_gen.unmarshalFlexibleIP
+  );
+  /**
+   * Delete an existing flexible IP. Delete an existing flexible IP, specified
+   * by its ID and zone. Note that deleting a flexible IP is permanent and
+   * cannot be undone.
+   *
+   * @param request - The request {@link DeleteFlexibleIPRequest}
+   */
+  deleteFlexibleIP = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}`
+  });
+  /**
+   * Attach an existing flexible IP to a server. Attach an existing flexible IP
+   * to a specified Elastic Metal server.
+   *
+   * @param request - The request {@link AttachFlexibleIPRequest}
+   * @returns A Promise of AttachFlexibleIPsResponse
+   */
+  attachFlexibleIP = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalAttachFlexibleIPRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/attach`
+    },
+    marshalling_gen.unmarshalAttachFlexibleIPsResponse
+  );
+  /**
+   * Detach an existing flexible IP from a server. Detach an existing flexible
+   * IP from a specified Elastic Metal server.
+   *
+   * @param request - The request {@link DetachFlexibleIPRequest}
+   * @returns A Promise of DetachFlexibleIPsResponse
+   */
+  detachFlexibleIP = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalDetachFlexibleIPRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/detach`
+    },
+    marshalling_gen.unmarshalDetachFlexibleIPsResponse
+  );
+  /**
+   * Generate a virtual MAC address on an existing flexible IP. Generate a
+   * virtual MAC (Media Access Control) address on an existing flexible IP.
+   *
+   * @param request - The request {@link GenerateMACAddrRequest}
+   * @returns A Promise of FlexibleIP
+   */
+  generateMACAddr = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalGenerateMACAddrRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}/mac`
+    },
+    marshalling_gen.unmarshalFlexibleIP
+  );
+  /**
+   * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
+   * MAC address from a given flexible IP to another flexible IP attached to the
+   * same server.
+   *
+   * @param request - The request {@link DuplicateMACAddrRequest}
+   * @returns A Promise of FlexibleIP
+   */
+  duplicateMACAddr = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalDuplicateMACAddrRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}/mac/duplicate`
+    },
+    marshalling_gen.unmarshalFlexibleIP
+  );
+  /**
+   * Relocate an existing virtual MAC address to a different flexible IP.
+   * Relocate a virtual MAC (Media Access Control) address from an existing
+   * flexible IP to a different flexible IP.
+   *
+   * @param request - The request {@link MoveMACAddrRequest}
+   * @returns A Promise of FlexibleIP
+   */
+  moveMACAddr = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalMoveMACAddrRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}/mac/move`
+    },
+    marshalling_gen.unmarshalFlexibleIP
+  );
+  /**
+   * Detach a given virtual MAC address from an existing flexible IP. Detach a
+   * given MAC (Media Access Control) address from an existing flexible IP.
+   *
+   * @param request - The request {@link DeleteMACAddrRequest}
+   */
+  deleteMACAddr = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/flexible-ip/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/fips/${marshalling.validatePathParam("fipId", request.fipId)}/mac`
+  });
+}
+exports.API = API;

package/dist/api/flexibleip/v1alpha1/api.gen.d.ts

@@ -0,0 +1,117 @@
+import { API as ParentAPI } from '../../../bridge';
+import type { WaitForOptions, Zone } from '../../../bridge';
+import type { AttachFlexibleIPRequest, AttachFlexibleIPsResponse, CreateFlexibleIPRequest, DeleteFlexibleIPRequest, DeleteMACAddrRequest, DetachFlexibleIPRequest, DetachFlexibleIPsResponse, DuplicateMACAddrRequest, FlexibleIP, GenerateMACAddrRequest, GetFlexibleIPRequest, ListFlexibleIPsRequest, ListFlexibleIPsResponse, MoveMACAddrRequest, UpdateFlexibleIPRequest } from './types.gen';
+/** Elastic Metal - Flexible IP API. */
+export declare class API extends ParentAPI {
+    /** Lists the available zones of the API. */
+    static readonly LOCALITIES: Zone[];
+    /**
+     * Create a new flexible IP. Generate a new flexible IP within a given zone,
+     * specifying its configuration including Project ID and description.
+     *
+     * @param request - The request {@link CreateFlexibleIPRequest}
+     * @returns A Promise of FlexibleIP
+     */
+    createFlexibleIP: (request: Readonly<CreateFlexibleIPRequest>) => Promise<FlexibleIP>;
+    /**
+     * Get an existing flexible IP. Retrieve information about an existing
+     * flexible IP, specified by its ID and zone. Its full details, including
+     * Project ID, description and status, are returned in the response object.
+     *
+     * @param request - The request {@link GetFlexibleIPRequest}
+     * @returns A Promise of FlexibleIP
+     */
+    getFlexibleIP: (request: Readonly<GetFlexibleIPRequest>) => Promise<FlexibleIP>;
+    /**
+     * Waits for {@link FlexibleIP} to be in a final state.
+     *
+     * @param request - The request {@link GetFlexibleIPRequest}
+     * @param options - The waiting options
+     * @returns A Promise of FlexibleIP
+     */
+    waitForFlexibleIP: (request: Readonly<GetFlexibleIPRequest>, options?: Readonly<WaitForOptions<FlexibleIP>>) => Promise<FlexibleIP>;
+    protected pageOfListFlexibleIPs: (request?: Readonly<ListFlexibleIPsRequest>) => Promise<ListFlexibleIPsResponse>;
+    /**
+     * List flexible IPs. List all flexible IPs within a given zone.
+     *
+     * @param request - The request {@link ListFlexibleIPsRequest}
+     * @returns A Promise of ListFlexibleIPsResponse
+     */
+    listFlexibleIPs: (request?: Readonly<ListFlexibleIPsRequest>) => Promise<ListFlexibleIPsResponse> & {
+        /**
+         * Waits for {@link FlexibleIP} to be in a final state.
+         *
+         * @param request - The request {@link GetFlexibleIPRequest}
+         * @param options - The waiting options
+         * @returns A Promise of FlexibleIP
+         */
+        all: () => Promise<FlexibleIP[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<FlexibleIP[], void, void>;
+    };
+    /**
+     * Update an existing flexible IP. Update the parameters of an existing
+     * flexible IP, specified by its ID and zone. These parameters include tags
+     * and description.
+     *
+     * @param request - The request {@link UpdateFlexibleIPRequest}
+     * @returns A Promise of FlexibleIP
+     */
+    updateFlexibleIP: (request: Readonly<UpdateFlexibleIPRequest>) => Promise<FlexibleIP>;
+    /**
+     * Delete an existing flexible IP. Delete an existing flexible IP, specified
+     * by its ID and zone. Note that deleting a flexible IP is permanent and
+     * cannot be undone.
+     *
+     * @param request - The request {@link DeleteFlexibleIPRequest}
+     */
+    deleteFlexibleIP: (request: Readonly<DeleteFlexibleIPRequest>) => Promise<void>;
+    /**
+     * Attach an existing flexible IP to a server. Attach an existing flexible IP
+     * to a specified Elastic Metal server.
+     *
+     * @param request - The request {@link AttachFlexibleIPRequest}
+     * @returns A Promise of AttachFlexibleIPsResponse
+     */
+    attachFlexibleIP: (request: Readonly<AttachFlexibleIPRequest>) => Promise<AttachFlexibleIPsResponse>;
+    /**
+     * Detach an existing flexible IP from a server. Detach an existing flexible
+     * IP from a specified Elastic Metal server.
+     *
+     * @param request - The request {@link DetachFlexibleIPRequest}
+     * @returns A Promise of DetachFlexibleIPsResponse
+     */
+    detachFlexibleIP: (request: Readonly<DetachFlexibleIPRequest>) => Promise<DetachFlexibleIPsResponse>;
+    /**
+     * Generate a virtual MAC address on an existing flexible IP. Generate a
+     * virtual MAC (Media Access Control) address on an existing flexible IP.
+     *
+     * @param request - The request {@link GenerateMACAddrRequest}
+     * @returns A Promise of FlexibleIP
+     */
+    generateMACAddr: (request: Readonly<GenerateMACAddrRequest>) => Promise<FlexibleIP>;
+    /**
+     * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual
+     * MAC address from a given flexible IP to another flexible IP attached to the
+     * same server.
+     *
+     * @param request - The request {@link DuplicateMACAddrRequest}
+     * @returns A Promise of FlexibleIP
+     */
+    duplicateMACAddr: (request: Readonly<DuplicateMACAddrRequest>) => Promise<FlexibleIP>;
+    /**
+     * Relocate an existing virtual MAC address to a different flexible IP.
+     * Relocate a virtual MAC (Media Access Control) address from an existing
+     * flexible IP to a different flexible IP.
+     *
+     * @param request - The request {@link MoveMACAddrRequest}
+     * @returns A Promise of FlexibleIP
+     */
+    moveMACAddr: (request: Readonly<MoveMACAddrRequest>) => Promise<FlexibleIP>;
+    /**
+     * Detach a given virtual MAC address from an existing flexible IP. Detach a
+     * given MAC (Media Access Control) address from an existing flexible IP.
+     *
+     * @param request - The request {@link DeleteMACAddrRequest}
+     */
+    deleteMACAddr: (request: Readonly<DeleteMACAddrRequest>) => Promise<void>;
+}