@seven.io/client
Version:
Official API client for seven
77 lines (76 loc) • 2.59 kB
TypeScript
import { API_RESPONSE_CODES, HLR_LOOKUP_OUTCOME_CODES, HLR_PORTED_CODES, HLR_REACHABLE_CODES, HLR_ROAMING_CODES, HLR_STATUS_MESSAGE_CODES, HLR_VALID_NUMBER_CODES, LOOKUP_GSM_CODES, NetworkType, ROAMING_STATUS_CODES } from './constants';
export type ApiResponseCode = typeof API_RESPONSE_CODES[number];
export type GsmCode = typeof LOOKUP_GSM_CODES[number];
export type Carrier = {
country: string;
name: string | null;
network_code: string;
network_type: NetworkType | null;
};
export type Format = {
carrier: string | null;
country_code: string | false;
country_iso: string | null;
country_name: string | null;
international: string;
international_formatted: string;
national: string | null;
network_type: NetworkType | null;
success: boolean;
};
export type HLR = {
country_code: string;
country_code_iso3?: string;
country_name: string;
country_prefix: string;
current_carrier: Carrier;
gsm_code: GsmCode;
gsm_message: string;
international_format_number: string;
international_formatted: string;
lookup_outcome: typeof HLR_LOOKUP_OUTCOME_CODES[number] | boolean;
lookup_outcome_message: string;
national_format_number: string;
original_carrier: Carrier;
ported: typeof HLR_PORTED_CODES[number];
reachable: typeof HLR_REACHABLE_CODES[number];
roaming: typeof HLR_ROAMING_CODES[number] | Roaming;
status: boolean;
status_message: typeof HLR_STATUS_MESSAGE_CODES[number];
valid_number: typeof HLR_VALID_NUMBER_CODES[number];
};
export type MNP = {
country: string;
international_formatted: string;
isPorted: boolean | null;
mccmnc: string;
national_format: string;
network: string | null;
networkType: string | null;
number: string;
};
export type Roaming = {
roaming_country_code: string;
roaming_network_code: string;
roaming_network_name: string;
status: typeof ROAMING_STATUS_CODES[number];
};
export type MnpResponse = {
code: ApiResponseCode;
mnp: MNP;
price: number;
success: boolean;
};
export type RcsCapability = 'FEATURE_UNSPECIFIED' | 'REVOCATION' | 'RICHCARD_STANDALONE' | 'RICHCARD_CAROUSEL' | 'ACTION_CREATE_CALENDAR_EVENT' | 'ACTION_DIAL' | 'ACTION_OPEN_URL' | 'ACTION_SHARE_LOCATION' | 'ACTION_VIEW_LOCATION';
export type RcsCapabilities = Format & {
rcs_capabilities: RcsCapability[];
};
export type LookupParams = {
numbers: string[];
};
export type CnamResponse = {
code: number | string;
name?: string;
number?: string;
success?: 'false' | 'true';
};