@scaleway/sdk 2.60.0 → 2.62.0

package/dist/api/tem/v1alpha1/marshalling.gen.d.ts

@@ -1,16 +1,19 @@
 import type { DefaultValues } from '../../../bridge';
-import type { CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, Domain, DomainLastStatus, Email, ListDomainsResponse, ListEmailsResponse, ListWebhookEventsResponse, ListWebhooksResponse, ProjectSettings, Statistics, UpdateDomainRequest, UpdateProjectSettingsRequest, UpdateWebhookRequest, Webhook } from './types.gen';
+import type { BulkCreateBlocklistsRequest, BulkCreateBlocklistsResponse, CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, Domain, DomainLastStatus, Email, ListBlocklistsResponse, ListDomainsResponse, ListEmailsResponse, ListWebhookEventsResponse, ListWebhooksResponse, ProjectSettings, Statistics, UpdateDomainRequest, UpdateProjectSettingsRequest, UpdateWebhookRequest, Webhook } from './types.gen';
 export declare const unmarshalEmail: (data: unknown) => Email;
 export declare const unmarshalDomain: (data: unknown) => Domain;
 export declare const unmarshalWebhook: (data: unknown) => Webhook;
+export declare const unmarshalBulkCreateBlocklistsResponse: (data: unknown) => BulkCreateBlocklistsResponse;
 export declare const unmarshalCreateEmailResponse: (data: unknown) => CreateEmailResponse;
 export declare const unmarshalDomainLastStatus: (data: unknown) => DomainLastStatus;
+export declare const unmarshalListBlocklistsResponse: (data: unknown) => ListBlocklistsResponse;
 export declare const unmarshalListDomainsResponse: (data: unknown) => ListDomainsResponse;
 export declare const unmarshalListEmailsResponse: (data: unknown) => ListEmailsResponse;
 export declare const unmarshalListWebhookEventsResponse: (data: unknown) => ListWebhookEventsResponse;
 export declare const unmarshalListWebhooksResponse: (data: unknown) => ListWebhooksResponse;
 export declare const unmarshalProjectSettings: (data: unknown) => ProjectSettings;
 export declare const unmarshalStatistics: (data: unknown) => Statistics;
+export declare const marshalBulkCreateBlocklistsRequest: (request: BulkCreateBlocklistsRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalCreateDomainRequest: (request: CreateDomainRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalCreateEmailRequest: (request: CreateEmailRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalCreateWebhookRequest: (request: CreateWebhookRequest, defaults: DefaultValues) => Record<string, unknown>;

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

@@ -130,6 +130,34 @@ const unmarshalWebhook = (data) => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
+const unmarshalBlocklist = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Blocklist' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    custom: data.custom,
+    domainId: data.domain_id,
+    email: data.email,
+    endsAt: unmarshalDate(data.ends_at),
+    id: data.id,
+    reason: data.reason,
+    type: data.type,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalBulkCreateBlocklistsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'BulkCreateBlocklistsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    blocklists: unmarshalArrayOfObject(data.blocklists, unmarshalBlocklist)
+  };
+};
 const unmarshalCreateEmailResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -203,6 +231,17 @@ const unmarshalDomainLastStatus = (data) => {
     spfRecord: data.spf_record ? unmarshalDomainLastStatusSpfRecord(data.spf_record) : void 0
   };
 };
+const unmarshalListBlocklistsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListBlocklistsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    blocklists: unmarshalArrayOfObject(data.blocklists, unmarshalBlocklist),
+    totalCount: data.total_count
+  };
+};
 const unmarshalListDomainsResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -308,6 +347,12 @@ const unmarshalStatistics = (data) => {
     totalCount: data.total_count
   };
 };
+const marshalBulkCreateBlocklistsRequest = (request, defaults) => ({
+  domain_id: request.domainId,
+  emails: request.emails,
+  reason: request.reason,
+  type: request.type
+});
 const marshalCreateDomainRequest = (request, defaults) => ({
   accept_tos: request.acceptTos,
   autoconfig: request.autoconfig,
@@ -371,16 +416,19 @@ const marshalUpdateWebhookRequest = (request, defaults) => ({
   sns_arn: request.snsArn
 });
 export {
+  marshalBulkCreateBlocklistsRequest,
   marshalCreateDomainRequest,
   marshalCreateEmailRequest,
   marshalCreateWebhookRequest,
   marshalUpdateDomainRequest,
   marshalUpdateProjectSettingsRequest,
   marshalUpdateWebhookRequest,
+  unmarshalBulkCreateBlocklistsResponse,
   unmarshalCreateEmailResponse,
   unmarshalDomain,
   unmarshalDomainLastStatus,
   unmarshalEmail,
+  unmarshalListBlocklistsResponse,
   unmarshalListDomainsResponse,
   unmarshalListEmailsResponse,
   unmarshalListWebhookEventsResponse,

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

@@ -1,11 +1,13 @@
 import type { Region } from '../../../bridge';
+export type BlocklistType = 'unknown_type' | 'mailbox_full' | 'mailbox_not_found';
 export type DomainLastStatusAutoconfigStateReason = 'unknown_reason' | 'permission_denied' | 'domain_not_found';
 export type DomainLastStatusRecordStatus = 'unknown_record_status' | 'valid' | 'invalid' | 'not_found';
 export type DomainReputationStatus = 'unknown_status' | 'excellent' | 'good' | 'average' | 'bad';
 export type DomainStatus = 'unknown' | 'checked' | 'unchecked' | 'invalid' | 'locked' | 'revoked' | 'pending' | 'autoconfiguring';
-export type EmailFlag = 'unknown_flag' | 'soft_bounce' | 'hard_bounce' | 'spam' | 'mailbox_full' | 'mailbox_not_found' | 'greylisted' | 'send_before_expiration';
+export type EmailFlag = 'unknown_flag' | 'soft_bounce' | 'hard_bounce' | 'spam' | 'mailbox_full' | 'mailbox_not_found' | 'greylisted' | 'send_before_expiration' | 'blocklisted';
 export type EmailRcptType = 'unknown_rcpt_type' | 'to' | 'cc' | 'bcc';
 export type EmailStatus = 'unknown' | 'new' | 'sending' | 'sent' | 'failed' | 'canceled';
+export type ListBlocklistsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'ends_at_desc' | 'ends_at_asc';
 export type ListEmailsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'status_desc' | 'status_asc' | 'mail_from_desc' | 'mail_from_asc' | 'mail_rcpt_desc' | 'mail_rcpt_asc' | 'subject_desc' | 'subject_asc';
 export type ListWebhookEventsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
 export type ListWebhooksRequestOrderBy = 'created_at_desc' | 'created_at_asc';
@@ -60,6 +62,29 @@ export interface DomainStatistics {
     failedCount: number;
     canceledCount: number;
 }
+export interface Blocklist {
+    /** ID of the blocklist. */
+    id: string;
+    /** Domain ID linked to the blocklist. */
+    domainId: string;
+    /** Date and time of the blocklist creation. */
+    createdAt?: Date;
+    /** Date and time of the blocklist's last update. */
+    updatedAt?: Date;
+    /** Date and time when the blocklist ends. Empty if the blocklist has no end. */
+    endsAt?: Date;
+    /** Email blocked by the blocklist. */
+    email: string;
+    /** Type of block for this email. */
+    type: BlocklistType;
+    /** Reason to block this email. */
+    reason: string;
+    /**
+     * True if this blocklist was created manually. False for an automatic
+     * Transactional Email blocklist.
+     */
+    custom: boolean;
+}
 export interface CreateEmailRequestAddress {
     /** Email address. */
     email: string;
@@ -259,6 +284,25 @@ export interface UpdateProjectSettingsRequestUpdatePeriodicReport {
      */
     sendingDay?: number;
 }
+export type BulkCreateBlocklistsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Domain ID linked to the blocklist. */
+    domainId: string;
+    /** Email blocked by the blocklist. */
+    emails?: string[];
+    /** Type of blocklist. */
+    type?: BlocklistType;
+    /** Reason to block the email. */
+    reason?: string;
+};
+export interface BulkCreateBlocklistsResponse {
+    /** List of blocklist created. */
+    blocklists: Blocklist[];
+}
 export type CancelEmailRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -342,6 +386,15 @@ export type CreateWebhookRequest = {
     /** Scaleway SNS ARN topic to push the events to. */
     snsArn: string;
 };
+export type DeleteBlocklistRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the blocklist to delete. */
+    blocklistId: string;
+};
 export type DeleteWebhookRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -430,6 +483,36 @@ export type GetWebhookRequest = {
     /** ID of the Webhook to check. */
     webhookId: string;
 };
+export type ListBlocklistsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** (Optional) List blocklist corresponding to specific criteria. */
+    orderBy?: ListBlocklistsRequestOrderBy;
+    /** (Optional) Requested page number. Value must be greater or equal to 1. */
+    page?: number;
+    /** (Optional) Requested page size. Value must be between 1 and 100. */
+    pageSize?: number;
+    /** (Optional) Filter by a domain ID. */
+    domainId: string;
+    /** (Optional) Filter by an email address. */
+    email?: string;
+    /** (Optional) Filter by a blocklist type. */
+    type?: BlocklistType;
+    /**
+     * (Optional) Filter by custom blocklist (true) or automatic Transactional
+     * Email blocklist (false).
+     */
+    custom?: boolean;
+};
+export interface ListBlocklistsResponse {
+    /** Number of blocklists matching the requested criteria. */
+    totalCount: number;
+    /** Single page of blocklists matching the requested criteria. */
+    blocklists: Blocklist[];
+}
 export type ListDomainsRequest = {
     /**
      * Region to target. If none is passed will use default region from the

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

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const BulkCreateBlocklistsRequest = {
+  reason: {
+    maxLength: 200
+  }
+};
 const CreateDomainRequest = {
   domainName: {
     maxLength: 255,
@@ -42,6 +47,15 @@ const CreateWebhookRequest = {
     minLength: 3
   }
 };
+const ListBlocklistsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 100
+  }
+};
 const ListDomainsRequest = {
   page: {
     greaterThan: 0
@@ -105,12 +119,14 @@ const UpdateWebhookRequest = {
     minLength: 3
   }
 };
+exports.BulkCreateBlocklistsRequest = BulkCreateBlocklistsRequest;
 exports.CreateDomainRequest = CreateDomainRequest;
 exports.CreateEmailRequest = CreateEmailRequest;
 exports.CreateEmailRequestAddress = CreateEmailRequestAddress;
 exports.CreateEmailRequestAttachment = CreateEmailRequestAttachment;
 exports.CreateEmailRequestHeader = CreateEmailRequestHeader;
 exports.CreateWebhookRequest = CreateWebhookRequest;
+exports.ListBlocklistsRequest = ListBlocklistsRequest;
 exports.ListDomainsRequest = ListDomainsRequest;
 exports.ListEmailsRequest = ListEmailsRequest;
 exports.ListWebhookEventsRequest = ListWebhookEventsRequest;

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

@@ -1,3 +1,8 @@
+export declare const BulkCreateBlocklistsRequest: {
+    reason: {
+        maxLength: number;
+    };
+};
 export declare const CreateDomainRequest: {
     domainName: {
         maxLength: number;
@@ -40,6 +45,15 @@ export declare const CreateWebhookRequest: {
         minLength: number;
     };
 };
+export declare const ListBlocklistsRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
 export declare const ListDomainsRequest: {
     page: {
         greaterThan: number;

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

@@ -1,3 +1,8 @@
+const BulkCreateBlocklistsRequest = {
+  reason: {
+    maxLength: 200
+  }
+};
 const CreateDomainRequest = {
   domainName: {
     maxLength: 255,
@@ -40,6 +45,15 @@ const CreateWebhookRequest = {
     minLength: 3
   }
 };
+const ListBlocklistsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 100
+  }
+};
 const ListDomainsRequest = {
   page: {
     greaterThan: 0
@@ -104,12 +118,14 @@ const UpdateWebhookRequest = {
   }
 };
 export {
+  BulkCreateBlocklistsRequest,
   CreateDomainRequest,
   CreateEmailRequest,
   CreateEmailRequestAddress,
   CreateEmailRequestAttachment,
   CreateEmailRequestHeader,
   CreateWebhookRequest,
+  ListBlocklistsRequest,
   ListDomainsRequest,
   ListEmailsRequest,
   ListWebhookEventsRequest,

package/dist/api/test/index.gen.d.ts

@@ -2,4 +2,4 @@
  * This file is automatically generated from /scripts/generate.js PLEASE DO NOT
  * EDIT HERE
  */
-export * as v1 from './v1/index.gen';
+export * as v1 from './v1/index.gen.js';

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

@@ -1,3 +1,3 @@
-export { API } from './api.gen';
-export * from './content.gen';
+export { API } from './api.gen.js';
+export * from './content.gen.js';
 export type { CreateHumanRequest, DeleteHumanRequest, EyeColors, GetHumanRequest, Human, HumanStatus, ListHumansRequest, ListHumansRequestOrderBy, ListHumansResponse, RegisterRequest, RegisterResponse, RunHumanRequest, SmokeHumanRequest, UpdateHumanRequest, } from './types.gen';

package/dist/api/vpc/index.gen.d.ts

@@ -2,5 +2,5 @@
  * This file is automatically generated from /scripts/generate.js PLEASE DO NOT
  * EDIT HERE
  */
-export * as v1 from './v1/index.gen';
-export * as v2 from './v2/index.gen';
+export * as v1 from './v1/index.gen.js';
+export * as v2 from './v2/index.gen.js';

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

@@ -1,2 +1,2 @@
-export { API } from './api.gen';
+export { API } from './api.gen.js';
 export type { CreatePrivateNetworkRequest, DeletePrivateNetworkRequest, GetPrivateNetworkRequest, ListPrivateNetworksRequest, ListPrivateNetworksRequestOrderBy, ListPrivateNetworksResponse, PrivateNetwork, UpdatePrivateNetworkRequest, } from './types.gen';

package/dist/api/vpc/v2/index.gen.d.ts

@@ -1,3 +1,3 @@
-export { API } from './api.gen';
+export { API } from './api.gen.js';
 export type { AddSubnetsRequest, AddSubnetsResponse, CreatePrivateNetworkRequest, CreateRouteRequest, CreateVPCRequest, DeletePrivateNetworkRequest, DeleteRouteRequest, DeleteSubnetsRequest, DeleteSubnetsResponse, DeleteVPCRequest, EnableDHCPRequest, EnableRoutingRequest, GetPrivateNetworkRequest, GetRouteRequest, GetVPCRequest, ListPrivateNetworksRequest, ListPrivateNetworksRequestOrderBy, ListPrivateNetworksResponse, ListSubnetsRequest, ListSubnetsRequestOrderBy, ListSubnetsResponse, ListVPCsRequest, ListVPCsRequestOrderBy, ListVPCsResponse, MigrateZonalPrivateNetworksRequest, PrivateNetwork, Route, SetSubnetsRequest, SetSubnetsResponse, Subnet, UpdatePrivateNetworkRequest, UpdateRouteRequest, UpdateVPCRequest, VPC, } from './types.gen';
-export * as ValidationRules from './validation-rules.gen';
+export * as ValidationRules from './validation-rules.gen.js';

package/dist/api/vpcgw/index.gen.d.ts

@@ -2,5 +2,5 @@
  * This file is automatically generated from /scripts/generate.js PLEASE DO NOT
  * EDIT HERE
  */
-export * as v1 from './v1/index.gen';
-export * as v2 from './v2/index.gen';
+export * as v1 from './v1/index.gen.js';
+export * as v2 from './v2/index.gen.js';

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

@@ -1,3 +1,3 @@
-export { API } from './api.gen';
-export * from './content.gen';
+export { API } from './api.gen.js';
+export * from './content.gen.js';
 export type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayNetworkRequestIpamConfig, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DHCP, DHCPEntry, DHCPEntryType, DeleteDHCPEntryRequest, DeleteDHCPRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePATRuleRequest, EnableIPMobilityRequest, Gateway, GatewayNetwork, GatewayNetworkStatus, GatewayStatus, GatewayType, GetDHCPEntryRequest, GetDHCPRequest, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPATRuleRequest, IP, IpamConfig, ListDHCPEntriesRequest, ListDHCPEntriesRequestOrderBy, ListDHCPEntriesResponse, ListDHCPsRequest, ListDHCPsRequestOrderBy, ListDHCPsResponse, ListGatewayNetworksRequest, ListGatewayNetworksRequestOrderBy, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysRequestOrderBy, ListGatewaysResponse, ListIPsRequest, ListIPsRequestOrderBy, ListIPsResponse, ListPATRulesRequest, ListPATRulesRequestOrderBy, ListPATRulesResponse, PATRule, PATRuleProtocol, RefreshSSHKeysRequest, SetDHCPEntriesRequest, SetDHCPEntriesRequestEntry, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesRequestRule, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayNetworkRequestIpamConfig, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest, } from './types.gen';

package/dist/api/vpcgw/v2/api.gen.cjs

@@ -514,5 +514,52 @@ class API extends api.API {
     },
     marshalling_gen.unmarshalGateway
   );
+  /**
+   * Add allowed IP range to SSH bastion. Add an IP range (in CIDR notation) to
+   * be allowed to connect to the SSH bastion.
+   *
+   * @param request - The request {@link AddBastionAllowedIPsRequest}
+   * @returns A Promise of AddBastionAllowedIPsResponse
+   */
+  addBastionAllowedIPs = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalAddBastionAllowedIPsRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips`
+    },
+    marshalling_gen.unmarshalAddBastionAllowedIPsResponse
+  );
+  /**
+   * Set all IP ranges allowed for SSH bastion. Set a definitive list of IP
+   * ranges (in CIDR notation) allowed to connect to the SSH bastion.
+   *
+   * @param request - The request {@link SetBastionAllowedIPsRequest}
+   * @returns A Promise of SetBastionAllowedIPsResponse
+   */
+  setBastionAllowedIPs = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalSetBastionAllowedIPsRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PUT",
+      path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips`
+    },
+    marshalling_gen.unmarshalSetBastionAllowedIPsResponse
+  );
+  /**
+   * Delete allowed IP range from SSH bastion. Delete an IP range (defined in
+   * CIDR notation) from SSH bastion, so that it is no longer allowed to
+   * connect.
+   *
+   * @param request - The request {@link DeleteBastionAllowedIPsRequest}
+   */
+  deleteBastionAllowedIPs = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/vpc-gw/v2/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips/${marshalling.validatePathParam("ipRange", request.ipRange)}`
+  });
 }
 exports.API = API;

package/dist/api/vpcgw/v2/api.gen.d.ts

@@ -1,6 +1,6 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { WaitForOptions, Zone } from '../../../bridge';
-import type { CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysResponse, ListIPsRequest, ListIPsResponse, ListPatRulesRequest, ListPatRulesResponse, PatRule, RefreshSSHKeysRequest, SetPatRulesRequest, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest } from './types.gen';
+import type { AddBastionAllowedIPsRequest, AddBastionAllowedIPsResponse, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteBastionAllowedIPsRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysResponse, ListIPsRequest, ListIPsResponse, ListPatRulesRequest, ListPatRulesResponse, PatRule, RefreshSSHKeysRequest, SetBastionAllowedIPsRequest, SetBastionAllowedIPsResponse, SetPatRulesRequest, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest } from './types.gen';
 /**
  * Public Gateways API.
  *
@@ -264,4 +264,28 @@ export declare class API extends ParentAPI {
      * @returns A Promise of Gateway
      */
     refreshSSHKeys: (request: Readonly<RefreshSSHKeysRequest>) => Promise<Gateway>;
+    /**
+     * Add allowed IP range to SSH bastion. Add an IP range (in CIDR notation) to
+     * be allowed to connect to the SSH bastion.
+     *
+     * @param request - The request {@link AddBastionAllowedIPsRequest}
+     * @returns A Promise of AddBastionAllowedIPsResponse
+     */
+    addBastionAllowedIPs: (request: Readonly<AddBastionAllowedIPsRequest>) => Promise<AddBastionAllowedIPsResponse>;
+    /**
+     * Set all IP ranges allowed for SSH bastion. Set a definitive list of IP
+     * ranges (in CIDR notation) allowed to connect to the SSH bastion.
+     *
+     * @param request - The request {@link SetBastionAllowedIPsRequest}
+     * @returns A Promise of SetBastionAllowedIPsResponse
+     */
+    setBastionAllowedIPs: (request: Readonly<SetBastionAllowedIPsRequest>) => Promise<SetBastionAllowedIPsResponse>;
+    /**
+     * Delete allowed IP range from SSH bastion. Delete an IP range (defined in
+     * CIDR notation) from SSH bastion, so that it is no longer allowed to
+     * connect.
+     *
+     * @param request - The request {@link DeleteBastionAllowedIPsRequest}
+     */
+    deleteBastionAllowedIPs: (request: Readonly<DeleteBastionAllowedIPsRequest>) => Promise<void>;
 }

package/dist/api/vpcgw/v2/api.gen.js

@@ -4,7 +4,7 @@ import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
 import "../../../vendor/base64/index.js";
 import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
 import { GATEWAY_TRANSIENT_STATUSES, GATEWAY_NETWORK_TRANSIENT_STATUSES } from "./content.gen.js";
-import { unmarshalListGatewaysResponse, unmarshalGateway, marshalCreateGatewayRequest, marshalUpdateGatewayRequest, marshalUpgradeGatewayRequest, unmarshalListGatewayNetworksResponse, unmarshalGatewayNetwork, marshalCreateGatewayNetworkRequest, marshalUpdateGatewayNetworkRequest, unmarshalListPatRulesResponse, unmarshalPatRule, marshalCreatePatRuleRequest, marshalUpdatePatRuleRequest, marshalSetPatRulesRequest, unmarshalSetPatRulesResponse, unmarshalListGatewayTypesResponse, unmarshalListIPsResponse, unmarshalIP, marshalCreateIPRequest, marshalUpdateIPRequest } from "./marshalling.gen.js";
+import { unmarshalListGatewaysResponse, unmarshalGateway, marshalCreateGatewayRequest, marshalUpdateGatewayRequest, marshalUpgradeGatewayRequest, unmarshalListGatewayNetworksResponse, unmarshalGatewayNetwork, marshalCreateGatewayNetworkRequest, marshalUpdateGatewayNetworkRequest, unmarshalListPatRulesResponse, unmarshalPatRule, marshalCreatePatRuleRequest, marshalUpdatePatRuleRequest, marshalSetPatRulesRequest, unmarshalSetPatRulesResponse, unmarshalListGatewayTypesResponse, unmarshalListIPsResponse, unmarshalIP, marshalCreateIPRequest, marshalUpdateIPRequest, marshalAddBastionAllowedIPsRequest, unmarshalAddBastionAllowedIPsResponse, marshalSetBastionAllowedIPsRequest, unmarshalSetBastionAllowedIPsResponse } from "./marshalling.gen.js";
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
@@ -512,6 +512,53 @@ class API extends API$1 {
     },
     unmarshalGateway
   );
+  /**
+   * Add allowed IP range to SSH bastion. Add an IP range (in CIDR notation) to
+   * be allowed to connect to the SSH bastion.
+   *
+   * @param request - The request {@link AddBastionAllowedIPsRequest}
+   * @returns A Promise of AddBastionAllowedIPsResponse
+   */
+  addBastionAllowedIPs = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalAddBastionAllowedIPsRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips`
+    },
+    unmarshalAddBastionAllowedIPsResponse
+  );
+  /**
+   * Set all IP ranges allowed for SSH bastion. Set a definitive list of IP
+   * ranges (in CIDR notation) allowed to connect to the SSH bastion.
+   *
+   * @param request - The request {@link SetBastionAllowedIPsRequest}
+   * @returns A Promise of SetBastionAllowedIPsResponse
+   */
+  setBastionAllowedIPs = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalSetBastionAllowedIPsRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PUT",
+      path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips`
+    },
+    unmarshalSetBastionAllowedIPsResponse
+  );
+  /**
+   * Delete allowed IP range from SSH bastion. Delete an IP range (defined in
+   * CIDR notation) from SSH bastion, so that it is no longer allowed to
+   * connect.
+   *
+   * @param request - The request {@link DeleteBastionAllowedIPsRequest}
+   */
+  deleteBastionAllowedIPs = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/vpc-gw/v2/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/bastion-allowed-ips/${validatePathParam("ipRange", request.ipRange)}`
+  });
 }
 export {
   API

package/dist/api/vpcgw/v2/index.gen.d.ts

@@ -1,3 +1,3 @@
-export { API } from './api.gen';
-export * from './content.gen';
-export type { CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GatewayNetworkStatus, GatewayStatus, GatewayType, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksRequestOrderBy, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysRequestOrderBy, ListGatewaysResponse, ListIPsRequest, ListIPsRequestOrderBy, ListIPsResponse, ListPatRulesRequest, ListPatRulesRequestOrderBy, ListPatRulesResponse, PatRule, PatRuleProtocol, RefreshSSHKeysRequest, SetPatRulesRequest, SetPatRulesRequestRule, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest, } from './types.gen';
+export { API } from './api.gen.js';
+export * from './content.gen.js';
+export type { AddBastionAllowedIPsRequest, AddBastionAllowedIPsResponse, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePatRuleRequest, DeleteBastionAllowedIPsRequest, DeleteGatewayNetworkRequest, DeleteGatewayRequest, DeleteIPRequest, DeletePatRuleRequest, Gateway, GatewayNetwork, GatewayNetworkStatus, GatewayStatus, GatewayType, GetGatewayNetworkRequest, GetGatewayRequest, GetIPRequest, GetPatRuleRequest, IP, ListGatewayNetworksRequest, ListGatewayNetworksRequestOrderBy, ListGatewayNetworksResponse, ListGatewayTypesRequest, ListGatewayTypesResponse, ListGatewaysRequest, ListGatewaysRequestOrderBy, ListGatewaysResponse, ListIPsRequest, ListIPsRequestOrderBy, ListIPsResponse, ListPatRulesRequest, ListPatRulesRequestOrderBy, ListPatRulesResponse, PatRule, PatRuleProtocol, RefreshSSHKeysRequest, SetBastionAllowedIPsRequest, SetBastionAllowedIPsResponse, SetPatRulesRequest, SetPatRulesRequestRule, SetPatRulesResponse, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePatRuleRequest, UpgradeGatewayRequest, } from './types.gen';

package/dist/api/vpcgw/v2/marshalling.gen.cjs

@@ -51,6 +51,7 @@ const unmarshalGateway = (data) => {
   }
   return {
     bandwidth: data.bandwidth,
+    bastionAllowedIps: data.bastion_allowed_ips,
     bastionEnabled: data.bastion_enabled,
     bastionPort: data.bastion_port,
     canUpgradeTo: data.can_upgrade_to,
@@ -92,6 +93,16 @@ const unmarshalPatRule = (data) => {
     zone: data.zone
   };
 };
+const unmarshalAddBastionAllowedIPsResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'AddBastionAllowedIPsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    ipRanges: data.ip_ranges
+  };
+};
 const unmarshalListGatewayNetworksResponse = (data) => {
   if (!json.isJSONObject(data)) {
     throw new TypeError(
@@ -161,6 +172,16 @@ const unmarshalListPatRulesResponse = (data) => {
     totalCount: data.total_count
   };
 };
+const unmarshalSetBastionAllowedIPsResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SetBastionAllowedIPsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    ipRanges: data.ip_ranges
+  };
+};
 const unmarshalSetPatRulesResponse = (data) => {
   if (!json.isJSONObject(data)) {
     throw new TypeError(
@@ -171,6 +192,9 @@ const unmarshalSetPatRulesResponse = (data) => {
     patRules: marshalling.unmarshalArrayOfObject(data.pat_rules, unmarshalPatRule)
   };
 };
+const marshalAddBastionAllowedIPsRequest = (request, defaults) => ({
+  ip_range: request.ipRange
+});
 const marshalCreateGatewayNetworkRequest = (request, defaults) => ({
   enable_masquerade: request.enableMasquerade,
   gateway_id: request.gatewayId,
@@ -199,6 +223,9 @@ const marshalCreatePatRuleRequest = (request, defaults) => ({
   protocol: request.protocol,
   public_port: request.publicPort
 });
+const marshalSetBastionAllowedIPsRequest = (request, defaults) => ({
+  ip_ranges: request.ipRanges
+});
 const marshalSetPatRulesRequestRule = (request, defaults) => ({
   private_ip: request.privateIp,
   private_port: request.privatePort,
@@ -237,16 +264,19 @@ const marshalUpdatePatRuleRequest = (request, defaults) => ({
 const marshalUpgradeGatewayRequest = (request, defaults) => ({
   type: request.type
 });
+exports.marshalAddBastionAllowedIPsRequest = marshalAddBastionAllowedIPsRequest;
 exports.marshalCreateGatewayNetworkRequest = marshalCreateGatewayNetworkRequest;
 exports.marshalCreateGatewayRequest = marshalCreateGatewayRequest;
 exports.marshalCreateIPRequest = marshalCreateIPRequest;
 exports.marshalCreatePatRuleRequest = marshalCreatePatRuleRequest;
+exports.marshalSetBastionAllowedIPsRequest = marshalSetBastionAllowedIPsRequest;
 exports.marshalSetPatRulesRequest = marshalSetPatRulesRequest;
 exports.marshalUpdateGatewayNetworkRequest = marshalUpdateGatewayNetworkRequest;
 exports.marshalUpdateGatewayRequest = marshalUpdateGatewayRequest;
 exports.marshalUpdateIPRequest = marshalUpdateIPRequest;
 exports.marshalUpdatePatRuleRequest = marshalUpdatePatRuleRequest;
 exports.marshalUpgradeGatewayRequest = marshalUpgradeGatewayRequest;
+exports.unmarshalAddBastionAllowedIPsResponse = unmarshalAddBastionAllowedIPsResponse;
 exports.unmarshalGateway = unmarshalGateway;
 exports.unmarshalGatewayNetwork = unmarshalGatewayNetwork;
 exports.unmarshalIP = unmarshalIP;
@@ -256,4 +286,5 @@ exports.unmarshalListGatewaysResponse = unmarshalListGatewaysResponse;
 exports.unmarshalListIPsResponse = unmarshalListIPsResponse;
 exports.unmarshalListPatRulesResponse = unmarshalListPatRulesResponse;
 exports.unmarshalPatRule = unmarshalPatRule;
+exports.unmarshalSetBastionAllowedIPsResponse = unmarshalSetBastionAllowedIPsResponse;
 exports.unmarshalSetPatRulesResponse = unmarshalSetPatRulesResponse;