Correspondents/node_modules/cloudflare/resources/magic-transit/routes.d.ts

import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
import * as RoutesAPI from "./routes.js";
export declare class Routes extends APIResource {
    /**
     * Creates a new Magic static route. Use `?validate_only=true` as an optional query
     * parameter to run validation only without persisting changes.
     *
     * @example
     * ```ts
     * const route = await client.magicTransit.routes.create({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   nexthop: '203.0.113.1',
     *   prefix: '192.0.2.0/24',
     *   priority: 0,
     * });
     * ```
     */
    create(params: RouteCreateParams, options?: Core.RequestOptions): Core.APIPromise<RouteCreateResponse>;
    /**
     * Update a specific Magic static route. Use `?validate_only=true` as an optional
     * query parameter to run validation only without persisting changes.
     *
     * @example
     * ```ts
     * const route = await client.magicTransit.routes.update(
     *   '023e105f4ecef8ad9ca31a8372d0c353',
     *   {
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *     nexthop: '203.0.113.1',
     *     prefix: '192.0.2.0/24',
     *     priority: 0,
     *   },
     * );
     * ```
     */
    update(routeId: string, params: RouteUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RouteUpdateResponse>;
    /**
     * List all Magic static routes.
     *
     * @example
     * ```ts
     * const routes = await client.magicTransit.routes.list({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    list(params: RouteListParams, options?: Core.RequestOptions): Core.APIPromise<RouteListResponse>;
    /**
     * Disable and remove a specific Magic static route.
     *
     * @example
     * ```ts
     * const route = await client.magicTransit.routes.delete(
     *   '023e105f4ecef8ad9ca31a8372d0c353',
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * );
     * ```
     */
    delete(routeId: string, params: RouteDeleteParams, options?: Core.RequestOptions): Core.APIPromise<RouteDeleteResponse>;
    /**
     * Update multiple Magic static routes. Use `?validate_only=true` as an optional
     * query parameter to run validation only without persisting changes. Only fields
     * for a route that need to be changed need be provided.
     *
     * @example
     * ```ts
     * const response =
     *   await client.magicTransit.routes.bulkUpdate({
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *     routes: [
     *       {
     *         id: '023e105f4ecef8ad9ca31a8372d0c353',
     *         nexthop: '203.0.113.1',
     *         prefix: '192.0.2.0/24',
     *         priority: 0,
     *       },
     *     ],
     *   });
     * ```
     */
    bulkUpdate(params: RouteBulkUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RouteBulkUpdateResponse>;
    /**
     * Delete multiple Magic static routes.
     *
     * @example
     * ```ts
     * const response = await client.magicTransit.routes.empty({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    empty(params: RouteEmptyParams, options?: Core.RequestOptions): Core.APIPromise<RouteEmptyResponse>;
    /**
     * Get a specific Magic static route.
     *
     * @example
     * ```ts
     * const route = await client.magicTransit.routes.get(
     *   '023e105f4ecef8ad9ca31a8372d0c353',
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * );
     * ```
     */
    get(routeId: string, params: RouteGetParams, options?: Core.RequestOptions): Core.APIPromise<RouteGetResponse>;
}
/**
 * Used only for ECMP routes.
 */
export interface Scope {
    /**
     * List of colo names for the ECMP scope.
     */
    colo_names?: Array<string>;
    /**
     * List of colo regions for the ECMP scope.
     */
    colo_regions?: Array<string>;
}
/**
 * Used only for ECMP routes.
 */
export interface ScopeParam {
    /**
     * List of colo names for the ECMP scope.
     */
    colo_names?: Array<string>;
    /**
     * List of colo regions for the ECMP scope.
     */
    colo_regions?: Array<string>;
}
export interface RouteCreateResponse {
    /**
     * Identifier
     */
    id: string;
    /**
     * The next-hop IP Address for the static route.
     */
    nexthop: string;
    /**
     * IP Prefix in Classless Inter-Domain Routing format.
     */
    prefix: string;
    /**
     * Priority of the static route.
     */
    priority: number;
    /**
     * When the route was created.
     */
    created_on?: string;
    /**
     * An optional human provided description of the static route.
     */
    description?: string;
    /**
     * When the route was last modified.
     */
    modified_on?: string;
    /**
     * Used only for ECMP routes.
     */
    scope?: Scope;
    /**
     * Optional weight of the ECMP scope - if provided.
     */
    weight?: number;
}
export interface RouteUpdateResponse {
    modified?: boolean;
    modified_route?: RouteUpdateResponse.ModifiedRoute;
}
export declare namespace RouteUpdateResponse {
    interface ModifiedRoute {
        /**
         * Identifier
         */
        id: string;
        /**
         * The next-hop IP Address for the static route.
         */
        nexthop: string;
        /**
         * IP Prefix in Classless Inter-Domain Routing format.
         */
        prefix: string;
        /**
         * Priority of the static route.
         */
        priority: number;
        /**
         * When the route was created.
         */
        created_on?: string;
        /**
         * An optional human provided description of the static route.
         */
        description?: string;
        /**
         * When the route was last modified.
         */
        modified_on?: string;
        /**
         * Used only for ECMP routes.
         */
        scope?: RoutesAPI.Scope;
        /**
         * Optional weight of the ECMP scope - if provided.
         */
        weight?: number;
    }
}
export interface RouteListResponse {
    routes?: Array<RouteListResponse.Route>;
}
export declare namespace RouteListResponse {
    interface Route {
        /**
         * Identifier
         */
        id: string;
        /**
         * The next-hop IP Address for the static route.
         */
        nexthop: string;
        /**
         * IP Prefix in Classless Inter-Domain Routing format.
         */
        prefix: string;
        /**
         * Priority of the static route.
         */
        priority: number;
        /**
         * When the route was created.
         */
        created_on?: string;
        /**
         * An optional human provided description of the static route.
         */
        description?: string;
        /**
         * When the route was last modified.
         */
        modified_on?: string;
        /**
         * Used only for ECMP routes.
         */
        scope?: RoutesAPI.Scope;
        /**
         * Optional weight of the ECMP scope - if provided.
         */
        weight?: number;
    }
}
export interface RouteDeleteResponse {
    deleted?: boolean;
    deleted_route?: RouteDeleteResponse.DeletedRoute;
}
export declare namespace RouteDeleteResponse {
    interface DeletedRoute {
        /**
         * Identifier
         */
        id: string;
        /**
         * The next-hop IP Address for the static route.
         */
        nexthop: string;
        /**
         * IP Prefix in Classless Inter-Domain Routing format.
         */
        prefix: string;
        /**
         * Priority of the static route.
         */
        priority: number;
        /**
         * When the route was created.
         */
        created_on?: string;
        /**
         * An optional human provided description of the static route.
         */
        description?: string;
        /**
         * When the route was last modified.
         */
        modified_on?: string;
        /**
         * Used only for ECMP routes.
         */
        scope?: RoutesAPI.Scope;
        /**
         * Optional weight of the ECMP scope - if provided.
         */
        weight?: number;
    }
}
export interface RouteBulkUpdateResponse {
    modified?: boolean;
    modified_routes?: Array<RouteBulkUpdateResponse.ModifiedRoute>;
}
export declare namespace RouteBulkUpdateResponse {
    interface ModifiedRoute {
        /**
         * Identifier
         */
        id: string;
        /**
         * The next-hop IP Address for the static route.
         */
        nexthop: string;
        /**
         * IP Prefix in Classless Inter-Domain Routing format.
         */
        prefix: string;
        /**
         * Priority of the static route.
         */
        priority: number;
        /**
         * When the route was created.
         */
        created_on?: string;
        /**
         * An optional human provided description of the static route.
         */
        description?: string;
        /**
         * When the route was last modified.
         */
        modified_on?: string;
        /**
         * Used only for ECMP routes.
         */
        scope?: RoutesAPI.Scope;
        /**
         * Optional weight of the ECMP scope - if provided.
         */
        weight?: number;
    }
}
export interface RouteEmptyResponse {
    deleted?: boolean;
    deleted_routes?: Array<RouteEmptyResponse.DeletedRoute>;
}
export declare namespace RouteEmptyResponse {
    interface DeletedRoute {
        /**
         * Identifier
         */
        id: string;
        /**
         * The next-hop IP Address for the static route.
         */
        nexthop: string;
        /**
         * IP Prefix in Classless Inter-Domain Routing format.
         */
        prefix: string;
        /**
         * Priority of the static route.
         */
        priority: number;
        /**
         * When the route was created.
         */
        created_on?: string;
        /**
         * An optional human provided description of the static route.
         */
        description?: string;
        /**
         * When the route was last modified.
         */
        modified_on?: string;
        /**
         * Used only for ECMP routes.
         */
        scope?: RoutesAPI.Scope;
        /**
         * Optional weight of the ECMP scope - if provided.
         */
        weight?: number;
    }
}
export interface RouteGetResponse {
    route?: RouteGetResponse.Route;
}
export declare namespace RouteGetResponse {
    interface Route {
        /**
         * Identifier
         */
        id: string;
        /**
         * The next-hop IP Address for the static route.
         */
        nexthop: string;
        /**
         * IP Prefix in Classless Inter-Domain Routing format.
         */
        prefix: string;
        /**
         * Priority of the static route.
         */
        priority: number;
        /**
         * When the route was created.
         */
        created_on?: string;
        /**
         * An optional human provided description of the static route.
         */
        description?: string;
        /**
         * When the route was last modified.
         */
        modified_on?: string;
        /**
         * Used only for ECMP routes.
         */
        scope?: RoutesAPI.Scope;
        /**
         * Optional weight of the ECMP scope - if provided.
         */
        weight?: number;
    }
}
export interface RouteCreateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: The next-hop IP Address for the static route.
     */
    nexthop: string;
    /**
     * Body param: IP Prefix in Classless Inter-Domain Routing format.
     */
    prefix: string;
    /**
     * Body param: Priority of the static route.
     */
    priority: number;
    /**
     * Body param: An optional human provided description of the static route.
     */
    description?: string;
    /**
     * Body param: Used only for ECMP routes.
     */
    scope?: ScopeParam;
    /**
     * Body param: Optional weight of the ECMP scope - if provided.
     */
    weight?: number;
}
export interface RouteUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: The next-hop IP Address for the static route.
     */
    nexthop: string;
    /**
     * Body param: IP Prefix in Classless Inter-Domain Routing format.
     */
    prefix: string;
    /**
     * Body param: Priority of the static route.
     */
    priority: number;
    /**
     * Body param: An optional human provided description of the static route.
     */
    description?: string;
    /**
     * Body param: Used only for ECMP routes.
     */
    scope?: ScopeParam;
    /**
     * Body param: Optional weight of the ECMP scope - if provided.
     */
    weight?: number;
}
export interface RouteListParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface RouteDeleteParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface RouteBulkUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    routes: Array<RouteBulkUpdateParams.Route>;
}
export declare namespace RouteBulkUpdateParams {
    interface Route {
        /**
         * Identifier
         */
        id: string;
        /**
         * The next-hop IP Address for the static route.
         */
        nexthop: string;
        /**
         * IP Prefix in Classless Inter-Domain Routing format.
         */
        prefix: string;
        /**
         * Priority of the static route.
         */
        priority: number;
        /**
         * An optional human provided description of the static route.
         */
        description?: string;
        /**
         * Used only for ECMP routes.
         */
        scope?: RoutesAPI.ScopeParam;
        /**
         * Optional weight of the ECMP scope - if provided.
         */
        weight?: number;
    }
}
export interface RouteEmptyParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface RouteGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export declare namespace Routes {
    export { type Scope as Scope, type RouteCreateResponse as RouteCreateResponse, type RouteUpdateResponse as RouteUpdateResponse, type RouteListResponse as RouteListResponse, type RouteDeleteResponse as RouteDeleteResponse, type RouteBulkUpdateResponse as RouteBulkUpdateResponse, type RouteEmptyResponse as RouteEmptyResponse, type RouteGetResponse as RouteGetResponse, type RouteCreateParams as RouteCreateParams, type RouteUpdateParams as RouteUpdateParams, type RouteListParams as RouteListParams, type RouteDeleteParams as RouteDeleteParams, type RouteBulkUpdateParams as RouteBulkUpdateParams, type RouteEmptyParams as RouteEmptyParams, type RouteGetParams as RouteGetParams, };
}
//# sourceMappingURL=routes.d.ts.map