feat(vpc_gw): support passing IPAM IP IDs (#952)

Author: scaleway-bot

packages/clients/src/api/vpcgw/v1/index.gen.ts

@@ -6,6 +6,7 @@ export type {
   CreateDHCPEntryRequest,
   CreateDHCPRequest,
   CreateGatewayNetworkRequest,
+  CreateGatewayNetworkRequestIpamConfig,
   CreateGatewayRequest,
   CreateIPRequest,
   CreatePATRuleRequest,
@@ -63,6 +64,7 @@ export type {
   UpdateDHCPEntryRequest,
   UpdateDHCPRequest,
   UpdateGatewayNetworkRequest,
+  UpdateGatewayNetworkRequestIpamConfig,
   UpdateGatewayRequest,
   UpdateIPRequest,
   UpdatePATRuleRequest,

packages/clients/src/api/vpcgw/v1/marshalling.gen.ts

@@ -12,6 +12,7 @@ import type {
   CreateDHCPEntryRequest,
   CreateDHCPRequest,
   CreateGatewayNetworkRequest,
+  CreateGatewayNetworkRequestIpamConfig,
   CreateGatewayRequest,
   CreateIPRequest,
   CreatePATRuleRequest,
@@ -39,6 +40,7 @@ import type {
   UpdateDHCPEntryRequest,
   UpdateDHCPRequest,
   UpdateGatewayNetworkRequest,
+  UpdateGatewayNetworkRequestIpamConfig,
   UpdateGatewayRequest,
   UpdateIPRequest,
   UpdatePATRuleRequest,
@@ -81,7 +83,10 @@ const unmarshalIpamConfig = (data: unknown) => {
     )
   }
 
-  return { pushDefaultRoute: data.push_default_route } as IpamConfig
+  return {
+    ipamIpId: data.ipam_ip_id,
+    pushDefaultRoute: data.push_default_route,
+  } as IpamConfig
 }
 
 export const unmarshalGatewayNetwork = (data: unknown) => {
@@ -355,10 +360,11 @@ export const marshalCreateDHCPRequest = (
   valid_lifetime: request.validLifetime,
 })
 
-const marshalIpamConfig = (
-  request: IpamConfig,
+const marshalCreateGatewayNetworkRequestIpamConfig = (
+  request: CreateGatewayNetworkRequestIpamConfig,
   defaults: DefaultValues,
 ): Record<string, unknown> => ({
+  ipam_ip_id: request.ipamIpId,
   push_default_route: request.pushDefaultRoute,
 })
 
@@ -380,6 +386,14 @@ const marshalSetPATRulesRequestRule = (
   public_port: request.publicPort,
 })
 
+const marshalUpdateGatewayNetworkRequestIpamConfig = (
+  request: UpdateGatewayNetworkRequestIpamConfig,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  ipam_ip_id: request.ipamIpId,
+  push_default_route: request.pushDefaultRoute,
+})
+
 export const marshalCreateDHCPEntryRequest = (
   request: CreateDHCPEntryRequest,
   defaults: DefaultValues,
@@ -415,7 +429,10 @@ export const marshalCreateGatewayNetworkRequest = (
     {
       param: 'ipam_config',
       value: request.ipamConfig
-        ? marshalIpamConfig(request.ipamConfig, defaults)
+        ? marshalCreateGatewayNetworkRequestIpamConfig(
+            request.ipamConfig,
+            defaults,
+          )
         : undefined,
     },
   ]),
@@ -521,7 +538,10 @@ export const marshalUpdateGatewayNetworkRequest = (
     {
       param: 'ipam_config',
       value: request.ipamConfig
-        ? marshalIpamConfig(request.ipamConfig, defaults)
+        ? marshalUpdateGatewayNetworkRequestIpamConfig(
+            request.ipamConfig,
+            defaults,
+          )
         : undefined,
     },
   ]),

packages/clients/src/api/vpcgw/v1/types.gen.ts

@@ -71,6 +71,14 @@ export type ListPATRulesRequestOrderBy =
 
 export type PATRuleProtocol = 'unknown' | 'both' | 'tcp' | 'udp'
 
+/** Create gateway network request. ipam config. */
+export interface CreateGatewayNetworkRequestIpamConfig {
+  /** Enabling the default route also enables masquerading. */
+  pushDefaultRoute: boolean
+  /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */
+  ipamIpId?: string
+}
+
 /** Dhcp. */
 export interface DHCP {
   /** ID of the DHCP config. */
@@ -292,6 +300,8 @@ export interface IP {
 export interface IpamConfig {
   /** Defines whether the default route is enabled on that Gateway Network. */
   pushDefaultRoute: boolean
+  /** IPAM-booked IP ID as the Gateway's IP in this Private Network. */
+  ipamIpId: string
 }
 
 /** List dhcp entries response. */
@@ -409,6 +419,14 @@ export interface SetPATRulesResponse {
   patRules: PATRule[]
 }
 
+/** Update gateway network request. ipam config. */
+export interface UpdateGatewayNetworkRequestIpamConfig {
+  /** Enabling the default route also enables masquerading. */
+  pushDefaultRoute?: boolean
+  /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */
+  ipamIpId?: string
+}
+
 export type ListGatewaysRequest = {
   /** Zone to target. If none is passed will use default zone from the config. */
   zone?: Zone
@@ -592,7 +610,7 @@ export type CreateGatewayNetworkRequest = {
    * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address',
    * 'ipamConfig' could be set.
    */
-  ipamConfig?: IpamConfig
+  ipamConfig?: CreateGatewayNetworkRequestIpamConfig
 }
 
 export type UpdateGatewayNetworkRequest = {
@@ -635,7 +653,7 @@ export type UpdateGatewayNetworkRequest = {
    * One-of ('ipConfig'): at most one of 'dhcpId', 'address', 'ipamConfig' could
    * be set.
    */
-  ipamConfig?: IpamConfig
+  ipamConfig?: UpdateGatewayNetworkRequestIpamConfig
 }
 
 export type DeleteGatewayNetworkRequest = {