@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/instance/v1/types.private.gen.d.ts

@@ -4,47 +4,78 @@ export interface SetImageResponse {
     image?: Image;
 }
 export type SetSecurityGroupRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** UUID of the security group. */
+    /**
+     * UUID of the security group.
+     */
     id: string;
-    /** Name of the security group. */
+    /**
+     * Name of the security group.
+     */
     name: string;
-    /** Tags of the security group. */
+    /**
+     * Tags of the security group.
+     */
     tags?: string[];
-    /** Creation date of the security group (will be ignored). */
+    /**
+     * Creation date of the security group (will be ignored).
+     */
     creationDate?: Date;
-    /** Modification date of the security group (will be ignored). */
+    /**
+     * Modification date of the security group (will be ignored).
+     */
     modificationDate?: Date;
-    /** Description of the security group. */
+    /**
+     * Description of the security group.
+     */
     description: string;
     /**
-     * True to block SMTP on IPv4 and IPv6. This feature is read only, please open
-     * a support ticket if you need to make it configurable.
+     * True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable.
      */
     enableDefaultSecurity: boolean;
-    /** Default inbound policy. */
+    /**
+     * Default inbound policy.
+     */
     inboundDefaultPolicy?: SecurityGroupPolicy;
-    /** Default outbound policy. */
+    /**
+     * Default outbound policy.
+     */
     outboundDefaultPolicy?: SecurityGroupPolicy;
-    /** Security groups Organization ID. */
+    /**
+     * Security groups Organization ID.
+     */
     organization?: string;
-    /** Security group Project ID. */
+    /**
+     * Security group Project ID.
+     */
     project?: string;
-    /** @deprecated Please use project_default instead. */
+    /**
+     * @deprecated Please use project_default instead.
+     */
     organizationDefault?: boolean;
-    /** True use this security group for future Instances created in this project. */
+    /**
+     * True use this security group for future Instances created in this project.
+     */
     projectDefault: boolean;
-    /** Instances attached to this security group. */
+    /**
+     * Instances attached to this security group.
+     */
     servers?: ServerSummary[];
-    /** True to set the security group as stateful. */
+    /**
+     * True to set the security group as stateful.
+     */
     stateful: boolean;
 };
 export interface SetSecurityGroupResponse {
     securityGroup?: SecurityGroup;
 }
 export type SetSecurityGroupRuleRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
     securityGroupId: string;
     securityGroupRuleId: string;
@@ -62,89 +93,128 @@ export interface SetSecurityGroupRuleResponse {
     rule?: SecurityGroupRule;
 }
 export type SetServerRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** Instance unique ID. */
+    /**
+     * Instance unique ID.
+     */
     id: string;
-    /** Instance name. */
+    /**
+     * Instance name.
+     */
     name: string;
-    /** Instance Organization ID. */
+    /**
+     * Instance Organization ID.
+     */
     organization?: string;
-    /** Instance Project ID. */
+    /**
+     * Instance Project ID.
+     */
     project?: string;
-    /** Provide a list of allowed actions on the server. */
+    /**
+     * Provide a list of allowed actions on the server.
+     */
     allowedActions?: ServerAction[];
-    /** Tags associated with the Instance. */
+    /**
+     * Tags associated with the Instance.
+     */
     tags?: string[];
-    /** Instance commercial type (eg. GP1-M). */
+    /**
+     * Instance commercial type (eg. GP1-M).
+     */
     commercialType: string;
-    /** Instance creation date. */
+    /**
+     * Instance creation date.
+     */
     creationDate?: Date;
-    /** True if a dynamic IPv4 is required. */
+    /**
+     * True if a dynamic IPv4 is required.
+     */
     dynamicIpRequired: boolean;
     /**
-     * @deprecated True to configure the instance so it uses the new routed IP
-     *   mode (once this is set to True you cannot set it back to False).
+     * @deprecated True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False).
      */
     routedIpEnabled?: boolean;
     /**
-     * @deprecated True if IPv6 is enabled (deprecated and always `False` when
-     *   `routed_ip_enabled` is `True`).
+     * @deprecated True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`).
      */
     enableIpv6?: boolean;
-    /** Instance host name. */
+    /**
+     * Instance host name.
+     */
     hostname: string;
-    /** Provide information on the Instance image. */
+    /**
+     * Provide information on the Instance image.
+     */
     image?: Image;
-    /** Instance protection option is activated. */
+    /**
+     * Instance protection option is activated.
+     */
     protected: boolean;
     /**
-     * @deprecated Instance private IP address (deprecated and always `null` when
-     *   `routed_ip_enabled` is `True`).
+     * @deprecated Instance private IP address (deprecated and always `null` when `routed_ip_enabled` is `True`).
      */
     privateIp?: string;
     /**
-     * @deprecated Information about the public IP (deprecated in favor of
-     *   `public_ips`).
+     * @deprecated Information about the public IP (deprecated in favor of `public_ips`).
      */
     publicIp?: ServerIp;
-    /** Information about all the public IPs attached to the server. */
+    /**
+     * Information about all the public IPs attached to the server.
+     */
     publicIps?: ServerIp[];
-    /** Instance modification date. */
+    /**
+     * Instance modification date.
+     */
     modificationDate?: Date;
-    /** Instance state. */
+    /**
+     * Instance state.
+     */
     state?: ServerState;
-    /** Instance location. */
+    /**
+     * Instance location.
+     */
     location?: ServerLocation;
     /**
-     * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is
-     *   `True`).
+     * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`).
      */
     ipv6?: ServerIpv6;
-    /** Instance boot type. */
+    /**
+     * Instance boot type.
+     */
     bootType?: BootType;
-    /** Instance volumes. */
+    /**
+     * Instance volumes.
+     */
     volumes?: Record<string, Volume>;
-    /** Instance security group. */
+    /**
+     * Instance security group.
+     */
     securityGroup?: SecurityGroupSummary;
-    /** Instance planned maintenances. */
+    /**
+     * Instance planned maintenances.
+     */
     maintenances?: ServerMaintenance[];
-    /** Instance state_detail. */
+    /**
+     * Instance state_detail.
+     */
     stateDetail: string;
     /**
-     * Instance architecture (refers to the CPU architecture used for the
-     * Instance, e.g. x86_64, arm64).
+     * Instance architecture (refers to the CPU architecture used for the Instance, e.g. x86_64, arm64).
      */
     arch?: Arch;
-    /** Instance placement group. */
+    /**
+     * Instance placement group.
+     */
     placementGroup?: PlacementGroup;
-    /** Instance private NICs. */
+    /**
+     * Instance private NICs.
+     */
     privateNics?: PrivateNIC[];
     /**
-     * The public_key value of this key is used to encrypt the admin password.
-     * When set to an empty string, reset this value and
-     * admin_password_encrypted_value to an empty string so a new password may be
-     * generated.
+     * The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.
      */
     adminPasswordEncryptionSshKeyId?: string;
 };
@@ -152,7 +222,9 @@ export interface SetServerResponse {
     server?: Server;
 }
 export type SetSnapshotRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
     snapshotId: string;
     id: string;

package/dist/api/interlink/v1beta1/api.gen.cjs

@@ -41,10 +41,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListDedicatedConnectionsResponse
   );
   /**
-   * List dedicated connections. For self-hosted users, list their dedicated
-   * physical connections in a given region. By default, the connections
-   * returned in the list are ordered by name in ascending order, though this
-   * can be modified via the `order_by` field.
+   * List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
    *
    * @param request - The request {@link ListDedicatedConnectionsRequest}
    * @returns A Promise of ListDedicatedConnectionsResponse
@@ -55,9 +52,7 @@ class API extends api.API {
     request
   );
   /**
-   * Get a dedicated connection. For self-hosted users, get a dedicated physical
-   * connection corresponding to the given ID. The response object includes
-   * information such as the connection's name, status and total bandwidth.
+   * Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection's name, status and total bandwidth.
    *
    * @param request - The request {@link GetDedicatedConnectionRequest}
    * @returns A Promise of DedicatedConnection
@@ -103,18 +98,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListPartnersResponse
   );
   /**
-   * List available partners. List all available partners. By default, the
-   * partners returned in the list are ordered by name in ascending order,
-   * though this can be modified via the `order_by` field.
+   * List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
    *
    * @param request - The request {@link ListPartnersRequest}
    * @returns A Promise of ListPartnersResponse
    */
   listPartners = (request = {}) => resourcePaginator.enrichForPagination("partners", this.pageOfListPartners, request);
   /**
-   * Get a partner. Get a partner for the given partner IP. The response object
-   * includes information such as the partner's name, email address and portal
-   * URL.
+   * Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL.
    *
    * @param request - The request {@link GetPartnerRequest}
    * @returns A Promise of Partner
@@ -147,16 +138,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListPopsResponse
   );
   /**
-   * List PoPs. List all available PoPs (locations) for a given region. By
-   * default, the results are returned in ascending alphabetical order by name.
+   * List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name.
    *
    * @param request - The request {@link ListPopsRequest}
    * @returns A Promise of ListPopsResponse
    */
   listPops = (request = {}) => resourcePaginator.enrichForPagination("pops", this.pageOfListPops, request);
   /**
-   * Get a PoP. Get a PoP for the given PoP ID. The response object includes the
-   * PoP's name and information about its physical location.
+   * Get a PoP. Get a PoP for the given PoP ID. The response object includes the PoP's name and information about its physical location.
    *
    * @param request - The request {@link GetPopRequest}
    * @returns A Promise of Pop
@@ -199,17 +188,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListLinksResponse
   );
   /**
-   * List links. List all your links (InterLink connections). A number of
-   * filters are available, including Project ID, name, tags and status.
+   * List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status.
    *
    * @param request - The request {@link ListLinksRequest}
    * @returns A Promise of ListLinksResponse
    */
   listLinks = (request = {}) => resourcePaginator.enrichForPagination("links", this.pageOfListLinks, request);
   /**
-   * Get a link. Get a link (InterLink session / logical InterLink resource) for
-   * the given link ID. The response object includes information about the
-   * link's various configuration details.
+   * Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link's various configuration details.
    *
    * @param request - The request {@link GetLinkRequest}
    * @returns A Promise of Link
@@ -237,11 +223,7 @@ class API extends api.API {
     options
   );
   /**
-   * Create a link. Create a link (InterLink session / logical InterLink
-   * resource) in a given PoP, specifying its various configuration details.
-   * Links can either be hosted (faciliated by partners' shared physical
-   * connections) or self-hosted (for users who have purchased a dedicated
-   * physical connection).
+   * Create a link. Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
    *
    * @param request - The request {@link CreateLinkRequest}
    * @returns A Promise of Link
@@ -258,8 +240,7 @@ class API extends api.API {
     marshalling_gen.unmarshalLink
   );
   /**
-   * Update a link. Update an existing link, specified by its link ID. Only its
-   * name and tags can be updated.
+   * Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated.
    *
    * @param request - The request {@link UpdateLinkRequest}
    * @returns A Promise of Link
@@ -276,11 +257,7 @@ class API extends api.API {
     marshalling_gen.unmarshalLink
   );
   /**
-   * Delete a link. Delete an existing link, specified by its link ID. Note that
-   * as well as deleting the link here on the Scaleway side, it is also
-   * necessary to request deletion from the partner on their side. Only when
-   * this action has been carried out on both sides will the resource be
-   * completely deleted.
+   * Delete a link. Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted.
    *
    * @param request - The request {@link DeleteLinkRequest}
    * @returns A Promise of Link
@@ -293,9 +270,7 @@ class API extends api.API {
     marshalling_gen.unmarshalLink
   );
   /**
-   * Attach a VPC. Attach a VPC to an existing link. This facilitates
-   * communication between the resources in your Scaleway VPC, and your
-   * on-premises infrastructure.
+   * Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.
    *
    * @param request - The request {@link AttachVpcRequest}
    * @returns A Promise of Link
@@ -327,10 +302,7 @@ class API extends api.API {
     marshalling_gen.unmarshalLink
   );
   /**
-   * Attach a routing policy. Attach a routing policy to an existing link. As
-   * all routes across the link are blocked by default, you must attach a
-   * routing policy to set IP prefix filters for allowed routes, facilitating
-   * traffic flow.
+   * Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.
    *
    * @param request - The request {@link AttachRoutingPolicyRequest}
    * @returns A Promise of Link
@@ -347,9 +319,7 @@ class API extends api.API {
     marshalling_gen.unmarshalLink
   );
   /**
-   * Detach a routing policy. Detach a routing policy from an existing link.
-   * Without a routing policy, all routes across the link are blocked by
-   * default.
+   * Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.
    *
    * @param request - The request {@link DetachRoutingPolicyRequest}
    * @returns A Promise of Link
@@ -364,12 +334,7 @@ class API extends api.API {
     marshalling_gen.unmarshalLink
   );
   /**
-   * Enable route propagation. Enable all allowed prefixes (defined in a routing
-   * policy) to be announced in the BGP session. This allows traffic to flow
-   * between the attached VPC and the on-premises infrastructure along the
-   * announced routes. Note that by default, even when route propagation is
-   * enabled, all routes are blocked. It is essential to attach a routing policy
-   * to define the ranges of routes to announce.
+   * Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.
    *
    * @param request - The request {@link EnableRoutePropagationRequest}
    * @returns A Promise of Link
@@ -384,9 +349,7 @@ class API extends api.API {
     marshalling_gen.unmarshalLink
   );
   /**
-   * Disable route propagation. Prevent any prefixes from being announced in the
-   * BGP session. Traffic will not be able to flow over the InterLink until
-   * route propagation is re-enabled.
+   * Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.
    *
    * @param request - The request {@link DisableRoutePropagationRequest}
    * @returns A Promise of Link
@@ -420,9 +383,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListRoutingPoliciesResponse
   );
   /**
-   * List routing policies. List all routing policies in a given region. A
-   * routing policy can be attached to one or multiple links (InterLink
-   * connections).
+   * List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections).
    *
    * @param request - The request {@link ListRoutingPoliciesRequest}
    * @returns A Promise of ListRoutingPoliciesResponse
@@ -433,9 +394,7 @@ class API extends api.API {
     request
   );
   /**
-   * Get routing policy. Get a routing policy for the given routing policy ID.
-   * The response object gives information including the policy's name, tags and
-   * prefix filters.
+   * Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.
    *
    * @param request - The request {@link GetRoutingPolicyRequest}
    * @returns A Promise of RoutingPolicy
@@ -448,9 +407,7 @@ class API extends api.API {
     marshalling_gen.unmarshalRoutingPolicy
   );
   /**
-   * Create a routing policy. Create a routing policy. Routing policies allow
-   * you to set IP prefix filters to define the incoming route announcements to
-   * accept from the peer, and the outgoing routes to announce to the peer.
+   * Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer.
    *
    * @param request - The request {@link CreateRoutingPolicyRequest}
    * @returns A Promise of RoutingPolicy
@@ -467,9 +424,7 @@ class API extends api.API {
     marshalling_gen.unmarshalRoutingPolicy
   );
   /**
-   * Update a routing policy. Update an existing routing policy, specified by
-   * its routing policy ID. Its name, tags and incoming/outgoing prefix filters
-   * can be updated.
+   * Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.
    *
    * @param request - The request {@link UpdateRoutingPolicyRequest}
    * @returns A Promise of RoutingPolicy
@@ -486,8 +441,7 @@ class API extends api.API {
     marshalling_gen.unmarshalRoutingPolicy
   );
   /**
-   * Delete a routing policy. Delete an existing routing policy, specified by
-   * its routing policy ID.
+   * Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID.
    *
    * @param request - The request {@link DeleteRoutingPolicyRequest}
    */