retell-sdk 5.64.0 → 5.65.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 +30 -0
- package/README.md +29 -0
- package/client.d.mts +9 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -6
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agent.d.mts +43 -13
- package/resources/agent.d.mts.map +1 -1
- package/resources/agent.d.ts +43 -13
- package/resources/agent.d.ts.map +1 -1
- package/resources/agent.js +21 -2
- package/resources/agent.js.map +1 -1
- package/resources/agent.mjs +21 -2
- package/resources/agent.mjs.map +1 -1
- package/resources/app.d.mts +28 -46
- package/resources/app.d.mts.map +1 -1
- package/resources/app.d.ts +28 -46
- package/resources/app.d.ts.map +1 -1
- package/resources/app.js +7 -5
- package/resources/app.js.map +1 -1
- package/resources/app.mjs +7 -5
- package/resources/app.mjs.map +1 -1
- package/resources/asset.d.mts +53 -0
- package/resources/asset.d.mts.map +1 -0
- package/resources/asset.d.ts +53 -0
- package/resources/asset.d.ts.map +1 -0
- package/resources/asset.js +20 -0
- package/resources/asset.js.map +1 -0
- package/resources/asset.mjs +16 -0
- package/resources/asset.mjs.map +1 -0
- package/resources/batch-call.d.mts +4 -2
- package/resources/batch-call.d.mts.map +1 -1
- package/resources/batch-call.d.ts +4 -2
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/call.d.mts +155 -21
- package/resources/call.d.mts.map +1 -1
- package/resources/call.d.ts +155 -21
- package/resources/call.d.ts.map +1 -1
- package/resources/call.js +37 -5
- package/resources/call.js.map +1 -1
- package/resources/call.mjs +37 -5
- package/resources/call.mjs.map +1 -1
- package/resources/chat-agent.d.mts +2 -2
- package/resources/chat-agent.d.mts.map +1 -1
- package/resources/chat-agent.d.ts +2 -2
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/chat.d.mts +24 -11
- package/resources/chat.d.mts.map +1 -1
- package/resources/chat.d.ts +24 -11
- package/resources/chat.d.ts.map +1 -1
- package/resources/contact.d.mts +138 -10
- package/resources/contact.d.mts.map +1 -1
- package/resources/contact.d.ts +138 -10
- package/resources/contact.d.ts.map +1 -1
- package/resources/contact.js +23 -0
- package/resources/contact.js.map +1 -1
- package/resources/contact.mjs +23 -0
- package/resources/contact.mjs.map +1 -1
- package/resources/conversation-flow-component.d.mts +38 -2
- package/resources/conversation-flow-component.d.mts.map +1 -1
- package/resources/conversation-flow-component.d.ts +38 -2
- package/resources/conversation-flow-component.d.ts.map +1 -1
- package/resources/conversation-flow.d.mts +74 -2
- package/resources/conversation-flow.d.mts.map +1 -1
- package/resources/conversation-flow.d.ts +74 -2
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/crm.d.mts +4 -0
- package/resources/crm.d.mts.map +1 -1
- package/resources/crm.d.ts +4 -0
- package/resources/crm.d.ts.map +1 -1
- package/resources/export-request.d.mts +2 -2
- package/resources/export-request.d.mts.map +1 -1
- package/resources/export-request.d.ts +2 -2
- package/resources/export-request.d.ts.map +1 -1
- package/resources/index.d.mts +4 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/knowledge-base.d.mts +7 -7
- package/resources/knowledge-base.d.ts +7 -7
- package/resources/llm.d.mts +38 -2
- package/resources/llm.d.mts.map +1 -1
- package/resources/llm.d.ts +38 -2
- package/resources/llm.d.ts.map +1 -1
- package/resources/phone-number.d.mts +14 -8
- package/resources/phone-number.d.mts.map +1 -1
- package/resources/phone-number.d.ts +14 -8
- package/resources/phone-number.d.ts.map +1 -1
- package/resources/tests.d.mts +6 -6
- package/resources/tests.d.mts.map +1 -1
- package/resources/tests.d.ts +6 -6
- package/resources/tests.d.ts.map +1 -1
- package/resources/voice.d.mts +4 -4
- package/resources/voice.d.mts.map +1 -1
- package/resources/voice.d.ts +4 -4
- package/resources/voice.d.ts.map +1 -1
- package/src/client.ts +31 -0
- package/src/resources/agent.ts +60 -9
- package/src/resources/app.ts +29 -58
- package/src/resources/asset.ts +69 -0
- package/src/resources/batch-call.ts +6 -1
- package/src/resources/call.ts +196 -18
- package/src/resources/chat-agent.ts +2 -2
- package/src/resources/chat.ts +28 -11
- package/src/resources/contact.ts +187 -9
- package/src/resources/conversation-flow-component.ts +38 -2
- package/src/resources/conversation-flow.ts +74 -2
- package/src/resources/crm.ts +5 -0
- package/src/resources/export-request.ts +2 -2
- package/src/resources/index.ts +12 -0
- package/src/resources/knowledge-base.ts +7 -7
- package/src/resources/llm.ts +38 -2
- package/src/resources/phone-number.ts +14 -8
- package/src/resources/tests.ts +6 -6
- package/src/resources/voice.ts +4 -4
- 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
package/resources/contact.d.mts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { type Uploadable } from "../core/uploads.mjs";
|
|
3
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
5
|
export declare class Contact extends APIResource {
|
|
5
6
|
/**
|
|
@@ -28,6 +29,13 @@ export declare class Contact extends APIResource {
|
|
|
28
29
|
* historical call data. Only one backfill job can run per organization at a time.
|
|
29
30
|
*/
|
|
30
31
|
backfillAnalysisData(body: ContactBackfillAnalysisDataParams, options?: RequestOptions): APIPromise<ContactBackfillAnalysisDataResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* Start an incremental contact import from an uploaded CSV: creates new contacts
|
|
34
|
+
* and updates existing ones matched by phone number. Mapped columns overwrite the
|
|
35
|
+
* matched contact's fields; unmapped columns are ignored. Runs asynchronously —
|
|
36
|
+
* poll get-contact-import for progress.
|
|
37
|
+
*/
|
|
38
|
+
createImport(body: ContactCreateImportParams, options?: RequestOptions): APIPromise<ContactCreateImportResponse>;
|
|
31
39
|
/**
|
|
32
40
|
* Retrieve a contact by ID.
|
|
33
41
|
*/
|
|
@@ -41,12 +49,21 @@ export declare class Contact extends APIResource {
|
|
|
41
49
|
* in an organization.
|
|
42
50
|
*/
|
|
43
51
|
getByPhone(phoneNumber: string, options?: RequestOptions): APIPromise<ContactResponse>;
|
|
52
|
+
/**
|
|
53
|
+
* Status and counts for the org's current or latest contact import.
|
|
54
|
+
*/
|
|
55
|
+
getImport(options?: RequestOptions): APIPromise<ContactGetImportResponse>;
|
|
44
56
|
/**
|
|
45
57
|
* List a contact's conversations (inbound calls, outbound calls, and chats) merged
|
|
46
58
|
* into a single timeline, most recent first. Results are matched by the contact's
|
|
47
59
|
* phone number. Use the returned `pagination_key` to fetch the next page.
|
|
48
60
|
*/
|
|
49
61
|
listConversations(contactID: string, query?: ContactListConversationsParams | null | undefined, options?: RequestOptions): APIPromise<ContactListConversationsResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Upload a CSV file for a contact import. The file is stored privately and
|
|
64
|
+
* referenced by the returned upload_id in create-contact-import.
|
|
65
|
+
*/
|
|
66
|
+
uploadImportFile(body: ContactUploadImportFileParams, options?: RequestOptions): APIPromise<ContactUploadImportFileResponse>;
|
|
50
67
|
}
|
|
51
68
|
export interface ContactResponse {
|
|
52
69
|
/**
|
|
@@ -93,16 +110,23 @@ export interface ContactResponse {
|
|
|
93
110
|
* Last name of the contact.
|
|
94
111
|
*/
|
|
95
112
|
last_name?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Tags assigned to the contact.
|
|
115
|
+
*/
|
|
116
|
+
tags?: Array<string>;
|
|
96
117
|
/**
|
|
97
118
|
* Epoch milliseconds when the contact was last modified.
|
|
98
119
|
*/
|
|
99
120
|
user_modified_timestamp?: number;
|
|
100
121
|
}
|
|
101
122
|
export interface ContactListResponse {
|
|
102
|
-
has_more?: boolean;
|
|
103
|
-
items?: Array<ContactResponse>;
|
|
104
123
|
/**
|
|
105
|
-
*
|
|
124
|
+
* Whether more results are available.
|
|
125
|
+
*/
|
|
126
|
+
has_more: boolean;
|
|
127
|
+
items: Array<ContactResponse>;
|
|
128
|
+
/**
|
|
129
|
+
* Pagination key for the next page.
|
|
106
130
|
*/
|
|
107
131
|
pagination_key?: string;
|
|
108
132
|
/**
|
|
@@ -130,6 +154,26 @@ export interface ContactBackfillAnalysisDataResponse {
|
|
|
130
154
|
*/
|
|
131
155
|
triggered_by?: 'manual' | 'cron';
|
|
132
156
|
}
|
|
157
|
+
export interface ContactCreateImportResponse {
|
|
158
|
+
status: 'queued' | 'running' | 'idle';
|
|
159
|
+
/**
|
|
160
|
+
* Number of items that errored so far.
|
|
161
|
+
*/
|
|
162
|
+
failed?: number;
|
|
163
|
+
/**
|
|
164
|
+
* Epoch milliseconds when the job started.
|
|
165
|
+
*/
|
|
166
|
+
start_timestamp?: number;
|
|
167
|
+
/**
|
|
168
|
+
* Number of items processed successfully so far.
|
|
169
|
+
*/
|
|
170
|
+
succeeded?: number;
|
|
171
|
+
/**
|
|
172
|
+
* Whether the job was started by an explicit API call (`manual`) or by the
|
|
173
|
+
* scheduled sync (`cron`).
|
|
174
|
+
*/
|
|
175
|
+
triggered_by?: 'manual' | 'cron';
|
|
176
|
+
}
|
|
133
177
|
export interface ContactGetBackfillJobStatusResponse {
|
|
134
178
|
status: 'queued' | 'running' | 'idle';
|
|
135
179
|
/**
|
|
@@ -150,15 +194,34 @@ export interface ContactGetBackfillJobStatusResponse {
|
|
|
150
194
|
*/
|
|
151
195
|
triggered_by?: 'manual' | 'cron';
|
|
152
196
|
}
|
|
197
|
+
export interface ContactGetImportResponse {
|
|
198
|
+
status: 'queued' | 'running' | 'idle';
|
|
199
|
+
/**
|
|
200
|
+
* Number of items that errored so far.
|
|
201
|
+
*/
|
|
202
|
+
failed?: number;
|
|
203
|
+
/**
|
|
204
|
+
* Epoch milliseconds when the job started.
|
|
205
|
+
*/
|
|
206
|
+
start_timestamp?: number;
|
|
207
|
+
/**
|
|
208
|
+
* Number of items processed successfully so far.
|
|
209
|
+
*/
|
|
210
|
+
succeeded?: number;
|
|
211
|
+
/**
|
|
212
|
+
* Whether the job was started by an explicit API call (`manual`) or by the
|
|
213
|
+
* scheduled sync (`cron`).
|
|
214
|
+
*/
|
|
215
|
+
triggered_by?: 'manual' | 'cron';
|
|
216
|
+
}
|
|
153
217
|
export interface ContactListConversationsResponse {
|
|
154
218
|
/**
|
|
155
|
-
* Whether more
|
|
219
|
+
* Whether more results are available.
|
|
156
220
|
*/
|
|
157
|
-
has_more
|
|
158
|
-
items
|
|
221
|
+
has_more: boolean;
|
|
222
|
+
items: Array<ContactListConversationsResponse.ContactCall | ContactListConversationsResponse.ContactChat>;
|
|
159
223
|
/**
|
|
160
|
-
*
|
|
161
|
-
* fetch the next page.
|
|
224
|
+
* Pagination key for the next page.
|
|
162
225
|
*/
|
|
163
226
|
pagination_key?: string;
|
|
164
227
|
}
|
|
@@ -228,6 +291,10 @@ export declare namespace ContactListConversationsResponse {
|
|
|
228
291
|
summary?: string;
|
|
229
292
|
}
|
|
230
293
|
}
|
|
294
|
+
export interface ContactUploadImportFileResponse {
|
|
295
|
+
file_name?: string;
|
|
296
|
+
upload_id?: string;
|
|
297
|
+
}
|
|
231
298
|
export interface ContactCreateParams {
|
|
232
299
|
/**
|
|
233
300
|
* Phone number of the contact.
|
|
@@ -247,6 +314,10 @@ export interface ContactCreateParams {
|
|
|
247
314
|
* Last name of the contact.
|
|
248
315
|
*/
|
|
249
316
|
last_name?: string;
|
|
317
|
+
/**
|
|
318
|
+
* Full set of tags for the contact.
|
|
319
|
+
*/
|
|
320
|
+
tags?: Array<string>;
|
|
250
321
|
}
|
|
251
322
|
export interface ContactUpdateParams {
|
|
252
323
|
/**
|
|
@@ -263,6 +334,10 @@ export interface ContactUpdateParams {
|
|
|
263
334
|
* Last name of the contact.
|
|
264
335
|
*/
|
|
265
336
|
last_name?: string;
|
|
337
|
+
/**
|
|
338
|
+
* Full replacement set of tags for the contact.
|
|
339
|
+
*/
|
|
340
|
+
tags?: Array<string>;
|
|
266
341
|
}
|
|
267
342
|
export interface ContactListParams {
|
|
268
343
|
/**
|
|
@@ -325,6 +400,10 @@ export declare namespace ContactListParams {
|
|
|
325
400
|
* number.
|
|
326
401
|
*/
|
|
327
402
|
phone_number?: FilterCriteria.PhoneNumber;
|
|
403
|
+
/**
|
|
404
|
+
* Match contacts that have any of the listed tags.
|
|
405
|
+
*/
|
|
406
|
+
tags?: FilterCriteria.Tags;
|
|
328
407
|
}
|
|
329
408
|
namespace FilterCriteria {
|
|
330
409
|
interface ContactID {
|
|
@@ -462,6 +541,17 @@ export declare namespace ContactListParams {
|
|
|
462
541
|
type: 'string';
|
|
463
542
|
value: string;
|
|
464
543
|
}
|
|
544
|
+
/**
|
|
545
|
+
* Match contacts that have any of the listed tags.
|
|
546
|
+
*/
|
|
547
|
+
interface Tags {
|
|
548
|
+
/**
|
|
549
|
+
* in: value is one of the listed values
|
|
550
|
+
*/
|
|
551
|
+
op: 'in';
|
|
552
|
+
type: 'enum';
|
|
553
|
+
value: Array<string>;
|
|
554
|
+
}
|
|
465
555
|
}
|
|
466
556
|
}
|
|
467
557
|
export interface ContactBackfillAnalysisDataParams {
|
|
@@ -499,7 +589,7 @@ export declare namespace ContactBackfillAnalysisDataParams {
|
|
|
499
589
|
*/
|
|
500
590
|
agent_id: string;
|
|
501
591
|
/**
|
|
502
|
-
* Specific versions to filter on. If
|
|
592
|
+
* Specific versions to filter on. If omitted or empty, all versions are included.
|
|
503
593
|
*/
|
|
504
594
|
version?: Array<number>;
|
|
505
595
|
}
|
|
@@ -525,6 +615,41 @@ export declare namespace ContactBackfillAnalysisDataParams {
|
|
|
525
615
|
}
|
|
526
616
|
}
|
|
527
617
|
}
|
|
618
|
+
export interface ContactCreateImportParams {
|
|
619
|
+
/**
|
|
620
|
+
* CSV headers mapped to contact fields. field_name is the contact field and
|
|
621
|
+
* external_field_name is the CSV header. Exactly one mapping must target
|
|
622
|
+
* phone_number. Unmapped columns are ignored.
|
|
623
|
+
*/
|
|
624
|
+
column_mapping: Array<ContactCreateImportParams.ColumnMapping>;
|
|
625
|
+
/**
|
|
626
|
+
* Id returned by upload-contact-import-file.
|
|
627
|
+
*/
|
|
628
|
+
upload_id: string;
|
|
629
|
+
/**
|
|
630
|
+
* Country for parsing phone numbers without a country code. Defaults to US.
|
|
631
|
+
*/
|
|
632
|
+
default_country?: string;
|
|
633
|
+
/**
|
|
634
|
+
* Tags added to every contact in this import. Existing tags are preserved. Omit to
|
|
635
|
+
* leave tags unchanged.
|
|
636
|
+
*/
|
|
637
|
+
tags?: Array<string>;
|
|
638
|
+
}
|
|
639
|
+
export declare namespace ContactCreateImportParams {
|
|
640
|
+
interface ColumnMapping {
|
|
641
|
+
/**
|
|
642
|
+
* Field on the CRM's contact object to map to. A name that does not exist there
|
|
643
|
+
* surfaces as an error on the sync job rather than at configuration time.
|
|
644
|
+
*/
|
|
645
|
+
external_field_name: string;
|
|
646
|
+
/**
|
|
647
|
+
* Retell contact field, built-in or custom, to map. Types must be compatible with
|
|
648
|
+
* the CRM field on both sides of the sync.
|
|
649
|
+
*/
|
|
650
|
+
field_name: string;
|
|
651
|
+
}
|
|
652
|
+
}
|
|
528
653
|
export interface ContactListConversationsParams {
|
|
529
654
|
/**
|
|
530
655
|
* Maximum number of items to return.
|
|
@@ -535,7 +660,10 @@ export interface ContactListConversationsParams {
|
|
|
535
660
|
*/
|
|
536
661
|
pagination_key?: string;
|
|
537
662
|
}
|
|
663
|
+
export interface ContactUploadImportFileParams {
|
|
664
|
+
file: Uploadable;
|
|
665
|
+
}
|
|
538
666
|
export declare namespace Contact {
|
|
539
|
-
export { type ContactResponse as ContactResponse, type ContactListResponse as ContactListResponse, type ContactBackfillAnalysisDataResponse as ContactBackfillAnalysisDataResponse, type ContactGetBackfillJobStatusResponse as ContactGetBackfillJobStatusResponse, type ContactListConversationsResponse as ContactListConversationsResponse, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactBackfillAnalysisDataParams as ContactBackfillAnalysisDataParams, type ContactListConversationsParams as ContactListConversationsParams, };
|
|
667
|
+
export { type ContactResponse as ContactResponse, type ContactListResponse as ContactListResponse, type ContactBackfillAnalysisDataResponse as ContactBackfillAnalysisDataResponse, type ContactCreateImportResponse as ContactCreateImportResponse, type ContactGetBackfillJobStatusResponse as ContactGetBackfillJobStatusResponse, type ContactGetImportResponse as ContactGetImportResponse, type ContactListConversationsResponse as ContactListConversationsResponse, type ContactUploadImportFileResponse as ContactUploadImportFileResponse, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactBackfillAnalysisDataParams as ContactBackfillAnalysisDataParams, type ContactCreateImportParams as ContactCreateImportParams, type ContactListConversationsParams as ContactListConversationsParams, type ContactUploadImportFileParams as ContactUploadImportFileParams, };
|
|
540
668
|
}
|
|
541
669
|
//# sourceMappingURL=contact.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contact.d.mts","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;
|
|
1
|
+
{"version":3,"file":"contact.d.mts","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,KAAK,UAAU,EAAE,4BAAwB;AAElD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAI7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIxF;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;OAKG;IACH,IAAI,CACF,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrE;;;OAGG;IACH,oBAAoB,CAClB,IAAI,EAAE,iCAAiC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;OAKG;IACH,YAAY,CACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI7E;;OAEG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAItF;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIzE;;;;OAIG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;OAGG;IACH,gBAAgB,CACd,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAM/C;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,KAAK,EAAE,KAAK,CAAC,gCAAgC,CAAC,WAAW,GAAG,gCAAgC,CAAC,WAAW,CAAC,CAAC;IAE1G;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,WAAW;QAC1B,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QAEnC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;QAE5D;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,WAAW;QAC1B,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QAEnC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;QAE5D;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC7B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;;OAIG;IACH,UAAiB,cAAc;QAC7B,UAAU,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC;QAEtC;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CACjB,cAAc,CAAC,YAAY,GAC3B,cAAc,CAAC,YAAY,GAC3B,cAAc,CAAC,aAAa,GAC5B,cAAc,CAAC,WAAW,GAC1B,cAAc,CAAC,UAAU,GACzB,cAAc,CAAC,aAAa,CAC/B,CAAC;QAEF;;WAEG;QACH,WAAW,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC;QAEvC;;;WAGG;QACH,WAAW,CAAC,EAAE,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,aAAa,CAAC;QAEzE;;WAEG;QACH,2BAA2B,CAAC,EAAE,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,WAAW,CAAC;QAEvF;;;WAGG;QACH,YAAY,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC;QAE1C;;WAEG;QACH,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;KAC5B;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,SAAS;YACxB;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAE5C,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,aAAa;YAC5B,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,SAAS,CAAC;YAEhB,KAAK,EAAE,OAAO,CAAC;YAEf;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,OAAO,CAAC;YAEd;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC;YAEhB,IAAI,EAAE,SAAS,CAAC;YAEhB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,SAAS;YACxB,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,SAAS,CAAC;YAEhB,KAAK,EAAE,OAAO,CAAC;SAChB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC;YAEhB,IAAI,EAAE,SAAS,CAAC;SACjB;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAE5C,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,OAAO,CAAC;YAEd;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;QAED;;;WAGG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,CAAC,kBAAkB,CAAC;CAC7E;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAExC;;WAEG;QACH,eAAe,CAAC,EAAE,kBAAkB,CAAC,YAAY,GAAG,kBAAkB,CAAC,WAAW,CAAC;KACpF;IAED,UAAiB,kBAAkB,CAAC;QAClC,UAAiB,KAAK;YACpB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAE5C,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,OAAO,CAAC;YAEd;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;IAE/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,aAAa;QAC5B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
package/resources/contact.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { type Uploadable } from "../core/uploads.js";
|
|
3
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
4
5
|
export declare class Contact extends APIResource {
|
|
5
6
|
/**
|
|
@@ -28,6 +29,13 @@ export declare class Contact extends APIResource {
|
|
|
28
29
|
* historical call data. Only one backfill job can run per organization at a time.
|
|
29
30
|
*/
|
|
30
31
|
backfillAnalysisData(body: ContactBackfillAnalysisDataParams, options?: RequestOptions): APIPromise<ContactBackfillAnalysisDataResponse>;
|
|
32
|
+
/**
|
|
33
|
+
* Start an incremental contact import from an uploaded CSV: creates new contacts
|
|
34
|
+
* and updates existing ones matched by phone number. Mapped columns overwrite the
|
|
35
|
+
* matched contact's fields; unmapped columns are ignored. Runs asynchronously —
|
|
36
|
+
* poll get-contact-import for progress.
|
|
37
|
+
*/
|
|
38
|
+
createImport(body: ContactCreateImportParams, options?: RequestOptions): APIPromise<ContactCreateImportResponse>;
|
|
31
39
|
/**
|
|
32
40
|
* Retrieve a contact by ID.
|
|
33
41
|
*/
|
|
@@ -41,12 +49,21 @@ export declare class Contact extends APIResource {
|
|
|
41
49
|
* in an organization.
|
|
42
50
|
*/
|
|
43
51
|
getByPhone(phoneNumber: string, options?: RequestOptions): APIPromise<ContactResponse>;
|
|
52
|
+
/**
|
|
53
|
+
* Status and counts for the org's current or latest contact import.
|
|
54
|
+
*/
|
|
55
|
+
getImport(options?: RequestOptions): APIPromise<ContactGetImportResponse>;
|
|
44
56
|
/**
|
|
45
57
|
* List a contact's conversations (inbound calls, outbound calls, and chats) merged
|
|
46
58
|
* into a single timeline, most recent first. Results are matched by the contact's
|
|
47
59
|
* phone number. Use the returned `pagination_key` to fetch the next page.
|
|
48
60
|
*/
|
|
49
61
|
listConversations(contactID: string, query?: ContactListConversationsParams | null | undefined, options?: RequestOptions): APIPromise<ContactListConversationsResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Upload a CSV file for a contact import. The file is stored privately and
|
|
64
|
+
* referenced by the returned upload_id in create-contact-import.
|
|
65
|
+
*/
|
|
66
|
+
uploadImportFile(body: ContactUploadImportFileParams, options?: RequestOptions): APIPromise<ContactUploadImportFileResponse>;
|
|
50
67
|
}
|
|
51
68
|
export interface ContactResponse {
|
|
52
69
|
/**
|
|
@@ -93,16 +110,23 @@ export interface ContactResponse {
|
|
|
93
110
|
* Last name of the contact.
|
|
94
111
|
*/
|
|
95
112
|
last_name?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Tags assigned to the contact.
|
|
115
|
+
*/
|
|
116
|
+
tags?: Array<string>;
|
|
96
117
|
/**
|
|
97
118
|
* Epoch milliseconds when the contact was last modified.
|
|
98
119
|
*/
|
|
99
120
|
user_modified_timestamp?: number;
|
|
100
121
|
}
|
|
101
122
|
export interface ContactListResponse {
|
|
102
|
-
has_more?: boolean;
|
|
103
|
-
items?: Array<ContactResponse>;
|
|
104
123
|
/**
|
|
105
|
-
*
|
|
124
|
+
* Whether more results are available.
|
|
125
|
+
*/
|
|
126
|
+
has_more: boolean;
|
|
127
|
+
items: Array<ContactResponse>;
|
|
128
|
+
/**
|
|
129
|
+
* Pagination key for the next page.
|
|
106
130
|
*/
|
|
107
131
|
pagination_key?: string;
|
|
108
132
|
/**
|
|
@@ -130,6 +154,26 @@ export interface ContactBackfillAnalysisDataResponse {
|
|
|
130
154
|
*/
|
|
131
155
|
triggered_by?: 'manual' | 'cron';
|
|
132
156
|
}
|
|
157
|
+
export interface ContactCreateImportResponse {
|
|
158
|
+
status: 'queued' | 'running' | 'idle';
|
|
159
|
+
/**
|
|
160
|
+
* Number of items that errored so far.
|
|
161
|
+
*/
|
|
162
|
+
failed?: number;
|
|
163
|
+
/**
|
|
164
|
+
* Epoch milliseconds when the job started.
|
|
165
|
+
*/
|
|
166
|
+
start_timestamp?: number;
|
|
167
|
+
/**
|
|
168
|
+
* Number of items processed successfully so far.
|
|
169
|
+
*/
|
|
170
|
+
succeeded?: number;
|
|
171
|
+
/**
|
|
172
|
+
* Whether the job was started by an explicit API call (`manual`) or by the
|
|
173
|
+
* scheduled sync (`cron`).
|
|
174
|
+
*/
|
|
175
|
+
triggered_by?: 'manual' | 'cron';
|
|
176
|
+
}
|
|
133
177
|
export interface ContactGetBackfillJobStatusResponse {
|
|
134
178
|
status: 'queued' | 'running' | 'idle';
|
|
135
179
|
/**
|
|
@@ -150,15 +194,34 @@ export interface ContactGetBackfillJobStatusResponse {
|
|
|
150
194
|
*/
|
|
151
195
|
triggered_by?: 'manual' | 'cron';
|
|
152
196
|
}
|
|
197
|
+
export interface ContactGetImportResponse {
|
|
198
|
+
status: 'queued' | 'running' | 'idle';
|
|
199
|
+
/**
|
|
200
|
+
* Number of items that errored so far.
|
|
201
|
+
*/
|
|
202
|
+
failed?: number;
|
|
203
|
+
/**
|
|
204
|
+
* Epoch milliseconds when the job started.
|
|
205
|
+
*/
|
|
206
|
+
start_timestamp?: number;
|
|
207
|
+
/**
|
|
208
|
+
* Number of items processed successfully so far.
|
|
209
|
+
*/
|
|
210
|
+
succeeded?: number;
|
|
211
|
+
/**
|
|
212
|
+
* Whether the job was started by an explicit API call (`manual`) or by the
|
|
213
|
+
* scheduled sync (`cron`).
|
|
214
|
+
*/
|
|
215
|
+
triggered_by?: 'manual' | 'cron';
|
|
216
|
+
}
|
|
153
217
|
export interface ContactListConversationsResponse {
|
|
154
218
|
/**
|
|
155
|
-
* Whether more
|
|
219
|
+
* Whether more results are available.
|
|
156
220
|
*/
|
|
157
|
-
has_more
|
|
158
|
-
items
|
|
221
|
+
has_more: boolean;
|
|
222
|
+
items: Array<ContactListConversationsResponse.ContactCall | ContactListConversationsResponse.ContactChat>;
|
|
159
223
|
/**
|
|
160
|
-
*
|
|
161
|
-
* fetch the next page.
|
|
224
|
+
* Pagination key for the next page.
|
|
162
225
|
*/
|
|
163
226
|
pagination_key?: string;
|
|
164
227
|
}
|
|
@@ -228,6 +291,10 @@ export declare namespace ContactListConversationsResponse {
|
|
|
228
291
|
summary?: string;
|
|
229
292
|
}
|
|
230
293
|
}
|
|
294
|
+
export interface ContactUploadImportFileResponse {
|
|
295
|
+
file_name?: string;
|
|
296
|
+
upload_id?: string;
|
|
297
|
+
}
|
|
231
298
|
export interface ContactCreateParams {
|
|
232
299
|
/**
|
|
233
300
|
* Phone number of the contact.
|
|
@@ -247,6 +314,10 @@ export interface ContactCreateParams {
|
|
|
247
314
|
* Last name of the contact.
|
|
248
315
|
*/
|
|
249
316
|
last_name?: string;
|
|
317
|
+
/**
|
|
318
|
+
* Full set of tags for the contact.
|
|
319
|
+
*/
|
|
320
|
+
tags?: Array<string>;
|
|
250
321
|
}
|
|
251
322
|
export interface ContactUpdateParams {
|
|
252
323
|
/**
|
|
@@ -263,6 +334,10 @@ export interface ContactUpdateParams {
|
|
|
263
334
|
* Last name of the contact.
|
|
264
335
|
*/
|
|
265
336
|
last_name?: string;
|
|
337
|
+
/**
|
|
338
|
+
* Full replacement set of tags for the contact.
|
|
339
|
+
*/
|
|
340
|
+
tags?: Array<string>;
|
|
266
341
|
}
|
|
267
342
|
export interface ContactListParams {
|
|
268
343
|
/**
|
|
@@ -325,6 +400,10 @@ export declare namespace ContactListParams {
|
|
|
325
400
|
* number.
|
|
326
401
|
*/
|
|
327
402
|
phone_number?: FilterCriteria.PhoneNumber;
|
|
403
|
+
/**
|
|
404
|
+
* Match contacts that have any of the listed tags.
|
|
405
|
+
*/
|
|
406
|
+
tags?: FilterCriteria.Tags;
|
|
328
407
|
}
|
|
329
408
|
namespace FilterCriteria {
|
|
330
409
|
interface ContactID {
|
|
@@ -462,6 +541,17 @@ export declare namespace ContactListParams {
|
|
|
462
541
|
type: 'string';
|
|
463
542
|
value: string;
|
|
464
543
|
}
|
|
544
|
+
/**
|
|
545
|
+
* Match contacts that have any of the listed tags.
|
|
546
|
+
*/
|
|
547
|
+
interface Tags {
|
|
548
|
+
/**
|
|
549
|
+
* in: value is one of the listed values
|
|
550
|
+
*/
|
|
551
|
+
op: 'in';
|
|
552
|
+
type: 'enum';
|
|
553
|
+
value: Array<string>;
|
|
554
|
+
}
|
|
465
555
|
}
|
|
466
556
|
}
|
|
467
557
|
export interface ContactBackfillAnalysisDataParams {
|
|
@@ -499,7 +589,7 @@ export declare namespace ContactBackfillAnalysisDataParams {
|
|
|
499
589
|
*/
|
|
500
590
|
agent_id: string;
|
|
501
591
|
/**
|
|
502
|
-
* Specific versions to filter on. If
|
|
592
|
+
* Specific versions to filter on. If omitted or empty, all versions are included.
|
|
503
593
|
*/
|
|
504
594
|
version?: Array<number>;
|
|
505
595
|
}
|
|
@@ -525,6 +615,41 @@ export declare namespace ContactBackfillAnalysisDataParams {
|
|
|
525
615
|
}
|
|
526
616
|
}
|
|
527
617
|
}
|
|
618
|
+
export interface ContactCreateImportParams {
|
|
619
|
+
/**
|
|
620
|
+
* CSV headers mapped to contact fields. field_name is the contact field and
|
|
621
|
+
* external_field_name is the CSV header. Exactly one mapping must target
|
|
622
|
+
* phone_number. Unmapped columns are ignored.
|
|
623
|
+
*/
|
|
624
|
+
column_mapping: Array<ContactCreateImportParams.ColumnMapping>;
|
|
625
|
+
/**
|
|
626
|
+
* Id returned by upload-contact-import-file.
|
|
627
|
+
*/
|
|
628
|
+
upload_id: string;
|
|
629
|
+
/**
|
|
630
|
+
* Country for parsing phone numbers without a country code. Defaults to US.
|
|
631
|
+
*/
|
|
632
|
+
default_country?: string;
|
|
633
|
+
/**
|
|
634
|
+
* Tags added to every contact in this import. Existing tags are preserved. Omit to
|
|
635
|
+
* leave tags unchanged.
|
|
636
|
+
*/
|
|
637
|
+
tags?: Array<string>;
|
|
638
|
+
}
|
|
639
|
+
export declare namespace ContactCreateImportParams {
|
|
640
|
+
interface ColumnMapping {
|
|
641
|
+
/**
|
|
642
|
+
* Field on the CRM's contact object to map to. A name that does not exist there
|
|
643
|
+
* surfaces as an error on the sync job rather than at configuration time.
|
|
644
|
+
*/
|
|
645
|
+
external_field_name: string;
|
|
646
|
+
/**
|
|
647
|
+
* Retell contact field, built-in or custom, to map. Types must be compatible with
|
|
648
|
+
* the CRM field on both sides of the sync.
|
|
649
|
+
*/
|
|
650
|
+
field_name: string;
|
|
651
|
+
}
|
|
652
|
+
}
|
|
528
653
|
export interface ContactListConversationsParams {
|
|
529
654
|
/**
|
|
530
655
|
* Maximum number of items to return.
|
|
@@ -535,7 +660,10 @@ export interface ContactListConversationsParams {
|
|
|
535
660
|
*/
|
|
536
661
|
pagination_key?: string;
|
|
537
662
|
}
|
|
663
|
+
export interface ContactUploadImportFileParams {
|
|
664
|
+
file: Uploadable;
|
|
665
|
+
}
|
|
538
666
|
export declare namespace Contact {
|
|
539
|
-
export { type ContactResponse as ContactResponse, type ContactListResponse as ContactListResponse, type ContactBackfillAnalysisDataResponse as ContactBackfillAnalysisDataResponse, type ContactGetBackfillJobStatusResponse as ContactGetBackfillJobStatusResponse, type ContactListConversationsResponse as ContactListConversationsResponse, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactBackfillAnalysisDataParams as ContactBackfillAnalysisDataParams, type ContactListConversationsParams as ContactListConversationsParams, };
|
|
667
|
+
export { type ContactResponse as ContactResponse, type ContactListResponse as ContactListResponse, type ContactBackfillAnalysisDataResponse as ContactBackfillAnalysisDataResponse, type ContactCreateImportResponse as ContactCreateImportResponse, type ContactGetBackfillJobStatusResponse as ContactGetBackfillJobStatusResponse, type ContactGetImportResponse as ContactGetImportResponse, type ContactListConversationsResponse as ContactListConversationsResponse, type ContactUploadImportFileResponse as ContactUploadImportFileResponse, type ContactCreateParams as ContactCreateParams, type ContactUpdateParams as ContactUpdateParams, type ContactListParams as ContactListParams, type ContactBackfillAnalysisDataParams as ContactBackfillAnalysisDataParams, type ContactCreateImportParams as ContactCreateImportParams, type ContactListConversationsParams as ContactListConversationsParams, type ContactUploadImportFileParams as ContactUploadImportFileParams, };
|
|
540
668
|
}
|
|
541
669
|
//# sourceMappingURL=contact.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contact.d.ts","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;
|
|
1
|
+
{"version":3,"file":"contact.d.ts","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,KAAK,UAAU,EAAE,2BAAwB;AAElD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAI7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIxF;;OAEG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;OAKG;IACH,IAAI,CACF,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrE;;;OAGG;IACH,oBAAoB,CAClB,IAAI,EAAE,iCAAiC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;OAKG;IACH,YAAY,CACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAI7E;;OAEG;IACH,oBAAoB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;;OAGG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAItF;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIzE;;;;OAIG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;OAGG;IACH,gBAAgB,CACd,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAM/C;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,KAAK,EAAE,KAAK,CAAC,gCAAgC,CAAC,WAAW,GAAG,gCAAgC,CAAC,WAAW,CAAC,CAAC;IAE1G;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,WAAW;QAC1B,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QAEnC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;QAE5D;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,WAAW;QAC1B,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;QAEnC;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;QAE5D;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC7B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;;OAIG;IACH,UAAiB,cAAc;QAC7B,UAAU,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC;QAEtC;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CACjB,cAAc,CAAC,YAAY,GAC3B,cAAc,CAAC,YAAY,GAC3B,cAAc,CAAC,aAAa,GAC5B,cAAc,CAAC,WAAW,GAC1B,cAAc,CAAC,UAAU,GACzB,cAAc,CAAC,aAAa,CAC/B,CAAC;QAEF;;WAEG;QACH,WAAW,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC;QAEvC;;;WAGG;QACH,WAAW,CAAC,EAAE,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,aAAa,CAAC;QAEzE;;WAEG;QACH,2BAA2B,CAAC,EAAE,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,WAAW,CAAC;QAEvF;;;WAGG;QACH,YAAY,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC;QAE1C;;WAEG;QACH,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;KAC5B;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,SAAS;YACxB;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAE5C,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,aAAa;YAC5B,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,SAAS,CAAC;YAEhB,KAAK,EAAE,OAAO,CAAC;YAEf;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,OAAO,CAAC;YAEd;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAErB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC;YAEhB,IAAI,EAAE,SAAS,CAAC;YAEhB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,SAAS;YACxB,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,SAAS,CAAC;YAEhB,KAAK,EAAE,OAAO,CAAC;SAChB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC;YAEhB,IAAI,EAAE,SAAS,CAAC;SACjB;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAE5C,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,OAAO,CAAC;YAEd;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;QAED;;;WAGG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAErC,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,CAAC,kBAAkB,CAAC;CAC7E;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAExC;;WAEG;QACH,eAAe,CAAC,EAAE,kBAAkB,CAAC,YAAY,GAAG,kBAAkB,CAAC,WAAW,CAAC;KACpF;IAED,UAAiB,kBAAkB,CAAC;QAClC,UAAiB,KAAK;YACpB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACzB;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,EAAE,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;YAE5C,IAAI,EAAE,QAAQ,CAAC;YAEf,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,IAAI,CAAC;YAET,IAAI,EAAE,OAAO,CAAC;YAEd;;eAEG;YACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;IAE/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,aAAa;QAC5B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
package/resources/contact.js
CHANGED
|
@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.Contact = void 0;
|
|
5
5
|
const resource_1 = require("../core/resource.js");
|
|
6
6
|
const headers_1 = require("../internal/headers.js");
|
|
7
|
+
const uploads_1 = require("../internal/uploads.js");
|
|
7
8
|
const path_1 = require("../internal/utils/path.js");
|
|
8
9
|
class Contact extends resource_1.APIResource {
|
|
9
10
|
/**
|
|
@@ -45,6 +46,15 @@ class Contact extends resource_1.APIResource {
|
|
|
45
46
|
backfillAnalysisData(body, options) {
|
|
46
47
|
return this._client.post('/backfill-contact-analysis-data', { body, ...options });
|
|
47
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* Start an incremental contact import from an uploaded CSV: creates new contacts
|
|
51
|
+
* and updates existing ones matched by phone number. Mapped columns overwrite the
|
|
52
|
+
* matched contact's fields; unmapped columns are ignored. Runs asynchronously —
|
|
53
|
+
* poll get-contact-import for progress.
|
|
54
|
+
*/
|
|
55
|
+
createImport(body, options) {
|
|
56
|
+
return this._client.post('/create-contact-import', { body, ...options });
|
|
57
|
+
}
|
|
48
58
|
/**
|
|
49
59
|
* Retrieve a contact by ID.
|
|
50
60
|
*/
|
|
@@ -64,6 +74,12 @@ class Contact extends resource_1.APIResource {
|
|
|
64
74
|
getByPhone(phoneNumber, options) {
|
|
65
75
|
return this._client.get((0, path_1.path) `/get-contact-by-phone/${phoneNumber}`, options);
|
|
66
76
|
}
|
|
77
|
+
/**
|
|
78
|
+
* Status and counts for the org's current or latest contact import.
|
|
79
|
+
*/
|
|
80
|
+
getImport(options) {
|
|
81
|
+
return this._client.get('/get-contact-import', options);
|
|
82
|
+
}
|
|
67
83
|
/**
|
|
68
84
|
* List a contact's conversations (inbound calls, outbound calls, and chats) merged
|
|
69
85
|
* into a single timeline, most recent first. Results are matched by the contact's
|
|
@@ -72,6 +88,13 @@ class Contact extends resource_1.APIResource {
|
|
|
72
88
|
listConversations(contactID, query = {}, options) {
|
|
73
89
|
return this._client.get((0, path_1.path) `/list-contact-conversations/${contactID}`, { query, ...options });
|
|
74
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* Upload a CSV file for a contact import. The file is stored privately and
|
|
93
|
+
* referenced by the returned upload_id in create-contact-import.
|
|
94
|
+
*/
|
|
95
|
+
uploadImportFile(body, options) {
|
|
96
|
+
return this._client.post('/upload-contact-import-file', (0, uploads_1.multipartFormRequestOptions)({ body, ...options }, this._client));
|
|
97
|
+
}
|
|
75
98
|
}
|
|
76
99
|
exports.Contact = Contact;
|
|
77
100
|
//# sourceMappingURL=contact.js.map
|
package/resources/contact.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contact.js","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;
|
|
1
|
+
{"version":3,"file":"contact.js","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAAmD;AAEnD,oDAAkE;AAClE,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACH,IAAI,CACF,OAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAClB,IAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,WAAmB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,SAAiB,EACjB,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,6BAA6B,EAC7B,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF;AA3HD,0BA2HC"}
|