telnyx 7.1.0 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +100 -2
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +27 -47
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +27 -47
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js +12 -13
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs +12 -13
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/calls/actions.d.mts +27 -0
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +27 -0
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/dir/dir.d.mts +8 -0
- package/resources/dir/dir.d.mts.map +1 -1
- package/resources/dir/dir.d.ts +8 -0
- package/resources/dir/dir.d.ts.map +1 -1
- package/resources/dir/dir.js +8 -0
- package/resources/dir/dir.js.map +1 -1
- package/resources/dir/dir.mjs +8 -0
- package/resources/dir/dir.mjs.map +1 -1
- package/resources/dir/index.d.mts +2 -0
- package/resources/dir/index.d.mts.map +1 -1
- package/resources/dir/index.d.ts +2 -0
- package/resources/dir/index.d.ts.map +1 -1
- package/resources/dir/index.js +5 -1
- package/resources/dir/index.js.map +1 -1
- package/resources/dir/index.mjs +2 -0
- package/resources/dir/index.mjs.map +1 -1
- package/resources/dir/references.d.mts +231 -0
- package/resources/dir/references.d.mts.map +1 -0
- package/resources/dir/references.d.ts +231 -0
- package/resources/dir/references.d.ts.map +1 -0
- package/resources/dir/references.js +96 -0
- package/resources/dir/references.js.map +1 -0
- package/resources/dir/references.mjs +92 -0
- package/resources/dir/references.mjs.map +1 -0
- package/resources/dir/verify-email.d.mts +90 -0
- package/resources/dir/verify-email.d.mts.map +1 -0
- package/resources/dir/verify-email.d.ts +90 -0
- package/resources/dir/verify-email.d.ts.map +1 -0
- package/resources/dir/verify-email.js +65 -0
- package/resources/dir/verify-email.js.map +1 -0
- package/resources/dir/verify-email.mjs +61 -0
- package/resources/dir/verify-email.mjs.map +1 -0
- package/resources/documents.js +1 -1
- package/resources/documents.js.map +1 -1
- package/resources/documents.mjs +1 -1
- package/resources/documents.mjs.map +1 -1
- package/resources/messaging-10dlc/messaging-10dlc.d.mts +1 -1
- package/resources/messaging-10dlc/messaging-10dlc.d.mts.map +1 -1
- package/resources/messaging-10dlc/messaging-10dlc.d.ts +1 -1
- package/resources/messaging-10dlc/messaging-10dlc.d.ts.map +1 -1
- package/resources/texml/accounts/calls/calls.d.mts +3 -3
- package/resources/texml/accounts/calls/calls.d.mts.map +1 -1
- package/resources/texml/accounts/calls/calls.d.ts +3 -3
- package/resources/texml/accounts/calls/calls.d.ts.map +1 -1
- package/resources/whatsapp/index.d.mts +1 -1
- package/resources/whatsapp/index.d.mts.map +1 -1
- package/resources/whatsapp/index.d.ts +1 -1
- package/resources/whatsapp/index.d.ts.map +1 -1
- package/resources/whatsapp/index.js.map +1 -1
- package/resources/whatsapp/index.mjs.map +1 -1
- package/resources/whatsapp/phone-numbers/index.d.mts +1 -1
- package/resources/whatsapp/phone-numbers/index.d.mts.map +1 -1
- package/resources/whatsapp/phone-numbers/index.d.ts +1 -1
- package/resources/whatsapp/phone-numbers/index.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/index.js.map +1 -1
- package/resources/whatsapp/phone-numbers/index.mjs.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.mts +45 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.mts.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.ts +45 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.js +20 -0
- package/resources/whatsapp/phone-numbers/phone-numbers.js.map +1 -1
- package/resources/whatsapp/phone-numbers/phone-numbers.mjs +20 -0
- package/resources/whatsapp/phone-numbers/phone-numbers.mjs.map +1 -1
- package/resources/whatsapp/whatsapp.d.mts +2 -2
- package/resources/whatsapp/whatsapp.d.mts.map +1 -1
- package/resources/whatsapp/whatsapp.d.ts +2 -2
- package/resources/whatsapp/whatsapp.d.ts.map +1 -1
- package/resources/whatsapp/whatsapp.js.map +1 -1
- package/resources/whatsapp/whatsapp.mjs.map +1 -1
- package/src/resources/ai/ai.ts +28 -51
- package/src/resources/calls/actions.ts +31 -0
- package/src/resources/dir/dir.ts +32 -0
- package/src/resources/dir/index.ts +14 -0
- package/src/resources/dir/references.ts +285 -0
- package/src/resources/dir/verify-email.ts +114 -0
- package/src/resources/documents.ts +1 -1
- package/src/resources/messaging-10dlc/messaging-10dlc.ts +1 -1
- package/src/resources/texml/accounts/calls/calls.ts +3 -3
- package/src/resources/whatsapp/index.ts +2 -0
- package/src/resources/whatsapp/phone-numbers/index.ts +2 -0
- package/src/resources/whatsapp/phone-numbers/phone-numbers.ts +62 -0
- package/src/resources/whatsapp/whatsapp.ts +4 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Submit and manage the two business references and one financial reference that vouch for a DIR. References are contacted to confirm the business identity during vetting.
|
|
6
|
+
*/
|
|
7
|
+
export declare class References extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Submit the two business references and one financial reference for a DIR.
|
|
10
|
+
*
|
|
11
|
+
* The DIR's authorizer email must be verified first (see the email-verification
|
|
12
|
+
* endpoint). Until it is, this returns `409` and no references are stored.
|
|
13
|
+
*
|
|
14
|
+
* The request body carries exactly two business references plus one financial
|
|
15
|
+
* reference. On success the references are stored and the response echoes them in
|
|
16
|
+
* the same shape as the GET. Submitting again converges on the already-stored
|
|
17
|
+
* references rather than erroring.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const referenceList = await client.dir.references.create(
|
|
22
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
23
|
+
* {
|
|
24
|
+
* business_references: [
|
|
25
|
+
* {
|
|
26
|
+
* email: 'dana.reyes@example.com',
|
|
27
|
+
* full_name: 'Dana Reyes',
|
|
28
|
+
* phone_e164: '+14155550123',
|
|
29
|
+
* timezone: 'America/New_York',
|
|
30
|
+
* },
|
|
31
|
+
* {
|
|
32
|
+
* email: 'dana.reyes@example.com',
|
|
33
|
+
* full_name: 'Dana Reyes',
|
|
34
|
+
* phone_e164: '+14155550123',
|
|
35
|
+
* timezone: 'America/New_York',
|
|
36
|
+
* },
|
|
37
|
+
* ],
|
|
38
|
+
* financial_reference: {
|
|
39
|
+
* email: 'dana.reyes@example.com',
|
|
40
|
+
* full_name: 'Dana Reyes',
|
|
41
|
+
* phone_e164: '+14155550123',
|
|
42
|
+
* timezone: 'America/New_York',
|
|
43
|
+
* },
|
|
44
|
+
* },
|
|
45
|
+
* );
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
create(dirID: string, body: ReferenceCreateParams, options?: RequestOptions): APIPromise<ReferenceList>;
|
|
49
|
+
/**
|
|
50
|
+
* Partially update one reference, addressed by the DIR id plus the reference's
|
|
51
|
+
* type (business or financial) and slot.
|
|
52
|
+
*
|
|
53
|
+
* Cosmetic fields (full name, job title, organization, relationship, email) are
|
|
54
|
+
* always editable. The phone number and timezone may only be changed while a
|
|
55
|
+
* scheduled call has not yet been dialed; if a call is in progress or all attempts
|
|
56
|
+
* are complete, those fields are locked. Changing the timezone reschedules any
|
|
57
|
+
* pending call into the new local calling window.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* const reference = await client.dir.references.update(0, {
|
|
62
|
+
* dir_id: '16635d38-75a6-4481-82e8-69af60e05011',
|
|
63
|
+
* ref_type: 'business',
|
|
64
|
+
* });
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
update(slot: number, params: ReferenceUpdateParams, options?: RequestOptions): APIPromise<ReferenceUpdateResponse>;
|
|
68
|
+
/**
|
|
69
|
+
* List the business and financial references submitted for a DIR.
|
|
70
|
+
*
|
|
71
|
+
* Returns the two business references (slots 0 and 1) followed by the single
|
|
72
|
+
* financial reference. Each entry carries only the customer-supplied details
|
|
73
|
+
* (name, title, organization, relationship, phone, email, timezone). Returns an
|
|
74
|
+
* empty list when no references were submitted.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const referenceList = await client.dir.references.list(
|
|
79
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
80
|
+
* );
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
list(dirID: string, options?: RequestOptions): APIPromise<ReferenceList>;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* A reference (business or financial) on a DIR, in the customer-facing shape. No
|
|
87
|
+
* internal identifiers are exposed.
|
|
88
|
+
*/
|
|
89
|
+
export interface Reference {
|
|
90
|
+
/**
|
|
91
|
+
* Full name of the reference contact.
|
|
92
|
+
*/
|
|
93
|
+
full_name: string;
|
|
94
|
+
/**
|
|
95
|
+
* Reference phone number in E.164 format.
|
|
96
|
+
*/
|
|
97
|
+
phone_e164: string;
|
|
98
|
+
/**
|
|
99
|
+
* Always `dir_reference`.
|
|
100
|
+
*/
|
|
101
|
+
record_type: 'dir_reference';
|
|
102
|
+
/**
|
|
103
|
+
* Whether this is a business reference or the financial reference.
|
|
104
|
+
*/
|
|
105
|
+
ref_type: 'business' | 'financial';
|
|
106
|
+
/**
|
|
107
|
+
* Position within the reference type. Business references occupy slots 0 and 1;
|
|
108
|
+
* the financial reference occupies slot 0.
|
|
109
|
+
*/
|
|
110
|
+
slot: number;
|
|
111
|
+
/**
|
|
112
|
+
* IANA timezone id for the reference. Calls are only placed within the reference's
|
|
113
|
+
* local 8am-9pm window.
|
|
114
|
+
*/
|
|
115
|
+
timezone: string;
|
|
116
|
+
/**
|
|
117
|
+
* Reference contact email address.
|
|
118
|
+
*/
|
|
119
|
+
email?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* Job title of the reference contact.
|
|
122
|
+
*/
|
|
123
|
+
job_title?: string | null;
|
|
124
|
+
/**
|
|
125
|
+
* Organization the reference contact belongs to.
|
|
126
|
+
*/
|
|
127
|
+
organization?: string | null;
|
|
128
|
+
/**
|
|
129
|
+
* How the reference contact is related to the registering business.
|
|
130
|
+
*/
|
|
131
|
+
relationship_to_registrant?: string | null;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* One reference supplied at submit. The reference type is implied by the field
|
|
135
|
+
* that carries it (business_references vs financial_reference).
|
|
136
|
+
*/
|
|
137
|
+
export interface ReferenceInput {
|
|
138
|
+
/**
|
|
139
|
+
* Reference contact email address. Required: the reference is emailed scheduling
|
|
140
|
+
* and dial-in notices.
|
|
141
|
+
*/
|
|
142
|
+
email: string;
|
|
143
|
+
/**
|
|
144
|
+
* Full name of the reference contact.
|
|
145
|
+
*/
|
|
146
|
+
full_name: string;
|
|
147
|
+
/**
|
|
148
|
+
* Reference phone number in E.164 format, e.g. +14155550123.
|
|
149
|
+
*/
|
|
150
|
+
phone_e164: string;
|
|
151
|
+
/**
|
|
152
|
+
* IANA timezone id for the reference (e.g. America/New_York). Required: calls are
|
|
153
|
+
* only placed within the reference's local 8am-9pm window.
|
|
154
|
+
*/
|
|
155
|
+
timezone: string;
|
|
156
|
+
/**
|
|
157
|
+
* Job title of the reference contact.
|
|
158
|
+
*/
|
|
159
|
+
job_title?: string | null;
|
|
160
|
+
/**
|
|
161
|
+
* Organization the reference contact belongs to.
|
|
162
|
+
*/
|
|
163
|
+
organization?: string | null;
|
|
164
|
+
/**
|
|
165
|
+
* How the reference contact is related to the registering business.
|
|
166
|
+
*/
|
|
167
|
+
relationship_to_registrant?: string | null;
|
|
168
|
+
}
|
|
169
|
+
export interface ReferenceList {
|
|
170
|
+
data: Array<Reference>;
|
|
171
|
+
}
|
|
172
|
+
export interface ReferenceUpdateResponse {
|
|
173
|
+
/**
|
|
174
|
+
* A reference (business or financial) on a DIR, in the customer-facing shape. No
|
|
175
|
+
* internal identifiers are exposed.
|
|
176
|
+
*/
|
|
177
|
+
data: Reference;
|
|
178
|
+
}
|
|
179
|
+
export interface ReferenceCreateParams {
|
|
180
|
+
/**
|
|
181
|
+
* Exactly two business references.
|
|
182
|
+
*/
|
|
183
|
+
business_references: Array<ReferenceInput>;
|
|
184
|
+
/**
|
|
185
|
+
* One reference supplied at submit. The reference type is implied by the field
|
|
186
|
+
* that carries it (business_references vs financial_reference).
|
|
187
|
+
*/
|
|
188
|
+
financial_reference: ReferenceInput;
|
|
189
|
+
}
|
|
190
|
+
export interface ReferenceUpdateParams {
|
|
191
|
+
/**
|
|
192
|
+
* Path param: The DIR id. Lowercase UUID.
|
|
193
|
+
*/
|
|
194
|
+
dir_id: string;
|
|
195
|
+
/**
|
|
196
|
+
* Path param: Reference type to address.
|
|
197
|
+
*/
|
|
198
|
+
ref_type: 'business' | 'financial';
|
|
199
|
+
/**
|
|
200
|
+
* Body param: Reference contact email address.
|
|
201
|
+
*/
|
|
202
|
+
email?: string;
|
|
203
|
+
/**
|
|
204
|
+
* Body param: Full name of the reference contact.
|
|
205
|
+
*/
|
|
206
|
+
full_name?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Body param: Job title of the reference contact.
|
|
209
|
+
*/
|
|
210
|
+
job_title?: string | null;
|
|
211
|
+
/**
|
|
212
|
+
* Body param: Organization the reference contact belongs to.
|
|
213
|
+
*/
|
|
214
|
+
organization?: string | null;
|
|
215
|
+
/**
|
|
216
|
+
* Body param: Reference phone number in E.164 format.
|
|
217
|
+
*/
|
|
218
|
+
phone_e164?: string;
|
|
219
|
+
/**
|
|
220
|
+
* Body param: How the reference contact is related to the registering business.
|
|
221
|
+
*/
|
|
222
|
+
relationship_to_registrant?: string | null;
|
|
223
|
+
/**
|
|
224
|
+
* Body param: IANA timezone id for the reference.
|
|
225
|
+
*/
|
|
226
|
+
timezone?: string;
|
|
227
|
+
}
|
|
228
|
+
export declare namespace References {
|
|
229
|
+
export { type Reference as Reference, type ReferenceInput as ReferenceInput, type ReferenceList as ReferenceList, type ReferenceUpdateResponse as ReferenceUpdateResponse, type ReferenceCreateParams as ReferenceCreateParams, type ReferenceUpdateParams as ReferenceUpdateParams, };
|
|
230
|
+
}
|
|
231
|
+
//# sourceMappingURL=references.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.d.mts","sourceRoot":"","sources":["../../src/resources/dir/references.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIvG;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAKtC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGzE;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,eAAe,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAC;IAEnC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE3C;;;OAGG;IACH,mBAAmB,EAAE,cAAc,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
|
+
/**
|
|
5
|
+
* Submit and manage the two business references and one financial reference that vouch for a DIR. References are contacted to confirm the business identity during vetting.
|
|
6
|
+
*/
|
|
7
|
+
export declare class References extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Submit the two business references and one financial reference for a DIR.
|
|
10
|
+
*
|
|
11
|
+
* The DIR's authorizer email must be verified first (see the email-verification
|
|
12
|
+
* endpoint). Until it is, this returns `409` and no references are stored.
|
|
13
|
+
*
|
|
14
|
+
* The request body carries exactly two business references plus one financial
|
|
15
|
+
* reference. On success the references are stored and the response echoes them in
|
|
16
|
+
* the same shape as the GET. Submitting again converges on the already-stored
|
|
17
|
+
* references rather than erroring.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const referenceList = await client.dir.references.create(
|
|
22
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
23
|
+
* {
|
|
24
|
+
* business_references: [
|
|
25
|
+
* {
|
|
26
|
+
* email: 'dana.reyes@example.com',
|
|
27
|
+
* full_name: 'Dana Reyes',
|
|
28
|
+
* phone_e164: '+14155550123',
|
|
29
|
+
* timezone: 'America/New_York',
|
|
30
|
+
* },
|
|
31
|
+
* {
|
|
32
|
+
* email: 'dana.reyes@example.com',
|
|
33
|
+
* full_name: 'Dana Reyes',
|
|
34
|
+
* phone_e164: '+14155550123',
|
|
35
|
+
* timezone: 'America/New_York',
|
|
36
|
+
* },
|
|
37
|
+
* ],
|
|
38
|
+
* financial_reference: {
|
|
39
|
+
* email: 'dana.reyes@example.com',
|
|
40
|
+
* full_name: 'Dana Reyes',
|
|
41
|
+
* phone_e164: '+14155550123',
|
|
42
|
+
* timezone: 'America/New_York',
|
|
43
|
+
* },
|
|
44
|
+
* },
|
|
45
|
+
* );
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
create(dirID: string, body: ReferenceCreateParams, options?: RequestOptions): APIPromise<ReferenceList>;
|
|
49
|
+
/**
|
|
50
|
+
* Partially update one reference, addressed by the DIR id plus the reference's
|
|
51
|
+
* type (business or financial) and slot.
|
|
52
|
+
*
|
|
53
|
+
* Cosmetic fields (full name, job title, organization, relationship, email) are
|
|
54
|
+
* always editable. The phone number and timezone may only be changed while a
|
|
55
|
+
* scheduled call has not yet been dialed; if a call is in progress or all attempts
|
|
56
|
+
* are complete, those fields are locked. Changing the timezone reschedules any
|
|
57
|
+
* pending call into the new local calling window.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* const reference = await client.dir.references.update(0, {
|
|
62
|
+
* dir_id: '16635d38-75a6-4481-82e8-69af60e05011',
|
|
63
|
+
* ref_type: 'business',
|
|
64
|
+
* });
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
update(slot: number, params: ReferenceUpdateParams, options?: RequestOptions): APIPromise<ReferenceUpdateResponse>;
|
|
68
|
+
/**
|
|
69
|
+
* List the business and financial references submitted for a DIR.
|
|
70
|
+
*
|
|
71
|
+
* Returns the two business references (slots 0 and 1) followed by the single
|
|
72
|
+
* financial reference. Each entry carries only the customer-supplied details
|
|
73
|
+
* (name, title, organization, relationship, phone, email, timezone). Returns an
|
|
74
|
+
* empty list when no references were submitted.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const referenceList = await client.dir.references.list(
|
|
79
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
80
|
+
* );
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
list(dirID: string, options?: RequestOptions): APIPromise<ReferenceList>;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* A reference (business or financial) on a DIR, in the customer-facing shape. No
|
|
87
|
+
* internal identifiers are exposed.
|
|
88
|
+
*/
|
|
89
|
+
export interface Reference {
|
|
90
|
+
/**
|
|
91
|
+
* Full name of the reference contact.
|
|
92
|
+
*/
|
|
93
|
+
full_name: string;
|
|
94
|
+
/**
|
|
95
|
+
* Reference phone number in E.164 format.
|
|
96
|
+
*/
|
|
97
|
+
phone_e164: string;
|
|
98
|
+
/**
|
|
99
|
+
* Always `dir_reference`.
|
|
100
|
+
*/
|
|
101
|
+
record_type: 'dir_reference';
|
|
102
|
+
/**
|
|
103
|
+
* Whether this is a business reference or the financial reference.
|
|
104
|
+
*/
|
|
105
|
+
ref_type: 'business' | 'financial';
|
|
106
|
+
/**
|
|
107
|
+
* Position within the reference type. Business references occupy slots 0 and 1;
|
|
108
|
+
* the financial reference occupies slot 0.
|
|
109
|
+
*/
|
|
110
|
+
slot: number;
|
|
111
|
+
/**
|
|
112
|
+
* IANA timezone id for the reference. Calls are only placed within the reference's
|
|
113
|
+
* local 8am-9pm window.
|
|
114
|
+
*/
|
|
115
|
+
timezone: string;
|
|
116
|
+
/**
|
|
117
|
+
* Reference contact email address.
|
|
118
|
+
*/
|
|
119
|
+
email?: string | null;
|
|
120
|
+
/**
|
|
121
|
+
* Job title of the reference contact.
|
|
122
|
+
*/
|
|
123
|
+
job_title?: string | null;
|
|
124
|
+
/**
|
|
125
|
+
* Organization the reference contact belongs to.
|
|
126
|
+
*/
|
|
127
|
+
organization?: string | null;
|
|
128
|
+
/**
|
|
129
|
+
* How the reference contact is related to the registering business.
|
|
130
|
+
*/
|
|
131
|
+
relationship_to_registrant?: string | null;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* One reference supplied at submit. The reference type is implied by the field
|
|
135
|
+
* that carries it (business_references vs financial_reference).
|
|
136
|
+
*/
|
|
137
|
+
export interface ReferenceInput {
|
|
138
|
+
/**
|
|
139
|
+
* Reference contact email address. Required: the reference is emailed scheduling
|
|
140
|
+
* and dial-in notices.
|
|
141
|
+
*/
|
|
142
|
+
email: string;
|
|
143
|
+
/**
|
|
144
|
+
* Full name of the reference contact.
|
|
145
|
+
*/
|
|
146
|
+
full_name: string;
|
|
147
|
+
/**
|
|
148
|
+
* Reference phone number in E.164 format, e.g. +14155550123.
|
|
149
|
+
*/
|
|
150
|
+
phone_e164: string;
|
|
151
|
+
/**
|
|
152
|
+
* IANA timezone id for the reference (e.g. America/New_York). Required: calls are
|
|
153
|
+
* only placed within the reference's local 8am-9pm window.
|
|
154
|
+
*/
|
|
155
|
+
timezone: string;
|
|
156
|
+
/**
|
|
157
|
+
* Job title of the reference contact.
|
|
158
|
+
*/
|
|
159
|
+
job_title?: string | null;
|
|
160
|
+
/**
|
|
161
|
+
* Organization the reference contact belongs to.
|
|
162
|
+
*/
|
|
163
|
+
organization?: string | null;
|
|
164
|
+
/**
|
|
165
|
+
* How the reference contact is related to the registering business.
|
|
166
|
+
*/
|
|
167
|
+
relationship_to_registrant?: string | null;
|
|
168
|
+
}
|
|
169
|
+
export interface ReferenceList {
|
|
170
|
+
data: Array<Reference>;
|
|
171
|
+
}
|
|
172
|
+
export interface ReferenceUpdateResponse {
|
|
173
|
+
/**
|
|
174
|
+
* A reference (business or financial) on a DIR, in the customer-facing shape. No
|
|
175
|
+
* internal identifiers are exposed.
|
|
176
|
+
*/
|
|
177
|
+
data: Reference;
|
|
178
|
+
}
|
|
179
|
+
export interface ReferenceCreateParams {
|
|
180
|
+
/**
|
|
181
|
+
* Exactly two business references.
|
|
182
|
+
*/
|
|
183
|
+
business_references: Array<ReferenceInput>;
|
|
184
|
+
/**
|
|
185
|
+
* One reference supplied at submit. The reference type is implied by the field
|
|
186
|
+
* that carries it (business_references vs financial_reference).
|
|
187
|
+
*/
|
|
188
|
+
financial_reference: ReferenceInput;
|
|
189
|
+
}
|
|
190
|
+
export interface ReferenceUpdateParams {
|
|
191
|
+
/**
|
|
192
|
+
* Path param: The DIR id. Lowercase UUID.
|
|
193
|
+
*/
|
|
194
|
+
dir_id: string;
|
|
195
|
+
/**
|
|
196
|
+
* Path param: Reference type to address.
|
|
197
|
+
*/
|
|
198
|
+
ref_type: 'business' | 'financial';
|
|
199
|
+
/**
|
|
200
|
+
* Body param: Reference contact email address.
|
|
201
|
+
*/
|
|
202
|
+
email?: string;
|
|
203
|
+
/**
|
|
204
|
+
* Body param: Full name of the reference contact.
|
|
205
|
+
*/
|
|
206
|
+
full_name?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Body param: Job title of the reference contact.
|
|
209
|
+
*/
|
|
210
|
+
job_title?: string | null;
|
|
211
|
+
/**
|
|
212
|
+
* Body param: Organization the reference contact belongs to.
|
|
213
|
+
*/
|
|
214
|
+
organization?: string | null;
|
|
215
|
+
/**
|
|
216
|
+
* Body param: Reference phone number in E.164 format.
|
|
217
|
+
*/
|
|
218
|
+
phone_e164?: string;
|
|
219
|
+
/**
|
|
220
|
+
* Body param: How the reference contact is related to the registering business.
|
|
221
|
+
*/
|
|
222
|
+
relationship_to_registrant?: string | null;
|
|
223
|
+
/**
|
|
224
|
+
* Body param: IANA timezone id for the reference.
|
|
225
|
+
*/
|
|
226
|
+
timezone?: string;
|
|
227
|
+
}
|
|
228
|
+
export declare namespace References {
|
|
229
|
+
export { type Reference as Reference, type ReferenceInput as ReferenceInput, type ReferenceList as ReferenceList, type ReferenceUpdateResponse as ReferenceUpdateResponse, type ReferenceCreateParams as ReferenceCreateParams, type ReferenceUpdateParams as ReferenceUpdateParams, };
|
|
230
|
+
}
|
|
231
|
+
//# sourceMappingURL=references.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../src/resources/dir/references.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIvG;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAKtC;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGzE;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,eAAe,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAC;IAEnC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE3C;;;OAGG;IACH,mBAAmB,EAAE,cAAc,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.References = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
7
|
+
/**
|
|
8
|
+
* Submit and manage the two business references and one financial reference that vouch for a DIR. References are contacted to confirm the business identity during vetting.
|
|
9
|
+
*/
|
|
10
|
+
class References extends resource_1.APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Submit the two business references and one financial reference for a DIR.
|
|
13
|
+
*
|
|
14
|
+
* The DIR's authorizer email must be verified first (see the email-verification
|
|
15
|
+
* endpoint). Until it is, this returns `409` and no references are stored.
|
|
16
|
+
*
|
|
17
|
+
* The request body carries exactly two business references plus one financial
|
|
18
|
+
* reference. On success the references are stored and the response echoes them in
|
|
19
|
+
* the same shape as the GET. Submitting again converges on the already-stored
|
|
20
|
+
* references rather than erroring.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* const referenceList = await client.dir.references.create(
|
|
25
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
26
|
+
* {
|
|
27
|
+
* business_references: [
|
|
28
|
+
* {
|
|
29
|
+
* email: 'dana.reyes@example.com',
|
|
30
|
+
* full_name: 'Dana Reyes',
|
|
31
|
+
* phone_e164: '+14155550123',
|
|
32
|
+
* timezone: 'America/New_York',
|
|
33
|
+
* },
|
|
34
|
+
* {
|
|
35
|
+
* email: 'dana.reyes@example.com',
|
|
36
|
+
* full_name: 'Dana Reyes',
|
|
37
|
+
* phone_e164: '+14155550123',
|
|
38
|
+
* timezone: 'America/New_York',
|
|
39
|
+
* },
|
|
40
|
+
* ],
|
|
41
|
+
* financial_reference: {
|
|
42
|
+
* email: 'dana.reyes@example.com',
|
|
43
|
+
* full_name: 'Dana Reyes',
|
|
44
|
+
* phone_e164: '+14155550123',
|
|
45
|
+
* timezone: 'America/New_York',
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* );
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
create(dirID, body, options) {
|
|
52
|
+
return this._client.post((0, path_1.path) `/dir/${dirID}/references`, { body, ...options });
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Partially update one reference, addressed by the DIR id plus the reference's
|
|
56
|
+
* type (business or financial) and slot.
|
|
57
|
+
*
|
|
58
|
+
* Cosmetic fields (full name, job title, organization, relationship, email) are
|
|
59
|
+
* always editable. The phone number and timezone may only be changed while a
|
|
60
|
+
* scheduled call has not yet been dialed; if a call is in progress or all attempts
|
|
61
|
+
* are complete, those fields are locked. Changing the timezone reschedules any
|
|
62
|
+
* pending call into the new local calling window.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const reference = await client.dir.references.update(0, {
|
|
67
|
+
* dir_id: '16635d38-75a6-4481-82e8-69af60e05011',
|
|
68
|
+
* ref_type: 'business',
|
|
69
|
+
* });
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
update(slot, params, options) {
|
|
73
|
+
const { dir_id, ref_type, ...body } = params;
|
|
74
|
+
return this._client.patch((0, path_1.path) `/dir/${dir_id}/references/${ref_type}/${slot}`, { body, ...options });
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* List the business and financial references submitted for a DIR.
|
|
78
|
+
*
|
|
79
|
+
* Returns the two business references (slots 0 and 1) followed by the single
|
|
80
|
+
* financial reference. Each entry carries only the customer-supplied details
|
|
81
|
+
* (name, title, organization, relationship, phone, email, timezone). Returns an
|
|
82
|
+
* empty list when no references were submitted.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* const referenceList = await client.dir.references.list(
|
|
87
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
88
|
+
* );
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
list(dirID, options) {
|
|
92
|
+
return this._client.get((0, path_1.path) `/dir/${dirID}/references`, options);
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
exports.References = References;
|
|
96
|
+
//# sourceMappingURL=references.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.js","sourceRoot":"","sources":["../../src/resources/dir/references.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CAAC,KAAa,EAAE,IAA2B,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,QAAQ,KAAK,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAY,EACZ,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,QAAQ,MAAM,eAAe,QAAQ,IAAI,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAa,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,QAAQ,KAAK,aAAa,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AA1FD,gCA0FC"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Submit and manage the two business references and one financial reference that vouch for a DIR. References are contacted to confirm the business identity during vetting.
|
|
6
|
+
*/
|
|
7
|
+
export class References extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Submit the two business references and one financial reference for a DIR.
|
|
10
|
+
*
|
|
11
|
+
* The DIR's authorizer email must be verified first (see the email-verification
|
|
12
|
+
* endpoint). Until it is, this returns `409` and no references are stored.
|
|
13
|
+
*
|
|
14
|
+
* The request body carries exactly two business references plus one financial
|
|
15
|
+
* reference. On success the references are stored and the response echoes them in
|
|
16
|
+
* the same shape as the GET. Submitting again converges on the already-stored
|
|
17
|
+
* references rather than erroring.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const referenceList = await client.dir.references.create(
|
|
22
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
23
|
+
* {
|
|
24
|
+
* business_references: [
|
|
25
|
+
* {
|
|
26
|
+
* email: 'dana.reyes@example.com',
|
|
27
|
+
* full_name: 'Dana Reyes',
|
|
28
|
+
* phone_e164: '+14155550123',
|
|
29
|
+
* timezone: 'America/New_York',
|
|
30
|
+
* },
|
|
31
|
+
* {
|
|
32
|
+
* email: 'dana.reyes@example.com',
|
|
33
|
+
* full_name: 'Dana Reyes',
|
|
34
|
+
* phone_e164: '+14155550123',
|
|
35
|
+
* timezone: 'America/New_York',
|
|
36
|
+
* },
|
|
37
|
+
* ],
|
|
38
|
+
* financial_reference: {
|
|
39
|
+
* email: 'dana.reyes@example.com',
|
|
40
|
+
* full_name: 'Dana Reyes',
|
|
41
|
+
* phone_e164: '+14155550123',
|
|
42
|
+
* timezone: 'America/New_York',
|
|
43
|
+
* },
|
|
44
|
+
* },
|
|
45
|
+
* );
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
create(dirID, body, options) {
|
|
49
|
+
return this._client.post(path `/dir/${dirID}/references`, { body, ...options });
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Partially update one reference, addressed by the DIR id plus the reference's
|
|
53
|
+
* type (business or financial) and slot.
|
|
54
|
+
*
|
|
55
|
+
* Cosmetic fields (full name, job title, organization, relationship, email) are
|
|
56
|
+
* always editable. The phone number and timezone may only be changed while a
|
|
57
|
+
* scheduled call has not yet been dialed; if a call is in progress or all attempts
|
|
58
|
+
* are complete, those fields are locked. Changing the timezone reschedules any
|
|
59
|
+
* pending call into the new local calling window.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const reference = await client.dir.references.update(0, {
|
|
64
|
+
* dir_id: '16635d38-75a6-4481-82e8-69af60e05011',
|
|
65
|
+
* ref_type: 'business',
|
|
66
|
+
* });
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
update(slot, params, options) {
|
|
70
|
+
const { dir_id, ref_type, ...body } = params;
|
|
71
|
+
return this._client.patch(path `/dir/${dir_id}/references/${ref_type}/${slot}`, { body, ...options });
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* List the business and financial references submitted for a DIR.
|
|
75
|
+
*
|
|
76
|
+
* Returns the two business references (slots 0 and 1) followed by the single
|
|
77
|
+
* financial reference. Each entry carries only the customer-supplied details
|
|
78
|
+
* (name, title, organization, relationship, phone, email, timezone). Returns an
|
|
79
|
+
* empty list when no references were submitted.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```ts
|
|
83
|
+
* const referenceList = await client.dir.references.list(
|
|
84
|
+
* '16635d38-75a6-4481-82e8-69af60e05011',
|
|
85
|
+
* );
|
|
86
|
+
* ```
|
|
87
|
+
*/
|
|
88
|
+
list(dirID, options) {
|
|
89
|
+
return this._client.get(path `/dir/${dirID}/references`, options);
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=references.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.mjs","sourceRoot":"","sources":["../../src/resources/dir/references.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,MAAM,CAAC,KAAa,EAAE,IAA2B,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,QAAQ,KAAK,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,IAAY,EACZ,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,QAAQ,MAAM,eAAe,QAAQ,IAAI,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,KAAa,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,QAAQ,KAAK,aAAa,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}
|