import type * as Pinnacle from "../../../../index.js";
/**
* @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.
*
* Toll-free numbers ignore city and state filters.
*/
location?: SearchPhoneNumberParams.Location;
/** Filter your search by digit pattern. */
number?: SearchPhoneNumberParams.Number;
/** 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.
*
* 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.
*
* 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 Number {
/** 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;
}
}