@scaleway/sdk 2.0.0-alpha.13 → 2.0.0-alpha.15

package/dist/api/flexibleip/index.js

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

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

@@ -0,0 +1,195 @@
+import { waitForResource } from '../../../internal/async/interval-retrier.js';
+import { API as API$1 } from '../../../scw/api.js';
+import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
+import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
+import { FLEXIBLE_IP_TRANSIENT_STATUSES } from './content.gen.js';
+import { marshalCreateFlexibleIPRequest, unmarshalFlexibleIP, unmarshalListFlexibleIPsResponse, marshalUpdateFlexibleIPRequest, marshalAttachFlexibleIPRequest, unmarshalAttachFlexibleIPsResponse, marshalDetachFlexibleIPRequest, unmarshalDetachFlexibleIPsResponse, marshalGenerateMACAddrRequest, marshalDuplicateMACAddrRequest, marshalMoveMACAddrRequest } from './marshalling.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const jsonContentHeaders = {
+  'Content-Type': 'application/json; charset=utf-8'
+};
+
+/** Elastic Metal - Flexible IP API. */
+class API extends API$1 {
+  /** 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(marshalCreateFlexibleIPRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips`
+  }, 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/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}`
+  }, 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) => waitForResource(options?.stop ?? (res => Promise.resolve(!FLEXIBLE_IP_TRANSIENT_STATUSES.includes(res.status))), this.getFlexibleIP, request, options);
+  pageOfListFlexibleIPs = (() => {
+    var _this = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? _this.client.settings.defaultZone)}/fips`,
+        urlParams: 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])
+      }, unmarshalListFlexibleIPsResponse);
+    };
+  })();
+
+  /**
+   * List flexible IPs. List all flexible IPs within a given zone.
+   *
+   * @param request - The request {@link ListFlexibleIPsRequest}
+   * @returns A Promise of ListFlexibleIPsResponse
+   */
+  listFlexibleIPs = (() => {
+    var _this2 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('flexibleIps', _this2.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(marshalUpdateFlexibleIPRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'PATCH',
+    path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}`
+  }, 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/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${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(marshalAttachFlexibleIPRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/attach`
+  }, 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(marshalDetachFlexibleIPRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/detach`
+  }, 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(marshalGenerateMACAddrRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac`
+  }, 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(marshalDuplicateMACAddrRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac/duplicate`
+  }, 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(marshalMoveMACAddrRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac/move`
+  }, 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/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac`
+  });
+}
+
+export { API };

package/dist/api/flexibleip/v1alpha1/content.gen.js

@@ -0,0 +1,10 @@
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+
+/** Lists transient statutes of the enum {@link FlexibleIPStatus}. */
+const FLEXIBLE_IP_TRANSIENT_STATUSES = ['updating', 'detaching'];
+
+/** Lists transient statutes of the enum {@link MACAddressStatus}. */
+const MAC_ADDRESS_TRANSIENT_STATUSES = ['updating', 'deleting'];
+
+export { FLEXIBLE_IP_TRANSIENT_STATUSES, MAC_ADDRESS_TRANSIENT_STATUSES };

package/dist/api/flexibleip/v1alpha1/index.gen.js

@@ -0,0 +1,7 @@
+export { API } from './api.gen.js';
+export { FLEXIBLE_IP_TRANSIENT_STATUSES, MAC_ADDRESS_TRANSIENT_STATUSES } from './content.gen.js';
+import * as validationRules_gen from './validation-rules.gen.js';
+export { validationRules_gen as ValidationRules };
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.

package/dist/api/flexibleip/v1alpha1/marshalling.gen.js

@@ -0,0 +1,97 @@
+import { isJSONObject } from '../../../helpers/json.js';
+import { unmarshalDate, unmarshalArrayOfObject } from '../../../helpers/marshalling.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const unmarshalMACAddress = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'MACAddress' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    macAddress: data.mac_address,
+    macType: data.mac_type,
+    status: data.status,
+    updatedAt: unmarshalDate(data.updated_at),
+    zone: data.zone
+  };
+};
+const unmarshalFlexibleIP = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'FlexibleIP' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    description: data.description,
+    id: data.id,
+    ipAddress: data.ip_address,
+    macAddress: data.mac_address ? unmarshalMACAddress(data.mac_address) : undefined,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    reverse: data.reverse,
+    serverId: data.server_id,
+    status: data.status,
+    tags: data.tags,
+    updatedAt: unmarshalDate(data.updated_at),
+    zone: data.zone
+  };
+};
+const unmarshalAttachFlexibleIPsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'AttachFlexibleIPsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    flexibleIps: unmarshalArrayOfObject(data.flexible_ips, unmarshalFlexibleIP),
+    totalCount: data.total_count
+  };
+};
+const unmarshalDetachFlexibleIPsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DetachFlexibleIPsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    flexibleIps: unmarshalArrayOfObject(data.flexible_ips, unmarshalFlexibleIP),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListFlexibleIPsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListFlexibleIPsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    flexibleIps: unmarshalArrayOfObject(data.flexible_ips, unmarshalFlexibleIP),
+    totalCount: data.total_count
+  };
+};
+const marshalAttachFlexibleIPRequest = (request, defaults) => ({
+  fips_ids: request.fipsIds,
+  server_id: request.serverId
+});
+const marshalCreateFlexibleIPRequest = (request, defaults) => ({
+  description: request.description,
+  is_ipv6: request.isIpv6,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  reverse: request.reverse,
+  server_id: request.serverId,
+  tags: request.tags
+});
+const marshalDetachFlexibleIPRequest = (request, defaults) => ({
+  fips_ids: request.fipsIds
+});
+const marshalDuplicateMACAddrRequest = (request, defaults) => ({
+  duplicate_from_fip_id: request.duplicateFromFipId
+});
+const marshalGenerateMACAddrRequest = (request, defaults) => ({
+  mac_type: request.macType
+});
+const marshalMoveMACAddrRequest = (request, defaults) => ({
+  dst_fip_id: request.dstFipId
+});
+const marshalUpdateFlexibleIPRequest = (request, defaults) => ({
+  description: request.description,
+  reverse: request.reverse,
+  tags: request.tags
+});
+
+export { marshalAttachFlexibleIPRequest, marshalCreateFlexibleIPRequest, marshalDetachFlexibleIPRequest, marshalDuplicateMACAddrRequest, marshalGenerateMACAddrRequest, marshalMoveMACAddrRequest, marshalUpdateFlexibleIPRequest, unmarshalAttachFlexibleIPsResponse, unmarshalDetachFlexibleIPsResponse, unmarshalFlexibleIP, unmarshalListFlexibleIPsResponse };

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

@@ -0,0 +1,14 @@
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+
+const ListFlexibleIPsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+
+export { ListFlexibleIPsRequest };

package/dist/api/function/index.js

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