@scaleway/sdk-s2s-vpn 1.1.0

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

@@ -0,0 +1,222 @@
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
+import type { Connection, CreateConnectionRequest, CreateConnectionResponse, CreateCustomerGatewayRequest, CreateRoutingPolicyRequest, CreateVpnGatewayRequest, CustomerGateway, DeleteConnectionRequest, DeleteCustomerGatewayRequest, DeleteRoutingPolicyRequest, DeleteVpnGatewayRequest, DetachRoutingPolicyRequest, DisableRoutePropagationRequest, EnableRoutePropagationRequest, GetConnectionRequest, GetCustomerGatewayRequest, GetRoutingPolicyRequest, GetVpnGatewayRequest, ListConnectionsRequest, ListConnectionsResponse, ListCustomerGatewaysRequest, ListCustomerGatewaysResponse, ListRoutingPoliciesRequest, ListRoutingPoliciesResponse, ListVpnGatewayTypesRequest, ListVpnGatewayTypesResponse, ListVpnGatewaysRequest, ListVpnGatewaysResponse, RenewConnectionPskRequest, RenewConnectionPskResponse, RoutingPolicy, SetRoutingPolicyRequest, UpdateConnectionRequest, UpdateCustomerGatewayRequest, UpdateRoutingPolicyRequest, UpdateVpnGatewayRequest, VpnGateway } from './types.gen.js';
+/**
+ * Site-to-Site VPN.
+
+This API allows you to manage your Site-to-Site VPN.
+ */
+export declare class API extends ParentAPI {
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
+    protected pageOfListVpnGatewayTypes: (request?: Readonly<ListVpnGatewayTypesRequest>) => Promise<ListVpnGatewayTypesResponse>;
+    /**
+     * List VPN gateway types. List the different VPN gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available VPN gateway type.
+     *
+     * @param request - The request {@link ListVpnGatewayTypesRequest}
+     * @returns A Promise of ListVpnGatewayTypesResponse
+     */
+    listVpnGatewayTypes: (request?: Readonly<ListVpnGatewayTypesRequest>) => Promise<ListVpnGatewayTypesResponse> & {
+        all: () => Promise<import("./types.gen.js").GatewayType[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").GatewayType[], void, void>;
+    };
+    protected pageOfListVpnGateways: (request?: Readonly<ListVpnGatewaysRequest>) => Promise<ListVpnGatewaysResponse>;
+    /**
+     * List VPN gateways. List all your VPN gateways. A number of filters are available, including Project ID, name, tags and status.
+     *
+     * @param request - The request {@link ListVpnGatewaysRequest}
+     * @returns A Promise of ListVpnGatewaysResponse
+     */
+    listVpnGateways: (request?: Readonly<ListVpnGatewaysRequest>) => Promise<ListVpnGatewaysResponse> & {
+        all: () => Promise<VpnGateway[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<VpnGateway[], void, void>;
+    };
+    /**
+     * Get a VPN gateway. Get a VPN gateway for the given VPN gateway ID.
+     *
+     * @param request - The request {@link GetVpnGatewayRequest}
+     * @returns A Promise of VpnGateway
+     */
+    getVpnGateway: (request: Readonly<GetVpnGatewayRequest>) => Promise<VpnGateway>;
+    /**
+     * Waits for {@link VpnGateway} to be in a final state.
+     *
+     * @param request - The request {@link GetVpnGatewayRequest}
+     * @param options - The waiting options
+     * @returns A Promise of VpnGateway
+     */
+    waitForVpnGateway: (request: Readonly<GetVpnGatewayRequest>, options?: Readonly<WaitForOptions<VpnGateway>>) => Promise<VpnGateway>;
+    /**
+     * Create VPN gateway.
+     *
+     * @param request - The request {@link CreateVpnGatewayRequest}
+     * @returns A Promise of VpnGateway
+     */
+    createVpnGateway: (request: Readonly<CreateVpnGatewayRequest>) => Promise<VpnGateway>;
+    /**
+     * Update a VPN gateway. Update an existing VPN gateway, specified by its VPN gateway ID. Only its name and tags can be updated.
+     *
+     * @param request - The request {@link UpdateVpnGatewayRequest}
+     * @returns A Promise of VpnGateway
+     */
+    updateVpnGateway: (request: Readonly<UpdateVpnGatewayRequest>) => Promise<VpnGateway>;
+    /**
+     * Delete a VPN gateway. Delete an existing VPN gateway, specified by its VPN gateway ID.
+     *
+     * @param request - The request {@link DeleteVpnGatewayRequest}
+     * @returns A Promise of VpnGateway
+     */
+    deleteVpnGateway: (request: Readonly<DeleteVpnGatewayRequest>) => Promise<VpnGateway>;
+    protected pageOfListConnections: (request?: Readonly<ListConnectionsRequest>) => Promise<ListConnectionsResponse>;
+    /**
+     * List connections. List all your connections. A number of filters are available, including Project ID, name, tags and status.
+     *
+     * @param request - The request {@link ListConnectionsRequest}
+     * @returns A Promise of ListConnectionsResponse
+     */
+    listConnections: (request?: Readonly<ListConnectionsRequest>) => Promise<ListConnectionsResponse> & {
+        all: () => Promise<Connection[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Connection[], void, void>;
+    };
+    /**
+     * Get a connection. Get a connection for the given connection ID. The response object includes information about the connection's various configuration details.
+     *
+     * @param request - The request {@link GetConnectionRequest}
+     * @returns A Promise of Connection
+     */
+    getConnection: (request: Readonly<GetConnectionRequest>) => Promise<Connection>;
+    /**
+     * Create a connection.
+     *
+     * @param request - The request {@link CreateConnectionRequest}
+     * @returns A Promise of CreateConnectionResponse
+     */
+    createConnection: (request: Readonly<CreateConnectionRequest>) => Promise<CreateConnectionResponse>;
+    /**
+     * Update a connection. Update an existing connection, specified by its connection ID.
+     *
+     * @param request - The request {@link UpdateConnectionRequest}
+     * @returns A Promise of Connection
+     */
+    updateConnection: (request: Readonly<UpdateConnectionRequest>) => Promise<Connection>;
+    /**
+     * Delete a connection. Delete an existing connection, specified by its connection ID.
+     *
+     * @param request - The request {@link DeleteConnectionRequest}
+     */
+    deleteConnection: (request: Readonly<DeleteConnectionRequest>) => Promise<void>;
+    /**
+     * Renew pre-shared key. Renew pre-shared key for a given connection.
+     *
+     * @param request - The request {@link RenewConnectionPskRequest}
+     * @returns A Promise of RenewConnectionPskResponse
+     */
+    renewConnectionPsk: (request: Readonly<RenewConnectionPskRequest>) => Promise<RenewConnectionPskResponse>;
+    /**
+     * Set a new routing policy. Set a new routing policy on a connection, overriding the existing one if present, specified by its connection ID.
+     *
+     * @param request - The request {@link SetRoutingPolicyRequest}
+     * @returns A Promise of Connection
+     */
+    setRoutingPolicy: (request: Readonly<SetRoutingPolicyRequest>) => Promise<Connection>;
+    /**
+     * Detach a routing policy. Detach an existing routing policy from a connection, specified by its connection ID.
+     *
+     * @param request - The request {@link DetachRoutingPolicyRequest}
+     * @returns A Promise of Connection
+     */
+    detachRoutingPolicy: (request: Readonly<DetachRoutingPolicyRequest>) => Promise<Connection>;
+    /**
+     * 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 Connection
+     */
+    enableRoutePropagation: (request: Readonly<EnableRoutePropagationRequest>) => Promise<Connection>;
+    /**
+     * Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the VPN Gateway until route propagation is re-enabled.
+     *
+     * @param request - The request {@link DisableRoutePropagationRequest}
+     * @returns A Promise of Connection
+     */
+    disableRoutePropagation: (request: Readonly<DisableRoutePropagationRequest>) => Promise<Connection>;
+    protected pageOfListCustomerGateways: (request?: Readonly<ListCustomerGatewaysRequest>) => Promise<ListCustomerGatewaysResponse>;
+    /**
+     * List customer gateways. List all your customer gateways. A number of filters are available, including Project ID, name, and tags.
+     *
+     * @param request - The request {@link ListCustomerGatewaysRequest}
+     * @returns A Promise of ListCustomerGatewaysResponse
+     */
+    listCustomerGateways: (request?: Readonly<ListCustomerGatewaysRequest>) => Promise<ListCustomerGatewaysResponse> & {
+        all: () => Promise<CustomerGateway[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<CustomerGateway[], void, void>;
+    };
+    /**
+     * Get a customer gateway. Get a customer gateway for the given customer gateway ID.
+     *
+     * @param request - The request {@link GetCustomerGatewayRequest}
+     * @returns A Promise of CustomerGateway
+     */
+    getCustomerGateway: (request: Readonly<GetCustomerGatewayRequest>) => Promise<CustomerGateway>;
+    /**
+     * Create a customer gateway.
+     *
+     * @param request - The request {@link CreateCustomerGatewayRequest}
+     * @returns A Promise of CustomerGateway
+     */
+    createCustomerGateway: (request: Readonly<CreateCustomerGatewayRequest>) => Promise<CustomerGateway>;
+    /**
+     * Update a customer gateway. Update an existing customer gateway, specified by its customer gateway ID. You can update its name, tags, public IPv4 & IPv6 address and AS Number.
+     *
+     * @param request - The request {@link UpdateCustomerGatewayRequest}
+     * @returns A Promise of CustomerGateway
+     */
+    updateCustomerGateway: (request: Readonly<UpdateCustomerGatewayRequest>) => Promise<CustomerGateway>;
+    /**
+     * Delete a customer gateway. Delete an existing customer gateway, specified by its customer gateway ID.
+     *
+     * @param request - The request {@link DeleteCustomerGatewayRequest}
+     */
+    deleteCustomerGateway: (request: Readonly<DeleteCustomerGatewayRequest>) => Promise<void>;
+    protected pageOfListRoutingPolicies: (request?: Readonly<ListRoutingPoliciesRequest>) => Promise<ListRoutingPoliciesResponse>;
+    /**
+     * List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple connections (S2S VPN connections).
+     *
+     * @param request - The request {@link ListRoutingPoliciesRequest}
+     * @returns A Promise of ListRoutingPoliciesResponse
+     */
+    listRoutingPolicies: (request?: Readonly<ListRoutingPoliciesRequest>) => Promise<ListRoutingPoliciesResponse> & {
+        all: () => Promise<RoutingPolicy[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<RoutingPolicy[], void, void>;
+    };
+    /**
+     * 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
+     */
+    getRoutingPolicy: (request: Readonly<GetRoutingPolicyRequest>) => Promise<RoutingPolicy>;
+    /**
+     * 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 customer gateway, and the outgoing routes to announce to the customer gateway.
+     *
+     * @param request - The request {@link CreateRoutingPolicyRequest}
+     * @returns A Promise of RoutingPolicy
+     */
+    createRoutingPolicy: (request: Readonly<CreateRoutingPolicyRequest>) => Promise<RoutingPolicy>;
+    /**
+     * 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
+     */
+    updateRoutingPolicy: (request: Readonly<UpdateRoutingPolicyRequest>) => Promise<RoutingPolicy>;
+    /**
+     * Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID.
+     *
+     * @param request - The request {@link DeleteRoutingPolicyRequest}
+     */
+    deleteRoutingPolicy: (request: Readonly<DeleteRoutingPolicyRequest>) => Promise<void>;
+}