-
Notifications
You must be signed in to change notification settings - Fork 180
/
number-insights.ts
180 lines (176 loc) · 5.17 KB
/
number-insights.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
import { Client } from '@vonage/server-client';
import {
AdvancedLookupOptions,
BasicLookupOptions,
AdvancedResponse,
AsyncAdvancedResponse,
BasicResponse,
StandardResponse,
StandardLookupOptions,
} from './types';
/**
* Client for the Vonage Number Insights API.
*
* @example
* Create a standalone Number Insight client
*
* ```ts
* import { NumberInsights } from '@vonage/numberInsight';
*
* const numberInsightClient = new NumberInsights({
* apiKey: VONAGE_API_KEY,
* apiSecret: VONAGE_API_SECRET
* });
* ```
*
* @example
* Create an Number Insight client from the Vonage client
*
* ```ts
* import { Vonage } from '@vonage/server-client';
*
* const vonage = new Vonage({
* apiKey: VONAGE_API_KEY,
* apiSecret: VONAGE_API_SECRET
* });
*
* const numberInsightClient = vonage.numberInsight;
* ```
*/
export class NumberInsights extends Client {
/**
* Perform an advanced number lookup operation.
*
* @param {string} phoneNumber - The phone number to perform the lookup for.
* @param {AdvancedLookupOptions} options - Additional options for the lookup.
* @return {Promise<AdvancedResponse>} A promise that resolves to the advanced lookup response.
* @example
* ```ts
* const lookup = await numberInsightsClient.advancedLookup('15555551212');
* console.log(`Ths number is ${lookup.valid_number}`);
* ```
*/
public async advancedLookup(
phoneNumber: string,
options?: AdvancedLookupOptions,
): Promise<AdvancedResponse> {
const params = { number: phoneNumber, ...options };
const resp = await this.sendGetRequest<AdvancedResponse>(
`${this.config.apiHost}/ni/advanced/json`,
params,
);
return resp.data;
}
/**
* Perform an asynchronous advanced number lookup operation.
*
* @param {string} phoneNumber - The phone number to perform the lookup for.
* @param {string} callback - The callback URL for receiving the async lookup response.
* @param {StandardLookupOptions} options - Additional options for the lookup.
* @return {Promise<AsyncAdvancedResponse>} A promise that resolves to the async advanced lookup response.
*
* @example
* ```ts
* const lookup = await numberInsightsClient.asyncAdvancedLookup(
* '15555551212',
* 'https://example.com/number-insights',
* );
* console.log(`The request ID is ${lookup.request_id}`);
* ```
*
* @example
* Lookup with the CNAME option:
* ```ts
* const lookup = await numberInsightsClient.asyncAdvancedLookup(
* '15555551212',
* 'https://example.com/number-insights',
* { cname: true },
* );
* console.log(`The request ID is ${lookup.request_id}`);
* ```
*/
public async asyncAdvancedLookup(
phoneNumber: string,
callback: string,
options: StandardLookupOptions,
): Promise<AsyncAdvancedResponse> {
const params = { number: phoneNumber, callback, ...options };
const resp = await this.sendGetRequest<AsyncAdvancedResponse>(
`${this.config.apiHost}/ni/advanced/async/json`,
params,
);
return resp.data;
}
/**
* Perform a basic number lookup operation.
*
* @param {string} phoneNumber - The phone number to perform the lookup for.
* @param {BasicLookupOptions} options - Additional options for the lookup.
* @return {Promise<BasicResponse>} A promise that resolves to the basic lookup response.
*
* @example
* ```ts
* const lookup = await numberInsightsClient.basicLookup(
* '15555551212',
* );
* console.log(`The request ID is ${lookup.request_id}`);
* ```
*
* @example
* Lookup with the country option:
* ```ts
* const lookup = await numberInsightsClient.basicLookup(
* '15555551212',
* { country: 'US' },
* );
* console.log(`The request ID is ${lookup.request_id}`);
* ```
*/
public async basicLookup(
phoneNumber: string,
options?: BasicLookupOptions,
): Promise<BasicResponse> {
const params = { number: phoneNumber, ...options };
const resp = await this.sendGetRequest<BasicResponse>(
`${this.config.apiHost}/ni/basic/json`,
params,
);
return resp.data;
}
/**
* Perform a standard number lookup operation.
*
* @param {string} phoneNumber - The phone number to perform the lookup for.
* @param {StandardLookupOptions} options - Additional options for the lookup.
* @return {Promise<StandardResponse>} A promise that resolves to the standard lookup response.
*
* @example
* ```ts
* const lookup = await numberInsightsClient.standardLookup(
* '15555551212',
* );
* console.log(`The request ID is ${lookup.request_id}`);
* ```
*
* @example
* Lookup with the cname option:
* ```ts
* const lookup = await numberInsightsClient.standardLookup(
* '15555551212',
* { cname: true },
* );
* console.log(`The request ID is ${lookup.request_id}`);
* ```
*/
public async standardLookup(
phoneNumber: string,
options?: StandardLookupOptions,
): Promise<StandardResponse> {
const params = { number: phoneNumber, ...options };
const resp = await this.sendGetRequest<StandardResponse>(
`${this.config.apiHost}/ni/standard/json`,
params,
);
return resp.data;
}
}