Class AddressesAPI

Addresses API module - /v1/addresses

Hierarchy

AddressesAPI

Index

Constructors

Properties

Methods

Constructors

constructor

new AddressesAPI(client: AxiosInstance): AddressesAPI
Parameters
- client: AxiosInstance
Returns AddressesAPI
- Defined in javascript/src/addresses/api.ts:9

Properties

`Private` client

client: AxiosInstance

Methods

parse

parse(text: string, address?: Partial<SE.Address>): Promise<AxiosResponse<SE.AddressExtraction, any>>
The parse method parses a string of text to extract addresses.
Parameters
- text: string
- Optional address: Partial<SE.Address>
Returns Promise<AxiosResponse<SE.AddressExtraction, any>>
- Defined in javascript/src/addresses/api.ts:25

validate

validate(addresses: SE.Address[]): Promise<AxiosResponse<SE.AddressValidation[], any>>
The validate method validates a list of addresses.

Params
Address[] The addresses to be validated.
Parameters
- addresses: SE.Address[]
Returns Promise<AxiosResponse<SE.AddressValidation[], any>>
- Defined in javascript/src/addresses/api.ts:18

Generated using TypeDoc