@scaleway/sdk-vpc 2.9.1 → 2.10.0

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

@@ -201,7 +201,7 @@ export declare class API extends ParentAPI {
     deleteVPCConnector: (request: Readonly<DeleteVPCConnectorRequest>) => Promise<void>;
     protected pageOfListSubnetOverlaps: (request: Readonly<ListSubnetOverlapsRequest>) => Promise<ListSubnetOverlapsResponse>;
     /**
-     * List subnet overlaps.. List subnet overlaps between the VPCConnector VPC and the target VPC or for a specific subnet if specified.
+     * List subnet overlaps. List subnet overlaps between the VPCs on both sides of a connector, or for a specific subnet if specified.
      *
      * @param request - The request {@link ListSubnetOverlapsRequest}
      * @returns A Promise of ListSubnetOverlapsResponse
@@ -211,12 +211,41 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").ListSubnetOverlapsResponseSubnetOverlap[], void, void>;
     };
     protected pageOfListIngressRules: (request?: Readonly<ListIngressRulesRequest>) => Promise<ListIngressRulesResponse>;
+    /**
+     * List ingress rules. List existing ingress rules in the specified region.
+     *
+     * @param request - The request {@link ListIngressRulesRequest}
+     * @returns A Promise of ListIngressRulesResponse
+     */
     listIngressRules: (request?: Readonly<ListIngressRulesRequest>) => Promise<ListIngressRulesResponse> & {
         all: () => Promise<IngressRule[]>;
         [Symbol.asyncIterator]: () => AsyncGenerator<IngressRule[], void, void>;
     };
+    /**
+     * Create an ingress rule. Create an ingress rule in the specified region.
+     *
+     * @param request - The request {@link CreateIngressRuleRequest}
+     * @returns A Promise of IngressRule
+     */
     createIngressRule: (request: Readonly<CreateIngressRuleRequest>) => Promise<IngressRule>;
+    /**
+     * Get an ingress rule. Retrieve details of an existing ingress rule, specified by its ingress rule ID.
+     *
+     * @param request - The request {@link GetIngressRuleRequest}
+     * @returns A Promise of IngressRule
+     */
     getIngressRule: (request: Readonly<GetIngressRuleRequest>) => Promise<IngressRule>;
+    /**
+     * Update an ingress rule. Update an ingress rule specified by its ingress rule ID.
+     *
+     * @param request - The request {@link UpdateIngressRuleRequest}
+     * @returns A Promise of IngressRule
+     */
     updateIngressRule: (request: Readonly<UpdateIngressRuleRequest>) => Promise<IngressRule>;
+    /**
+     * Delete an ingress rule. Delete an ingress rule specified by its ingress rule ID.
+     *
+     * @param request - The request {@link DeleteIngressRuleRequest}
+     */
     deleteIngressRule: (request: Readonly<DeleteIngressRuleRequest>) => Promise<void>;
 }

package/dist/v2/types.gen.d.ts

@@ -191,20 +191,56 @@ export interface AclRule {
     description?: string;
 }
 export interface IngressRule {
+    /**
+     * ID of the ingress rule.
+     */
     id: string;
+    /**
+     * ID of the VPC this rule belongs to.
+     */
     vpcId: string;
+    /**
+     * Date the ingress rule was created.
+     */
     createdAt?: Date;
+    /**
+     * Date the ingress rule was last modified.
+     */
     updatedAt?: Date;
+    /**
+     * Whether this rule applies to IPv4 or IPv6 traffic.
+     */
     isIpv6: boolean;
+    /**
+     * Source network to apply this rule on.
+     */
     source: string;
+    /**
+     * IP of the local resource to redirect ingress traffic to.
+     */
     nexthopResourceIp: string;
+    /**
+     * ID of the Private Network the destination resource is in.
+     */
     nexthopPrivateNetworkId: string;
+    /**
+     * Description of this ingress rule.
+     */
     description?: string;
+    /**
+     * Tags of this ingress rule.
+     */
     tags: string[];
+    /**
+     * Scaleway Organization the ingress rule belongs to.
+     */
     organizationId: string;
+    /**
+     * Scaleway Project the ingress rule belongs to.
+     */
     projectId: string;
     /**
-     * Region to target. If none is passed will use default region from the config.
+     * Region of the ingress rule.
      */
     region: ScwRegion;
 }
@@ -323,11 +359,29 @@ export type CreateIngressRuleRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * ID of the VPC this rule will belong to.
+     */
     vpcId: string;
+    /**
+     * Source network to match ingress traffic on. Can be IPv6 or IPv4.
+     */
     source: string;
+    /**
+     * IP of the local resource to redirect ingress traffic to. IP version must be consistent with the source network.
+     */
     nexthopResourceIp: string;
+    /**
+     * ID of the Private Network the destination resource is in.
+     */
     nexthopPrivateNetworkId: string;
+    /**
+     * Description for this ingress rule.
+     */
     description?: string;
+    /**
+     * Tags for this ingress rule.
+     */
     tags?: string[];
 };
 export type CreatePrivateNetworkRequest = {
@@ -447,6 +501,9 @@ export type DeleteIngressRuleRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * ID of the ingress rule to delete.
+     */
     ruleId: string;
 };
 export type DeletePrivateNetworkRequest = {
@@ -542,6 +599,9 @@ export type GetIngressRuleRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * ID of the ingress rule to return.
+     */
     ruleId: string;
 };
 export type GetPrivateNetworkRequest = {
@@ -589,15 +649,45 @@ export type ListIngressRulesRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * Sort order of the returned ingress rules.
+     */
     orderBy?: ListIngressRulesRequestOrderBy;
+    /**
+     * Page number to return, from the paginated results.
+     */
     page?: number;
+    /**
+     * Maximum number of ingress rules to return per page.
+     */
     pageSize?: number;
+    /**
+     * ID of the VPC to filter for.
+     */
     vpcId?: string;
+    /**
+     * Next hop IP to filter for.
+     */
     nexthopResourceIp?: string;
+    /**
+     * Next hop Private Network ID to filter for. Only ingress rules with this Private Network as next hop will be returned.
+     */
     nexthopPrivateNetworkId?: string;
+    /**
+     * Whether to return only IPv4 or IPv6 ingress rules.
+     */
     isIpv6?: boolean;
+    /**
+     * Tags to filter for. Only ingress rules with one or more matching tags will be returned.
+     */
     tags?: string[];
+    /**
+     * Organization ID to filter for. Only ingress rules belonging to this Organization will be returned.
+     */
     organizationId?: string;
+    /**
+     * Project ID to filter for. Only ingress rules belonging to this Project will be returned.
+     */
     projectId?: string;
 };
 export interface ListIngressRulesResponse {
@@ -660,7 +750,7 @@ export type ListSubnetOverlapsRequest = {
      */
     region?: ScwRegion;
     /**
-     * VPCConnector ID.
+     * VPC Peering connector ID.
      */
     vpcConnectorId: string;
     /**
@@ -845,11 +935,29 @@ export type UpdateIngressRuleRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * ID of the ingress rule to update.
+     */
     ruleId: string;
+    /**
+     * Source network to match ingress traffic on. Can be IPv4 or IPv6.
+     */
     source?: string;
+    /**
+     * IP of the local resource to redirect ingress traffic to. IP version must be consistent with the source network.
+     */
     nexthopResourceIp?: string;
+    /**
+     * ID of the Private Network the destination resource is in.
+     */
     nexthopPrivateNetworkId?: string;
+    /**
+     * Description to set for this ingress rule.
+     */
     description?: string;
+    /**
+     * Tags to set for this ingress rule.
+     */
     tags?: string[];
 };
 export type UpdatePrivateNetworkRequest = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-vpc",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "description": "Scaleway SDK vpc",
   "license": "Apache-2.0",
   "repository": {
@@ -35,8 +35,8 @@
     "@scaleway/sdk-std": "2.4.3"
   },
   "devDependencies": {
-    "@repo/configs": "^0.1.1",
-    "@scaleway/sdk-client": "^2.4.1"
+    "@scaleway/sdk-client": "^2.4.1",
+    "@repo/configs": "^0.1.1"
   },
   "peerDependencies": {
     "@scaleway/sdk-client": "^2.4.1"