Skip to main content

@dialstack/sdk-dev / js/src / SupportedCountry

Interface: SupportedCountry

Defined in: sdk/js/src/constants/countries.ts:18

Properties​

carrierRecord​

TypeScript
carrierRecord: "csr" | "equipmentRecord";

Defined in: sdk/js/src/constants/countries.ts:39

The losing carrier's record of the account that can back a port: a US customer service record (CSR), or the equipment record Bell and Telus give their Canadian customers on request.


code​

TypeScript
code: SupportedCountryCode;

Defined in: sdk/js/src/constants/countries.ts:19


portRequiresBillCopy​

TypeScript
portRequiresBillCopy: boolean;

Defined in: sdk/js/src/constants/countries.ts:45

Onboarding asks for a recent phone bill before a port goes ahead. Our choice for the US, to head off rejections; the carrier's Canadian porting guide says a bill isn't required there.


postalCode?​

TypeScript
postalCode?: RegExp;

Defined in: sdk/js/src/constants/countries.ts:31

The postal code's format, any case, with or without spaces; absent accepts any.


postalCodeExample​

TypeScript
postalCodeExample: string;

Defined in: sdk/js/src/constants/countries.ts:29

A postal code to show as an example.


postalCodeKind​

TypeScript
postalCodeKind: "zip" | "postalCode";

Defined in: sdk/js/src/constants/countries.ts:27

What the country calls a postal code.


regionKind​

TypeScript
regionKind: "state" | "province";

Defined in: sdk/js/src/constants/countries.ts:25

What the country calls a region.


regions​

TypeScript
regions: readonly Region[];

Defined in: sdk/js/src/constants/countries.ts:21

Its regions. No two countries share a code, so a region names its country.


requiresLosingReseller​

TypeScript
requiresLosingReseller: boolean;

Defined in: sdk/js/src/constants/countries.ts:33

A port names the reseller the customer pays: the country's carriers require it.


searchableRegions​

TypeScript
searchableRegions: readonly Region[];

Defined in: sdk/js/src/constants/countries.ts:23

The regions a number search accepts.