rcs-js 1.0.22 → 2.0.0-rc.2

package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts

@@ -0,0 +1,117 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+import { Webhook } from "../resources/webhook/client/Client.mjs";
+import { Campaign } from "../resources/campaign/client/Client.mjs";
+export declare namespace PhoneNumbers {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class PhoneNumbers {
+    protected readonly _options: PhoneNumbers.Options;
+    protected _webhook: Webhook | undefined;
+    protected _campaign: Campaign | undefined;
+    constructor(_options: PhoneNumbers.Options);
+    get webhook(): Webhook;
+    get campaign(): Campaign;
+    /**
+     * Search for available phone numbers that match your exact criteria.
+     *
+     * @param {Pinnacle.SearchPhoneNumberParams} request
+     * @param {PhoneNumbers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.phoneNumbers.search({
+     *         features: ["SMS", "MMS"],
+     *         location: {
+     *             city: "New York",
+     *             nationalDestinationCode: "212"
+     *         },
+     *         number: {
+     *             contains: "514",
+     *             startsWith: "45"
+     *         },
+     *         options: {
+     *             limit: 4
+     *         },
+     *         type: ["LOCAL"]
+     *     })
+     */
+    search(request: Pinnacle.SearchPhoneNumberParams, requestOptions?: PhoneNumbers.RequestOptions): core.HttpResponsePromise<Pinnacle.PhoneNumberDetails[]>;
+    private __search;
+    /**
+     * Purchase one or more phone numbers found through the [search endpoint](./search). <br>
+     *
+     * Billing uses your account credits and the numbers are ready for immediate use.
+     *
+     * @param {Pinnacle.BuyPhoneNumberParams} request
+     * @param {PhoneNumbers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.phoneNumbers.buy({
+     *         numbers: ["+18559491727"]
+     *     })
+     */
+    buy(request: Pinnacle.BuyPhoneNumberParams, requestOptions?: PhoneNumbers.RequestOptions): core.HttpResponsePromise<Pinnacle.PurchasedNumber[]>;
+    private __buy;
+    /**
+     * Retrieve information about any phone number.
+     *
+     * @param {Pinnacle.RetrievePhoneNumberDetailsParams} request
+     * @param {PhoneNumbers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.phoneNumbers.get({
+     *         phone: "+11234567890",
+     *         level: "advanced",
+     *         options: {
+     *             risk: true,
+     *             enhanced_contact_info: {
+     *                 context: "This is my friend from JZ. He has done a lot in the crypto space."
+     *             }
+     *         }
+     *     })
+     */
+    get(request: Pinnacle.RetrievePhoneNumberDetailsParams, requestOptions?: PhoneNumbers.RequestOptions): core.HttpResponsePromise<Pinnacle.PhoneNumbersGetResponse>;
+    private __get;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string;
+    }>;
+}

package/dist/esm/api/resources/phoneNumbers/client/Client.mjs

@@ -0,0 +1,281 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import { Webhook } from "../resources/webhook/client/Client.mjs";
+import { Campaign } from "../resources/campaign/client/Client.mjs";
+export class PhoneNumbers {
+    constructor(_options) {
+        this._options = _options;
+    }
+    get webhook() {
+        var _a;
+        return ((_a = this._webhook) !== null && _a !== void 0 ? _a : (this._webhook = new Webhook(this._options)));
+    }
+    get campaign() {
+        var _a;
+        return ((_a = this._campaign) !== null && _a !== void 0 ? _a : (this._campaign = new Campaign(this._options)));
+    }
+    /**
+     * Search for available phone numbers that match your exact criteria.
+     *
+     * @param {Pinnacle.SearchPhoneNumberParams} request
+     * @param {PhoneNumbers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.phoneNumbers.search({
+     *         features: ["SMS", "MMS"],
+     *         location: {
+     *             city: "New York",
+     *             nationalDestinationCode: "212"
+     *         },
+     *         number: {
+     *             contains: "514",
+     *             startsWith: "45"
+     *         },
+     *         options: {
+     *             limit: 4
+     *         },
+     *         type: ["LOCAL"]
+     *     })
+     */
+    search(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__search(request, requestOptions));
+    }
+    __search(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "phone-numbers/search"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /phone-numbers/search.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Purchase one or more phone numbers found through the [search endpoint](./search). <br>
+     *
+     * Billing uses your account credits and the numbers are ready for immediate use.
+     *
+     * @param {Pinnacle.BuyPhoneNumberParams} request
+     * @param {PhoneNumbers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.phoneNumbers.buy({
+     *         numbers: ["+18559491727"]
+     *     })
+     */
+    buy(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__buy(request, requestOptions));
+    }
+    __buy(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "phone-numbers/buy"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /phone-numbers/buy.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Retrieve information about any phone number.
+     *
+     * @param {Pinnacle.RetrievePhoneNumberDetailsParams} request
+     * @param {PhoneNumbers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.phoneNumbers.get({
+     *         phone: "+11234567890",
+     *         level: "advanced",
+     *         options: {
+     *             risk: true,
+     *             enhanced_contact_info: {
+     *                 context: "This is my friend from JZ. He has done a lot in the crypto space."
+     *             }
+     *         }
+     *     })
+     */
+    get(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
+    }
+    __get(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "phone-numbers/details"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PinnacleError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PinnacleError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /phone-numbers/details.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { "PINNACLE-API-KEY": apiKeyValue };
+        });
+    }
+}

package/dist/esm/api/resources/phoneNumbers/client/index.d.mts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/phoneNumbers/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.d.mts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         numbers: ["+18559491727"]
+ *     }
+ */
+export interface BuyPhoneNumberParams {
+    /**
+     * List of phone numbers you want to purchase, each in international E.164 format. <br>
+     *
+     * All specified numbers must be currently available and will be validated for availability before processing the purchase. <br>
+     *
+     * If any number in the request is unavailable or invalid, no purchases will be made and the request will be voided.
+     */
+    numbers: string[];
+}

package/dist/esm/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.d.mts

@@ -0,0 +1,76 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         phone: "+11234567890",
+ *         level: "advanced",
+ *         options: {
+ *             risk: true,
+ *             enhanced_contact_info: {
+ *                 context: "This is my friend from JZ. He has done a lot in the crypto space."
+ *             }
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         phone: "+11234567890",
+ *         level: "advanced",
+ *         options: {
+ *             risk: true,
+ *             enhanced_contact_info: {
+ *                 context: "This is my friend from JZ. He has done a lot in the crypto space."
+ *             }
+ *         }
+ *     }
+ */
+export interface RetrievePhoneNumberDetailsParams {
+    /** Phone number you want to analyze in E.164 format. */
+    phone: string;
+    /**
+     * Choose how much detail you want in your results:
+     * - `basic`: Receive essential info like carrier, location, and format.
+     * - `advanced`: Receive a deeper analysis including fraud risk, detailed location, and enhanced contact info.
+     */
+    level: RetrievePhoneNumberDetailsParams.Level;
+    /** Customize your lookup with additional options. */
+    options?: RetrievePhoneNumberDetailsParams.Options;
+}
+export declare namespace RetrievePhoneNumberDetailsParams {
+    /**
+     * Choose how much detail you want in your results:
+     * - `basic`: Receive essential info like carrier, location, and format.
+     * - `advanced`: Receive a deeper analysis including fraud risk, detailed location, and enhanced contact info.
+     */
+    type Level = "basic" | "advanced";
+    const Level: {
+        readonly Basic: "basic";
+        readonly Advanced: "advanced";
+    };
+    /**
+     * Customize your lookup with additional options.
+     */
+    interface Options {
+        /**
+         * Allows you to force a fresh lookup from primary sources instead of cached data. <br>
+         *
+         * Fresh lookups will take longer to complete than cached lookups.
+         */
+        force?: boolean;
+        /** Include a fraud risk and security analysis. */
+        risk?: boolean;
+        /** Additional information to tailor lookup. */
+        enhanced_contact_info?: Options.EnhancedContactInfo;
+    }
+    namespace Options {
+        /**
+         * Additional information to tailor lookup.
+         */
+        interface EnhancedContactInfo {
+            /** Business context. */
+            context?: string;
+        }
+    }
+}

package/dist/esm/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.mjs

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var RetrievePhoneNumberDetailsParams;
+(function (RetrievePhoneNumberDetailsParams) {
+    RetrievePhoneNumberDetailsParams.Level = {
+        Basic: "basic",
+        Advanced: "advanced",
+    };
+})(RetrievePhoneNumberDetailsParams || (RetrievePhoneNumberDetailsParams = {}));

package/dist/esm/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.mts

@@ -0,0 +1,76 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         features: ["SMS", "MMS"],
+ *         location: {
+ *             city: "New York",
+ *             nationalDestinationCode: "212"
+ *         },
+ *         number: {
+ *             contains: "514",
+ *             startsWith: "45"
+ *         },
+ *         options: {
+ *             limit: 4
+ *         },
+ *         type: ["LOCAL"]
+ *     }
+ */
+export interface SearchPhoneNumberParams {
+    features?: Pinnacle.PhoneFeatureEnum[];
+    /**
+     * Filter your search by geographic location to find numbers in specific regions. <br>
+     *
+     * Toll-free numbers ignore city and state filters.
+     */
+    location?: SearchPhoneNumberParams.Location;
+    /** Filter your search by digit pattern. */
+    number?: SearchPhoneNumberParams.PhoneNumberDigitFilters;
+    /** Extra search settings to control how many results you get. */
+    options?: SearchPhoneNumberParams.Options;
+    /** Types of phone numbers to return in your search. */
+    type: Pinnacle.PhoneEnum[];
+}
+export declare namespace SearchPhoneNumberParams {
+    /**
+     * Filter your search by geographic location to find numbers in specific regions. <br>
+     *
+     * Toll-free numbers ignore city and state filters.
+     */
+    interface Location {
+        /** Search for numbers in your target city. */
+        city?: string;
+        /** Currently, only US numbers are supported. */
+        countryCode?: "US";
+        /**
+         * Narrow your search to a specific area or exchange code. <br>
+         *
+         * For US numbers, this is usually the 3-digit area code.
+         */
+        nationalDestinationCode?: string;
+        /** Search for numbers in your target state or province using a two-letter code. */
+        state?: string;
+    }
+    /**
+     * Filter your search by digit pattern.
+     */
+    interface PhoneNumberDigitFilters {
+        /** Your search will return only numbers that contain this digit sequence anywhere within them. */
+        contains?: string;
+        /** Your search will return only numbers that end with these digits. */
+        endsWith?: string;
+        /** Your search will return only numbers that begin with these digits. */
+        startsWith?: string;
+    }
+    /**
+     * Extra search settings to control how many results you get.
+     */
+    interface Options {
+        /** Set the maximum number of phone numbers to return. */
+        limit?: number;
+    }
+}

package/dist/esm/api/resources/phoneNumbers/client/requests/index.d.mts

@@ -0,0 +1,3 @@
+export { type SearchPhoneNumberParams } from "./SearchPhoneNumberParams.mjs";
+export { type BuyPhoneNumberParams } from "./BuyPhoneNumberParams.mjs";
+export { type RetrievePhoneNumberDetailsParams } from "./RetrievePhoneNumberDetailsParams.mjs";

package/dist/esm/api/resources/phoneNumbers/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/phoneNumbers/index.d.mts

@@ -0,0 +1,3 @@
+export * from "./types/index.mjs";
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";

package/dist/esm/api/resources/phoneNumbers/index.mjs

@@ -0,0 +1,3 @@
+export * from "./types/index.mjs";
+export * from "./client/index.mjs";
+export * from "./resources/index.mjs";