telnyx 7.27.0 → 7.29.0

package/resources/network-routes.d.ts

@@ -0,0 +1,257 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Routes on a Network that send a CIDR to a next hop, such as a tunnel.
+ */
+export declare class NetworkRoutes extends APIResource {
+    /**
+     * Lists the routes of the account's Networks. A Network's list is its effective
+     * route table: the routes added with `POST /network_routes` (`origin` `static`)
+     * and the routes that its attachments install (`origin` `attachment`). Lookup is
+     * longest prefix within the Network.
+     *
+     * @example
+     * ```ts
+     * const networkRoutes = await client.networkRoutes.list({
+     *   filter: {
+     *     network_id: '91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24',
+     *   },
+     * });
+     * ```
+     */
+    list(query: NetworkRouteListParams, options?: RequestOptions): APIPromise<NetworkRouteListResponse>;
+    /**
+     * Adds a route to a Network. Traffic on the Network to an address in `cidr` goes
+     * via `next_hop`. With a tunnel as the next hop, functions on the Network reach
+     * the CIDR through the tunnel without a redeploy. A Network holds each CIDR once.
+     *
+     * @example
+     * ```ts
+     * const networkRoute = await client.networkRoutes.create({
+     *   cidr: '10.20.0.0/16',
+     *   network_id: '91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24',
+     *   next_hop: {
+     *     type: 'tunnel',
+     *     id: '62d438d2-8a51-4c5e-9d0c-1f6b2a7e4c39',
+     *   },
+     * });
+     * ```
+     */
+    create(body: NetworkRouteCreateParams, options?: RequestOptions): APIPromise<NetworkRouteCreateResponse>;
+    /**
+     * Deletes a route that was added with `POST /network_routes`. Traffic to its CIDR
+     * stops going via the next hop at once. Routes that an attachment installs
+     * (`origin` `attachment`) leave with the attachment and cannot be deleted here.
+     *
+     * @example
+     * ```ts
+     * await client.networkRoutes.delete(
+     *   'e8a2c5d0-3f7b-4a19-b6d2-9c1e0f8a7b53',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Retrieves a route and its status.
+     *
+     * @example
+     * ```ts
+     * const networkRoute = await client.networkRoutes.retrieve(
+     *   'e8a2c5d0-3f7b-4a19-b6d2-9c1e0f8a7b53',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<NetworkRouteRetrieveResponse>;
+}
+export interface NetappsCursorPaginationMeta {
+    /**
+     * Opaque cursors. Absent keys mean there is no such page.
+     */
+    cursors?: NetappsCursorPaginationMeta.Cursors;
+    /**
+     * The path of the next page, with the same query parameters. Absent on the last
+     * page.
+     */
+    next?: string;
+    /**
+     * The path of the previous page. Present when the request used `page[after]`.
+     */
+    previous?: string;
+}
+export declare namespace NetappsCursorPaginationMeta {
+    /**
+     * Opaque cursors. Absent keys mean there is no such page.
+     */
+    interface Cursors {
+        /**
+         * Pass as `page[after]` to fetch the next page. Absent on the last page.
+         */
+        after?: string;
+        /**
+         * The cursor of the previous page. Present when the request used `page[after]`.
+         */
+        before?: string;
+    }
+}
+export interface NetworkRoute {
+    /**
+     * Identifies the resource.
+     */
+    id?: string;
+    /**
+     * The IPv4 CIDR the route covers.
+     */
+    cidr?: string;
+    /**
+     * ISO 8601 formatted date-time indicating when the resource was created.
+     */
+    created_at?: string;
+    /**
+     * The id of the Network the route belongs to.
+     */
+    network_id?: string;
+    /**
+     * Where the Network sends traffic for the route's CIDR.
+     */
+    next_hop?: NetworkRoute.NextHop;
+    /**
+     * `static` for a route added with `POST /network_routes`, `attachment` for a route
+     * that another resource installed and removes.
+     */
+    origin?: 'static' | 'attachment';
+    /**
+     * Identifies the type of the resource.
+     */
+    record_type?: string;
+    /**
+     * `pending` until Telnyx installs the route on the Network, then `active`.
+     * `inactive` while a tunnel next hop has no connected process. `failed` (Preview,
+     * not reported yet) when Telnyx could not install the route.
+     */
+    status?: 'pending' | 'active' | 'inactive' | 'failed';
+}
+export declare namespace NetworkRoute {
+    /**
+     * Where the Network sends traffic for the route's CIDR.
+     */
+    interface NextHop {
+        /**
+         * The id of the tunnel or attachment.
+         */
+        id: string;
+        /**
+         * The type of the next hop. Routes added with `POST /network_routes` use `tunnel`.
+         * Routes that attachments install carry the attachment's type.
+         */
+        type: 'tunnel' | 'wireguard_peer' | 'wireguard_interface' | 'private_wireless_gateway' | 'virtual_cross_connect' | 'ipsec_tunnel' | 'public_internet_gateway';
+    }
+}
+export interface NetworkRouteCreateResponse {
+    data?: NetworkRoute;
+}
+export interface NetworkRouteRetrieveResponse {
+    data?: NetworkRoute;
+}
+export interface NetworkRouteListResponse {
+    data?: Array<NetworkRoute>;
+    meta?: NetappsCursorPaginationMeta;
+}
+export interface NetworkRouteListParams {
+    /**
+     * Consolidated filter parameter (deepObject style). Originally:
+     * filter[network_id], filter[origin], filter[next_hop.type], filter[cidr],
+     * filter[status]
+     */
+    filter: NetworkRouteListParams.Filter;
+    /**
+     * Consolidated page parameter (deepObject style). Originally: page[after],
+     * page[limit]
+     */
+    page?: NetworkRouteListParams.Page;
+    /**
+     * Sorts the results by a field, ascending, or descending with a leading `-`. The
+     * default is `-created_at`.
+     */
+    sort?: 'cidr' | '-cidr' | 'status' | '-status' | 'created_at' | '-created_at';
+}
+export declare namespace NetworkRouteListParams {
+    /**
+     * Consolidated filter parameter (deepObject style). Originally:
+     * filter[network_id], filter[origin], filter[next_hop.type], filter[cidr],
+     * filter[status]
+     */
+    interface Filter {
+        /**
+         * The id of the Network whose route table is returned. Required.
+         */
+        network_id: string;
+        /**
+         * Only routes with this CIDR.
+         */
+        cidr?: string;
+        /**
+         * Only routes whose next hop has this type.
+         */
+        'next_hop.type'?: 'tunnel' | 'wireguard_peer' | 'wireguard_interface' | 'private_wireless_gateway' | 'virtual_cross_connect' | 'ipsec_tunnel' | 'public_internet_gateway';
+        /**
+         * Only routes of this origin.
+         */
+        origin?: 'static' | 'attachment';
+        /**
+         * Only routes with this status.
+         */
+        status?: 'pending' | 'active' | 'inactive' | 'failed';
+    }
+    /**
+     * Consolidated page parameter (deepObject style). Originally: page[after],
+     * page[limit]
+     */
+    interface Page {
+        /**
+         * The cursor from `meta.cursors.after` of the previous page.
+         */
+        after?: string;
+        /**
+         * The number of results per page.
+         */
+        limit?: number;
+    }
+}
+export interface NetworkRouteCreateParams {
+    /**
+     * The IPv4 subnet to route, such as a subnet behind the tunnel. It must be a
+     * canonical CIDR. Default, loopback, link-local, multicast, and shared address
+     * space (`100.64.0.0/10`) ranges are rejected. So are ranges that overlap the
+     * Tailscale Subnet Router ranges, `172.27.254.0/24` and `198.18.0.0/20`, or a
+     * subnet already on the Network.
+     */
+    cidr: string;
+    /**
+     * The id of the Network to add the route to.
+     */
+    network_id: string;
+    /**
+     * Where the Network sends traffic for `cidr`.
+     */
+    next_hop: NetworkRouteCreateParams.NextHop;
+}
+export declare namespace NetworkRouteCreateParams {
+    /**
+     * Where the Network sends traffic for `cidr`.
+     */
+    interface NextHop {
+        /**
+         * The id of the tunnel.
+         */
+        id: string;
+        /**
+         * The type of the next hop.
+         */
+        type: 'tunnel';
+    }
+}
+export declare namespace NetworkRoutes {
+    export { type NetappsCursorPaginationMeta as NetappsCursorPaginationMeta, type NetworkRoute as NetworkRoute, type NetworkRouteCreateResponse as NetworkRouteCreateResponse, type NetworkRouteRetrieveResponse as NetworkRouteRetrieveResponse, type NetworkRouteListResponse as NetworkRouteListResponse, type NetworkRouteListParams as NetworkRouteListParams, type NetworkRouteCreateParams as NetworkRouteCreateParams, };
+}
+//# sourceMappingURL=network-routes.d.ts.map

package/resources/network-routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-routes.d.ts","sourceRoot":"","sources":["../src/resources/network-routes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAInG;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIxG;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;CAGzF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE9C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;CACvD;AAED,yBAAiB,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,IAAI,EACA,QAAQ,GACR,gBAAgB,GAChB,qBAAqB,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,cAAc,GACd,yBAAyB,CAAC;KAC/B;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE3B,IAAI,CAAC,EAAE,2BAA2B,CAAC;CACpC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEtC;;;OAGG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAEnC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,GAAG,aAAa,CAAC;CAC/E;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;;OAIG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,eAAe,CAAC,EACZ,QAAQ,GACR,gBAAgB,GAChB,qBAAqB,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,cAAc,GACd,yBAAyB,CAAC;QAE9B;;WAEG;QACH,MAAM,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;QAEjC;;WAEG;QACH,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;KACvD;IAED;;;OAGG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,wBAAwB,CAAC,OAAO,CAAC;CAC5C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;KAChB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/network-routes.js

@@ -0,0 +1,83 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkRoutes = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Routes on a Network that send a CIDR to a next hop, such as a tunnel.
+ */
+class NetworkRoutes extends resource_1.APIResource {
+    /**
+     * Lists the routes of the account's Networks. A Network's list is its effective
+     * route table: the routes added with `POST /network_routes` (`origin` `static`)
+     * and the routes that its attachments install (`origin` `attachment`). Lookup is
+     * longest prefix within the Network.
+     *
+     * @example
+     * ```ts
+     * const networkRoutes = await client.networkRoutes.list({
+     *   filter: {
+     *     network_id: '91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24',
+     *   },
+     * });
+     * ```
+     */
+    list(query, options) {
+        return this._client.get('/network_routes', { query, ...options });
+    }
+    /**
+     * Adds a route to a Network. Traffic on the Network to an address in `cidr` goes
+     * via `next_hop`. With a tunnel as the next hop, functions on the Network reach
+     * the CIDR through the tunnel without a redeploy. A Network holds each CIDR once.
+     *
+     * @example
+     * ```ts
+     * const networkRoute = await client.networkRoutes.create({
+     *   cidr: '10.20.0.0/16',
+     *   network_id: '91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24',
+     *   next_hop: {
+     *     type: 'tunnel',
+     *     id: '62d438d2-8a51-4c5e-9d0c-1f6b2a7e4c39',
+     *   },
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/network_routes', { body, ...options });
+    }
+    /**
+     * Deletes a route that was added with `POST /network_routes`. Traffic to its CIDR
+     * stops going via the next hop at once. Routes that an attachment installs
+     * (`origin` `attachment`) leave with the attachment and cannot be deleted here.
+     *
+     * @example
+     * ```ts
+     * await client.networkRoutes.delete(
+     *   'e8a2c5d0-3f7b-4a19-b6d2-9c1e0f8a7b53',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/network_routes/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Retrieves a route and its status.
+     *
+     * @example
+     * ```ts
+     * const networkRoute = await client.networkRoutes.retrieve(
+     *   'e8a2c5d0-3f7b-4a19-b6d2-9c1e0f8a7b53',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/network_routes/${id}`, options);
+    }
+}
+exports.NetworkRoutes = NetworkRoutes;
+//# sourceMappingURL=network-routes.js.map

package/resources/network-routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-routes.js","sourceRoot":"","sources":["../src/resources/network-routes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAA6B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAzED,sCAyEC"}

package/resources/network-routes.mjs

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Routes on a Network that send a CIDR to a next hop, such as a tunnel.
+ */
+export class NetworkRoutes extends APIResource {
+    /**
+     * Lists the routes of the account's Networks. A Network's list is its effective
+     * route table: the routes added with `POST /network_routes` (`origin` `static`)
+     * and the routes that its attachments install (`origin` `attachment`). Lookup is
+     * longest prefix within the Network.
+     *
+     * @example
+     * ```ts
+     * const networkRoutes = await client.networkRoutes.list({
+     *   filter: {
+     *     network_id: '91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24',
+     *   },
+     * });
+     * ```
+     */
+    list(query, options) {
+        return this._client.get('/network_routes', { query, ...options });
+    }
+    /**
+     * Adds a route to a Network. Traffic on the Network to an address in `cidr` goes
+     * via `next_hop`. With a tunnel as the next hop, functions on the Network reach
+     * the CIDR through the tunnel without a redeploy. A Network holds each CIDR once.
+     *
+     * @example
+     * ```ts
+     * const networkRoute = await client.networkRoutes.create({
+     *   cidr: '10.20.0.0/16',
+     *   network_id: '91446ee3-5b1c-4f0e-8d2a-6c7e9b0a1f24',
+     *   next_hop: {
+     *     type: 'tunnel',
+     *     id: '62d438d2-8a51-4c5e-9d0c-1f6b2a7e4c39',
+     *   },
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/network_routes', { body, ...options });
+    }
+    /**
+     * Deletes a route that was added with `POST /network_routes`. Traffic to its CIDR
+     * stops going via the next hop at once. Routes that an attachment installs
+     * (`origin` `attachment`) leave with the attachment and cannot be deleted here.
+     *
+     * @example
+     * ```ts
+     * await client.networkRoutes.delete(
+     *   'e8a2c5d0-3f7b-4a19-b6d2-9c1e0f8a7b53',
+     * );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/network_routes/${id}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Retrieves a route and its status.
+     *
+     * @example
+     * ```ts
+     * const networkRoute = await client.networkRoutes.retrieve(
+     *   'e8a2c5d0-3f7b-4a19-b6d2-9c1e0f8a7b53',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/network_routes/${id}`, options);
+    }
+}
+//# sourceMappingURL=network-routes.mjs.map

package/resources/network-routes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-routes.mjs","sourceRoot":"","sources":["../src/resources/network-routes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAA6B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA8B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF"}

package/resources/number-lookup.d.mts

@@ -15,12 +15,22 @@ export interface NumberLookupRetrieveResponse {
 }
 export declare namespace NumberLookupRetrieveResponse {
     interface Data {
+        /**
+         * Identity information for the phone number's owner, including name and postal
+         * address. Populated when `type=caller-identity` is requested.
+         */
+        caller_identity?: Data.CallerIdentity;
         caller_name?: Data.CallerName;
         carrier?: Data.Carrier;
         /**
          * Region code that matches the specific country calling code
          */
         country_code?: string;
+        /**
+         * Enhanced caller name for the phone number's owner. Populated when
+         * `type=enhanced-caller-name` is requested.
+         */
+        enhanced_caller_name?: Data.EnhancedCallerName;
         /**
          * Unused
          */
@@ -30,6 +40,11 @@ export declare namespace NumberLookupRetrieveResponse {
          * (NDC), with a 0 prefix, if an NDC is found
          */
         national_format?: string;
+        /**
+         * Network number ID (NNID) override for the phone number, when one applies
+         * (available only to accounts enabled for NNID); otherwise null.
+         */
+        nnid_override?: Data.NnidOverride | null;
         /**
          * E164-formatted phone number
          */
@@ -39,8 +54,74 @@ export declare namespace NumberLookupRetrieveResponse {
          * Identifies the type of record
          */
         record_type?: string;
+        /**
+         * Indicates whether the phone number is valid.
+         */
+        valid_number?: boolean;
     }
     namespace Data {
+        /**
+         * Identity information for the phone number's owner, including name and postal
+         * address. Populated when `type=caller-identity` is requested.
+         */
+        interface CallerIdentity {
+            /**
+             * Postal address associated with the phone number's owner.
+             */
+            address?: CallerIdentity.Address;
+            /**
+             * How strongly the phone number is linked to the returned name, on a scale of 50
+             * to 90 (higher means more supporting signals). Reflects signal strength, not
+             * probability: 70 indicates stronger, more consistent evidence than 60, not a 70%
+             * chance of being correct. As a guide, 70+ is high confidence, 60 moderate, and 50
+             * limited. Below 50 no name is returned, so scores under 50 are never present.
+             */
+            confidence_score?: number | null;
+            /**
+             * A lookup-specific error code if the identity could not be resolved; otherwise
+             * null.
+             */
+            error_code?: string | null;
+            /**
+             * The name associated with the phone number.
+             */
+            name?: string | null;
+        }
+        namespace CallerIdentity {
+            /**
+             * Postal address associated with the phone number's owner.
+             */
+            interface Address {
+                /**
+                 * City.
+                 */
+                city?: string | null;
+                /**
+                 * Two-letter ISO 3166-1 country code.
+                 */
+                country_code?: string | null;
+                /**
+                 * Postal or ZIP code.
+                 */
+                postal_code?: string | null;
+                /**
+                 * Two-letter state or province code.
+                 */
+                state_code?: string | null;
+                /**
+                 * First line of the street address.
+                 */
+                street_line_1?: string | null;
+                /**
+                 * Second line of the street address, if any.
+                 */
+                street_line_2?: string | null;
+                /**
+                 * ZIP+4 extension, if available.
+                 */
+                zip4?: string | null;
+            }
+        }
         interface CallerName {
             /**
              * The name of the requested phone number's owner as per the CNAM database
@@ -82,6 +163,39 @@ export declare namespace NumberLookupRetrieveResponse {
              */
             type?: 'fixed line' | 'mobile' | 'voip' | 'fixed line or mobile' | 'toll free' | 'premium rate' | 'shared cost' | 'personal number' | 'pager' | 'uan' | 'voicemail' | 'unknown';
         }
+        /**
+         * Enhanced caller name for the phone number's owner. Populated when
+         * `type=enhanced-caller-name` is requested.
+         */
+        interface EnhancedCallerName {
+            /**
+             * The name associated with the phone number.
+             */
+            caller_name?: string | null;
+            /**
+             * A lookup-specific error code if the enhanced caller name could not be resolved;
+             * otherwise null.
+             */
+            error_code?: string | null;
+        }
+        /**
+         * Network number ID (NNID) override for the phone number, when one applies
+         * (available only to accounts enabled for NNID); otherwise null.
+         */
+        interface NnidOverride {
+            /**
+             * Name associated with the NNID.
+             */
+            name?: string;
+            /**
+             * The network number ID.
+             */
+            nnid?: string;
+            /**
+             * The NNID type.
+             */
+            type?: string;
+        }
         interface Portability {
             /**
              * Alternative SPID (Service Provider ID). Often used when a carrier is using a
@@ -102,9 +216,10 @@ export declare namespace NumberLookupRetrieveResponse {
              */
             city?: string;
             /**
-             * Type of number
+             * The line type of the phone number. Uses the same value set as carrier.type; see
+             * the API reference for the full list.
              */
-            line_type?: string;
+            line_type?: 'fixed line' | 'mobile' | 'voip' | 'fixed line or mobile' | 'toll free' | 'premium rate' | 'shared cost' | 'personal number' | 'pager' | 'uan' | 'voicemail' | 'unknown';
             /**
              * Local Routing Number, if assigned to the requested phone number
              */
@@ -140,9 +255,12 @@ export declare namespace NumberLookupRetrieveResponse {
 }
 export interface NumberLookupRetrieveParams {
     /**
-     * Specifies the type of number lookup to be performed
+     * Specifies the type of number lookup to be performed. May be supplied more than
+     * once to request several data sources in a single call (for example,
+     * `?type=carrier&type=enhanced-caller-name`). Each requested type populates the
+     * corresponding object in the response.
      */
-    type?: 'carrier' | 'caller-name';
+    type?: 'carrier' | 'caller-name' | 'caller-identity' | 'enhanced-caller-name';
 }
 export declare namespace NumberLookup {
     export { type NumberLookupRetrieveResponse as NumberLookupRetrieveResponse, type NumberLookupRetrieveParams as NumberLookupRetrieveParams, };

package/resources/number-lookup.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"number-lookup.d.mts","sourceRoot":"","sources":["../src/resources/number-lookup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,4BAA4B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB,WAAW,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE9B,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,WAAW,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,UAAU;YACzB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;;eAGG;YACH,IAAI,CAAC,EACD,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,OAAO,GACP,KAAK,GACL,WAAW,GACX,SAAS,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;;eAGG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,EAAE,CAAC;YAE/B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,aAAa,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
+{"version":3,"file":"number-lookup.d.mts","sourceRoot":"","sources":["../src/resources/number-lookup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,4BAA4B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB;;;WAGG;QACH,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC;QAEtC,WAAW,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE9B,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,oBAAoB,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,aAAa,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,WAAW,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC;QAE/B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC;YAEjC;;;;;;eAMG;YACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEjC;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,cAAc,CAAC;YAC9B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE7B;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE9B;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE9B;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACtB;SACF;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B;;;eAGG;YACH,IAAI,CAAC,EACD,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,OAAO,GACP,KAAK,GACL,WAAW,GACX,SAAS,CAAC;SACf;QAED;;;WAGG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,SAAS,CAAC,EACN,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,OAAO,GACP,KAAK,GACL,WAAW,GACX,SAAS,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;;eAGG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,EAAE,CAAC;YAE/B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,iBAAiB,GAAG,sBAAsB,CAAC;CAC/E;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}