@getlatedev/node 0.2.309 → 0.2.311
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/README.md +70 -0
- package/dist/index.d.mts +2514 -466
- package/dist/index.d.ts +2514 -466
- package/dist/index.js +412 -9
- package/dist/index.mjs +412 -9
- package/package.json +1 -1
- package/src/client.ts +135 -3
- package/src/generated/sdk.gen.ts +1057 -29
- package/src/generated/types.gen.ts +2631 -494
package/dist/index.d.ts
CHANGED
|
@@ -130,7 +130,10 @@ declare class Zernio {
|
|
|
130
130
|
*/
|
|
131
131
|
usage: {
|
|
132
132
|
getXApiPricing: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<XApiPricing, GetXApiPricingError, ThrowOnError>;
|
|
133
|
+
getUsage: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetUsageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UsageStats, unknown, ThrowOnError>;
|
|
133
134
|
getUsageStats: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetUsageStatsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UsageStats, unknown, ThrowOnError>;
|
|
135
|
+
getCallsUsage: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetCallsUsageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCallsUsageResponse, unknown, ThrowOnError>;
|
|
136
|
+
getSmsUsage: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<GetSmsUsageData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSmsUsageResponse, unknown, ThrowOnError>;
|
|
134
137
|
};
|
|
135
138
|
/**
|
|
136
139
|
* Posts API - Create, schedule, and manage social media posts
|
|
@@ -475,14 +478,60 @@ declare class Zernio {
|
|
|
475
478
|
*/
|
|
476
479
|
whatsappcalling: {
|
|
477
480
|
getWhatsAppCallingConfig: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallingConfigData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallingConfigResponse, unknown, ThrowOnError>;
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
+
enableWhatsAppCallingLegacy: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableWhatsAppCallingLegacyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableWhatsAppCallingLegacyResponse, unknown, ThrowOnError>;
|
|
482
|
+
updateWhatsAppCallingLegacy: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppCallingLegacyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
483
|
+
disableWhatsAppCallingLegacy: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableWhatsAppCallingLegacyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
481
484
|
getWhatsAppCallPermissions: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallPermissionsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallPermissionsResponse, unknown, ThrowOnError>;
|
|
482
485
|
initiateWhatsAppCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<InitiateWhatsAppCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<InitiateWhatsAppCallResponse, unknown, ThrowOnError>;
|
|
483
486
|
listWhatsAppCalls: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListWhatsAppCallsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListWhatsAppCallsResponse, ListWhatsAppCallsError, ThrowOnError>;
|
|
484
487
|
getWhatsAppCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallResponse, unknown, ThrowOnError>;
|
|
488
|
+
getWhatsAppCallRecording: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallRecordingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallRecordingResponse, unknown, ThrowOnError>;
|
|
485
489
|
getWhatsAppCallEstimate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallEstimateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallEstimateResponse, GetWhatsAppCallEstimateError, ThrowOnError>;
|
|
490
|
+
getWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppCallingResponse, unknown, ThrowOnError>;
|
|
491
|
+
enableWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableWhatsAppCallingResponse, unknown, ThrowOnError>;
|
|
492
|
+
updateWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
493
|
+
disableWhatsAppCalling: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableWhatsAppCallingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
494
|
+
};
|
|
495
|
+
/**
|
|
496
|
+
* calls API
|
|
497
|
+
*/
|
|
498
|
+
calls: {
|
|
499
|
+
listCalls: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCallsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCallsResponse, unknown, ThrowOnError>;
|
|
500
|
+
getCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCallResponse, unknown, ThrowOnError>;
|
|
501
|
+
getCallRecording: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCallRecordingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCallRecordingResponse, unknown, ThrowOnError>;
|
|
502
|
+
};
|
|
503
|
+
/**
|
|
504
|
+
* voice API
|
|
505
|
+
*/
|
|
506
|
+
voice: {
|
|
507
|
+
createVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateVoiceCallResponse, unknown, ThrowOnError>;
|
|
508
|
+
listVoiceCalls: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListVoiceCallsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListVoiceCallsResponse, ListVoiceCallsError, ThrowOnError>;
|
|
509
|
+
getVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetVoiceCallResponse, unknown, ThrowOnError>;
|
|
510
|
+
endVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EndVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EndVoiceCallResponse, unknown, ThrowOnError>;
|
|
511
|
+
getVoiceCallRecording: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetVoiceCallRecordingData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetVoiceCallRecordingResponse, unknown, ThrowOnError>;
|
|
512
|
+
transferVoiceCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<TransferVoiceCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransferVoiceCallResponse, unknown, ThrowOnError>;
|
|
513
|
+
getVoiceCallEstimate: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetVoiceCallEstimateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetVoiceCallEstimateResponse, GetVoiceCallEstimateError, ThrowOnError>;
|
|
514
|
+
createVoiceWebSession: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateVoiceWebSessionResponse, unknown, ThrowOnError>;
|
|
515
|
+
dialVoiceWebCall: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DialVoiceWebCallData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DialVoiceWebCallResponse, unknown, ThrowOnError>;
|
|
516
|
+
enableVoiceOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableVoiceOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableVoiceOnNumberResponse, unknown, ThrowOnError>;
|
|
517
|
+
disableVoiceOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableVoiceOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DisableVoiceOnNumberResponse, unknown, ThrowOnError>;
|
|
518
|
+
};
|
|
519
|
+
/**
|
|
520
|
+
* sms API
|
|
521
|
+
*/
|
|
522
|
+
sms: {
|
|
523
|
+
sendSms: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendSmsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendSmsResponse, unknown, ThrowOnError>;
|
|
524
|
+
lookupSmsNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<LookupSmsNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<LookupSmsNumberResponse, unknown, ThrowOnError>;
|
|
525
|
+
listSmsOptOuts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSmsOptOutsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSmsOptOutsResponse, ListSmsOptOutsError, ThrowOnError>;
|
|
526
|
+
startSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<StartSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<StartSmsRegistrationResponse, unknown, ThrowOnError>;
|
|
527
|
+
listSmsRegistrations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSmsRegistrationsResponse, ListSmsRegistrationsError, ThrowOnError>;
|
|
528
|
+
getSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSmsRegistrationResponse, unknown, ThrowOnError>;
|
|
529
|
+
verifySmsRegistrationOtp: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<VerifySmsRegistrationOtpData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<VerifySmsRegistrationOtpResponse, unknown, ThrowOnError>;
|
|
530
|
+
appealSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AppealSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AppealSmsRegistrationResponse, unknown, ThrowOnError>;
|
|
531
|
+
shareSmsRegistration: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ShareSmsRegistrationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ShareSmsRegistrationResponse, unknown, ThrowOnError>;
|
|
532
|
+
enableSmsOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnableSmsOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnableSmsOnNumberResponse, unknown, ThrowOnError>;
|
|
533
|
+
disableSmsOnNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DisableSmsOnNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DisableSmsOnNumberResponse, unknown, ThrowOnError>;
|
|
534
|
+
reuseSmsRegistrationForNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReuseSmsRegistrationForNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReuseSmsRegistrationForNumberResponse, unknown, ThrowOnError>;
|
|
486
535
|
};
|
|
487
536
|
/**
|
|
488
537
|
* whatsapptemplates API
|
|
@@ -510,6 +559,31 @@ declare class Zernio {
|
|
|
510
559
|
getWhatsAppPhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetWhatsAppPhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetWhatsAppPhoneNumberResponse, GetWhatsAppPhoneNumberError, ThrowOnError>;
|
|
511
560
|
releaseWhatsAppPhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReleaseWhatsAppPhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleaseWhatsAppPhoneNumberResponse, unknown, ThrowOnError>;
|
|
512
561
|
};
|
|
562
|
+
/**
|
|
563
|
+
* phonenumbers API
|
|
564
|
+
*/
|
|
565
|
+
phonenumbers: {
|
|
566
|
+
listPhoneNumbers: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListPhoneNumbersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumbersResponse, ListPhoneNumbersError, ThrowOnError>;
|
|
567
|
+
getPhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberResponse, GetPhoneNumberError, ThrowOnError>;
|
|
568
|
+
releasePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReleasePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReleasePhoneNumberResponse, unknown, ThrowOnError>;
|
|
569
|
+
purchasePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PurchasePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PurchasePhoneNumberResponse, unknown, ThrowOnError>;
|
|
570
|
+
listPhoneNumberCountries: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumberCountriesResponse, ListPhoneNumberCountriesError, ThrowOnError>;
|
|
571
|
+
searchAvailablePhoneNumbers: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<SearchAvailablePhoneNumbersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SearchAvailablePhoneNumbersResponse, unknown, ThrowOnError>;
|
|
572
|
+
checkPhoneNumberAvailability: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CheckPhoneNumberAvailabilityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CheckPhoneNumberAvailabilityResponse, unknown, ThrowOnError>;
|
|
573
|
+
getPhoneNumberKycForm: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberKycFormData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberKycFormResponse, unknown, ThrowOnError>;
|
|
574
|
+
submitPhoneNumberKyc: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SubmitPhoneNumberKycData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SubmitPhoneNumberKycResponse, unknown, ThrowOnError>;
|
|
575
|
+
uploadPhoneNumberKycDocument: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadPhoneNumberKycDocumentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadPhoneNumberKycDocumentResponse, unknown, ThrowOnError>;
|
|
576
|
+
validatePhoneNumberKycAddress: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ValidatePhoneNumberKycAddressData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ValidatePhoneNumberKycAddressResponse, ValidatePhoneNumberKycAddressError, ThrowOnError>;
|
|
577
|
+
createPhoneNumberKycLink: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberKycLinkData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreatePhoneNumberKycLinkResponse, unknown, ThrowOnError>;
|
|
578
|
+
createPhoneNumberPortIn: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreatePhoneNumberPortInData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreatePhoneNumberPortInResponse, unknown, ThrowOnError>;
|
|
579
|
+
listPhoneNumberPortIns: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListPhoneNumberPortInsResponse, ListPhoneNumberPortInsError, ThrowOnError>;
|
|
580
|
+
checkPhoneNumberPortability: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CheckPhoneNumberPortabilityData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CheckPhoneNumberPortabilityResponse, CheckPhoneNumberPortabilityError, ThrowOnError>;
|
|
581
|
+
uploadPhoneNumberPortInDocument: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UploadPhoneNumberPortInDocumentData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UploadPhoneNumberPortInDocumentResponse, unknown, ThrowOnError>;
|
|
582
|
+
cancelPhoneNumberPortIn: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelPhoneNumberPortInData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CancelPhoneNumberPortInResponse, unknown, ThrowOnError>;
|
|
583
|
+
reviewPhoneNumberKycPacket: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ReviewPhoneNumberKycPacketData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ReviewPhoneNumberKycPacketResponse, ReviewPhoneNumberKycPacketError, ThrowOnError>;
|
|
584
|
+
getPhoneNumberRemediation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetPhoneNumberRemediationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetPhoneNumberRemediationResponse, unknown, ThrowOnError>;
|
|
585
|
+
remediatePhoneNumber: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<RemediatePhoneNumberData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RemediatePhoneNumberResponse, unknown, ThrowOnError>;
|
|
586
|
+
};
|
|
513
587
|
/**
|
|
514
588
|
* whatsappsandbox API
|
|
515
589
|
*/
|
|
@@ -1657,6 +1731,141 @@ type BusinessCenter = {
|
|
|
1657
1731
|
*/
|
|
1658
1732
|
advertiserCount?: (number) | null;
|
|
1659
1733
|
};
|
|
1734
|
+
/**
|
|
1735
|
+
* One call on a number you own, either channel. `channel` tells you which
|
|
1736
|
+
* lane it took: `whatsapp` (WhatsApp Business Calling) or `pstn` (a regular
|
|
1737
|
+
* phone call). List endpoints omit `transcript`; use `lastTranscriptSnippet`
|
|
1738
|
+
* for a preview and the detail endpoint for the full transcript.
|
|
1739
|
+
*
|
|
1740
|
+
*/
|
|
1741
|
+
type CallRecord = {
|
|
1742
|
+
_id?: string;
|
|
1743
|
+
/**
|
|
1744
|
+
* Owning social account. The unified /v1/calls/{id} detail + recording endpoints work for any channel; the channel-specific endpoints remain for account-scoped access.
|
|
1745
|
+
*/
|
|
1746
|
+
accountId?: string;
|
|
1747
|
+
/**
|
|
1748
|
+
* Inbox conversation with the counterparty, when one exists.
|
|
1749
|
+
*/
|
|
1750
|
+
conversationId?: (string) | null;
|
|
1751
|
+
/**
|
|
1752
|
+
* CRM Contact for the counterparty, when resolved.
|
|
1753
|
+
*/
|
|
1754
|
+
contactId?: (string) | null;
|
|
1755
|
+
channel?: 'whatsapp' | 'pstn';
|
|
1756
|
+
direction?: 'inbound' | 'outbound';
|
|
1757
|
+
/**
|
|
1758
|
+
* Caller number (E.164).
|
|
1759
|
+
*/
|
|
1760
|
+
from?: string;
|
|
1761
|
+
/**
|
|
1762
|
+
* Callee number (E.164).
|
|
1763
|
+
*/
|
|
1764
|
+
to?: string;
|
|
1765
|
+
/**
|
|
1766
|
+
* Destination the call was routed to (tel:/sip:/wss:), snapshotted at routing time.
|
|
1767
|
+
*/
|
|
1768
|
+
forwardTo?: (string) | null;
|
|
1769
|
+
/**
|
|
1770
|
+
* Outbound PSTN only. Message spoken to the callee on answer, before the bridge.
|
|
1771
|
+
*/
|
|
1772
|
+
greeting?: (string) | null;
|
|
1773
|
+
status?: 'ringing' | 'answered' | 'ended' | 'failed';
|
|
1774
|
+
/**
|
|
1775
|
+
* True when an inbound call went to voicemail.
|
|
1776
|
+
*/
|
|
1777
|
+
isVoicemail?: boolean;
|
|
1778
|
+
/**
|
|
1779
|
+
* Outbound answering-machine detection was requested for this call.
|
|
1780
|
+
*/
|
|
1781
|
+
amd?: boolean;
|
|
1782
|
+
/**
|
|
1783
|
+
* With `amd`, whether a machine (vs a human) answered.
|
|
1784
|
+
*/
|
|
1785
|
+
answeredMachine?: (boolean) | null;
|
|
1786
|
+
/**
|
|
1787
|
+
* Caller ID presented on the forwarded leg.
|
|
1788
|
+
*/
|
|
1789
|
+
forwardCallerId?: 'business' | 'caller';
|
|
1790
|
+
/**
|
|
1791
|
+
* Effective flag for THIS call (number default + per-call override, resolved at create time).
|
|
1792
|
+
*/
|
|
1793
|
+
recordingEnabled?: boolean;
|
|
1794
|
+
transcriptionEnabled?: boolean;
|
|
1795
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
1796
|
+
startedAt?: string;
|
|
1797
|
+
answeredAt?: (string) | null;
|
|
1798
|
+
endedAt?: (string) | null;
|
|
1799
|
+
/**
|
|
1800
|
+
* When the call was blind-transferred (POST /v1/voice/calls/{id}/transfer).
|
|
1801
|
+
*/
|
|
1802
|
+
transferredAt?: (string) | null;
|
|
1803
|
+
durationSeconds?: number;
|
|
1804
|
+
endReason?: 'hangup' | 'no_answer' | 'rejected' | 'error';
|
|
1805
|
+
/**
|
|
1806
|
+
* Raw carrier hangup cause behind endReason (e.g. normal_clearing, not_found, time_limit) — the actual motive when endReason is a coarse bucket.
|
|
1807
|
+
*/
|
|
1808
|
+
hangupCause?: (string) | null;
|
|
1809
|
+
/**
|
|
1810
|
+
* SIP response code that ended the call, when SIP-signalled (e.g. '403', '488'). The real failure reason for SIP legs.
|
|
1811
|
+
*/
|
|
1812
|
+
sipHangupCause?: (string) | null;
|
|
1813
|
+
/**
|
|
1814
|
+
* Per-call failure log (dial failed, bridge failed, recording error).
|
|
1815
|
+
*/
|
|
1816
|
+
callErrors?: Array<{
|
|
1817
|
+
code?: number;
|
|
1818
|
+
message?: string;
|
|
1819
|
+
}>;
|
|
1820
|
+
/**
|
|
1821
|
+
* May be expired. Resolve a fresh playable URL via GET /v1/calls/{id}/recording (any channel).
|
|
1822
|
+
*/
|
|
1823
|
+
recordingUrl?: (string) | null;
|
|
1824
|
+
/**
|
|
1825
|
+
* Most recent transcript segment, for list previews.
|
|
1826
|
+
*/
|
|
1827
|
+
lastTranscriptSnippet?: (string) | null;
|
|
1828
|
+
/**
|
|
1829
|
+
* Full transcript segments (detail endpoint only; omitted from lists).
|
|
1830
|
+
*/
|
|
1831
|
+
transcript?: Array<{
|
|
1832
|
+
text?: string;
|
|
1833
|
+
confidence?: number;
|
|
1834
|
+
at?: string;
|
|
1835
|
+
}>;
|
|
1836
|
+
billing?: {
|
|
1837
|
+
metaMinutes?: number;
|
|
1838
|
+
telnyxSeconds?: number;
|
|
1839
|
+
transcriptionSeconds?: number;
|
|
1840
|
+
transcriptionCostUSD?: number;
|
|
1841
|
+
/**
|
|
1842
|
+
* WhatsApp channel only. Meta per-minute charge, billed by Meta directly to your WABA. Display only; not billed by Zernio.
|
|
1843
|
+
*/
|
|
1844
|
+
metaCostUSD?: number;
|
|
1845
|
+
telnyxCostUSD?: number;
|
|
1846
|
+
recordingCostUSD?: number;
|
|
1847
|
+
/**
|
|
1848
|
+
* Amount Zernio bills you = telephony leg + recording + transcription (excludes any Meta portion).
|
|
1849
|
+
*/
|
|
1850
|
+
billableCostUSD?: number;
|
|
1851
|
+
/**
|
|
1852
|
+
* Full cost incl. any Meta portion you pay directly. Display only.
|
|
1853
|
+
*/
|
|
1854
|
+
totalCostUSD?: number;
|
|
1855
|
+
currency?: string;
|
|
1856
|
+
};
|
|
1857
|
+
createdAt?: string;
|
|
1858
|
+
updatedAt?: string;
|
|
1859
|
+
};
|
|
1860
|
+
type channel = 'whatsapp' | 'pstn';
|
|
1861
|
+
type direction = 'inbound' | 'outbound';
|
|
1862
|
+
type status2 = 'ringing' | 'answered' | 'ended' | 'failed';
|
|
1863
|
+
/**
|
|
1864
|
+
* Caller ID presented on the forwarded leg.
|
|
1865
|
+
*/
|
|
1866
|
+
type forwardCallerId = 'business' | 'caller';
|
|
1867
|
+
type transcriptionLanguage = 'auto' | 'en' | 'es';
|
|
1868
|
+
type endReason = 'hangup' | 'no_answer' | 'rejected' | 'error';
|
|
1660
1869
|
/**
|
|
1661
1870
|
* A discoverable conversion destination on an ad platform — a Meta pixel,
|
|
1662
1871
|
* Google conversion action, or LinkedIn conversion rule. Returned by
|
|
@@ -1696,7 +1905,7 @@ type ConversionDestination = {
|
|
|
1696
1905
|
* For LinkedIn, `inactive` means the rule is soft-deleted (`enabled: false`).
|
|
1697
1906
|
*
|
|
1698
1907
|
*/
|
|
1699
|
-
type
|
|
1908
|
+
type status3 = 'active' | 'inactive';
|
|
1700
1909
|
/**
|
|
1701
1910
|
* A single conversion event to relay to the ad platform. All PII fields
|
|
1702
1911
|
* (email, phone, names) are hashed with SHA-256 server-side using each
|
|
@@ -2106,7 +2315,7 @@ type privacy_level = 2;
|
|
|
2106
2315
|
/**
|
|
2107
2316
|
* 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED
|
|
2108
2317
|
*/
|
|
2109
|
-
type
|
|
2318
|
+
type status4 = 1 | 2 | 3 | 4;
|
|
2110
2319
|
/**
|
|
2111
2320
|
* 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL
|
|
2112
2321
|
*/
|
|
@@ -2604,7 +2813,7 @@ type InboxWebhookConversation = {
|
|
|
2604
2813
|
*/
|
|
2605
2814
|
contactId?: string;
|
|
2606
2815
|
};
|
|
2607
|
-
type
|
|
2816
|
+
type status5 = 'active' | 'archived';
|
|
2608
2817
|
/**
|
|
2609
2818
|
* The message object included in inbox webhook payloads.
|
|
2610
2819
|
*/
|
|
@@ -2710,7 +2919,7 @@ type InboxWebhookMessage = {
|
|
|
2710
2919
|
isRead: boolean;
|
|
2711
2920
|
};
|
|
2712
2921
|
type platform2 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp';
|
|
2713
|
-
type
|
|
2922
|
+
type direction2 = 'incoming' | 'outgoing';
|
|
2714
2923
|
/**
|
|
2715
2924
|
* Shared account-insights response envelope used by every platform-level
|
|
2716
2925
|
* analytics endpoint (/v1/analytics/{facebook|instagram|youtube|linkedin|tiktok}*).
|
|
@@ -3129,7 +3338,7 @@ type PlatformAnalytics = {
|
|
|
3129
3338
|
*/
|
|
3130
3339
|
errorMessage?: (string) | null;
|
|
3131
3340
|
};
|
|
3132
|
-
type
|
|
3341
|
+
type status6 = 'published' | 'failed';
|
|
3133
3342
|
/**
|
|
3134
3343
|
* Sync state of analytics for this platform
|
|
3135
3344
|
*/
|
|
@@ -3245,7 +3454,7 @@ type Post = {
|
|
|
3245
3454
|
createdAt?: string;
|
|
3246
3455
|
updatedAt?: string;
|
|
3247
3456
|
};
|
|
3248
|
-
type
|
|
3457
|
+
type status7 = 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
|
|
3249
3458
|
type visibility = 'public' | 'private' | 'unlisted';
|
|
3250
3459
|
type PostAnalytics = {
|
|
3251
3460
|
impressions?: number;
|
|
@@ -4011,15 +4220,27 @@ type TikTokPlatformData = {
|
|
|
4011
4220
|
*/
|
|
4012
4221
|
allowStitch?: boolean;
|
|
4013
4222
|
/**
|
|
4014
|
-
* Type of commercial content disclosure
|
|
4223
|
+
* Type of commercial content disclosure. Sufficient on its own: "brand_organic"
|
|
4224
|
+
* ("Your Brand") implies isBrandOrganicPost and "brand_content" ("Branded Content",
|
|
4225
|
+
* paid partnership) implies brandPartnerPromote, so you don't need to send the
|
|
4226
|
+
* boolean flags separately. Branded content cannot be posted with privacyLevel
|
|
4227
|
+
* SELF_ONLY.
|
|
4228
|
+
*
|
|
4015
4229
|
*/
|
|
4016
4230
|
commercialContentType?: 'none' | 'brand_organic' | 'brand_content';
|
|
4017
4231
|
/**
|
|
4018
|
-
* Whether the post promotes a brand partner
|
|
4232
|
+
* Whether the post promotes a brand partner (branded content / paid partnership).
|
|
4233
|
+
* Only needed to disclose BOTH types at once (set it alongside
|
|
4234
|
+
* commercialContentType "brand_organic"), or to override the value implied by
|
|
4235
|
+
* commercialContentType.
|
|
4236
|
+
*
|
|
4019
4237
|
*/
|
|
4020
4238
|
brandPartnerPromote?: boolean;
|
|
4021
4239
|
/**
|
|
4022
|
-
* Whether the post
|
|
4240
|
+
* Whether the post promotes the creator's own brand (brand organic). Only needed
|
|
4241
|
+
* to disclose BOTH types at once (set it alongside commercialContentType
|
|
4242
|
+
* "brand_content"), or to override the value implied by commercialContentType.
|
|
4243
|
+
*
|
|
4023
4244
|
*/
|
|
4024
4245
|
isBrandOrganicPost?: boolean;
|
|
4025
4246
|
/**
|
|
@@ -4060,7 +4281,12 @@ type TikTokPlatformData = {
|
|
|
4060
4281
|
description?: string;
|
|
4061
4282
|
};
|
|
4062
4283
|
/**
|
|
4063
|
-
* Type of commercial content disclosure
|
|
4284
|
+
* Type of commercial content disclosure. Sufficient on its own: "brand_organic"
|
|
4285
|
+
* ("Your Brand") implies isBrandOrganicPost and "brand_content" ("Branded Content",
|
|
4286
|
+
* paid partnership) implies brandPartnerPromote, so you don't need to send the
|
|
4287
|
+
* boolean flags separately. Branded content cannot be posted with privacyLevel
|
|
4288
|
+
* SELF_ONLY.
|
|
4289
|
+
*
|
|
4064
4290
|
*/
|
|
4065
4291
|
type commercialContentType = 'none' | 'brand_organic' | 'brand_content';
|
|
4066
4292
|
/**
|
|
@@ -4220,7 +4446,7 @@ type UploadTokenResponse = {
|
|
|
4220
4446
|
expiresAt?: string;
|
|
4221
4447
|
status?: 'pending' | 'completed' | 'expired';
|
|
4222
4448
|
};
|
|
4223
|
-
type
|
|
4449
|
+
type status8 = 'pending' | 'completed' | 'expired';
|
|
4224
4450
|
type UploadTokenStatusResponse = {
|
|
4225
4451
|
token?: string;
|
|
4226
4452
|
status?: 'pending' | 'completed' | 'expired';
|
|
@@ -4489,7 +4715,7 @@ type WebhookLog = {
|
|
|
4489
4715
|
/**
|
|
4490
4716
|
* Delivery outcome
|
|
4491
4717
|
*/
|
|
4492
|
-
type
|
|
4718
|
+
type status9 = 'success' | 'failed';
|
|
4493
4719
|
/**
|
|
4494
4720
|
* Webhook payload for `account.ads.initial_sync_completed` events.
|
|
4495
4721
|
* Fired once per ads-enabled account when the initial discovery + 90-day
|
|
@@ -4595,7 +4821,7 @@ type event = 'account.ads.initial_sync_completed';
|
|
|
4595
4821
|
/**
|
|
4596
4822
|
* Overall outcome of the initial sync.
|
|
4597
4823
|
*/
|
|
4598
|
-
type
|
|
4824
|
+
type status10 = 'success' | 'failure';
|
|
4599
4825
|
/**
|
|
4600
4826
|
* Stable category for UX branching. New values may be added; existing ones are
|
|
4601
4827
|
* stable. Mapping:
|
|
@@ -4834,8 +5060,6 @@ type WebhookPayloadCallEnded = {
|
|
|
4834
5060
|
timestamp: string;
|
|
4835
5061
|
};
|
|
4836
5062
|
type event5 = 'call.ended';
|
|
4837
|
-
type direction2 = 'inbound' | 'outbound';
|
|
4838
|
-
type endReason = 'hangup' | 'no_answer' | 'rejected' | 'error';
|
|
4839
5063
|
/**
|
|
4840
5064
|
* Webhook payload for the `call.failed` event. Fired when a call
|
|
4841
5065
|
* setup or in-progress call fails.
|
|
@@ -5924,7 +6148,7 @@ type platform10 = 'whatsapp';
|
|
|
5924
6148
|
* request before the template is actually removed.
|
|
5925
6149
|
*
|
|
5926
6150
|
*/
|
|
5927
|
-
type
|
|
6151
|
+
type status11 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
5928
6152
|
type WhatsAppBodyComponent = {
|
|
5929
6153
|
type: 'body';
|
|
5930
6154
|
/**
|
|
@@ -6018,7 +6242,7 @@ type WhatsAppSandboxSession = {
|
|
|
6018
6242
|
* list responses.
|
|
6019
6243
|
*
|
|
6020
6244
|
*/
|
|
6021
|
-
type
|
|
6245
|
+
type status12 = 'pending' | 'active';
|
|
6022
6246
|
type WhatsAppTemplateButton = {
|
|
6023
6247
|
type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
6024
6248
|
/**
|
|
@@ -6129,7 +6353,7 @@ type WorkflowExecutionEvent = {
|
|
|
6129
6353
|
at?: string;
|
|
6130
6354
|
};
|
|
6131
6355
|
type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
6132
|
-
type
|
|
6356
|
+
type status13 = 'success' | 'failed' | 'pending';
|
|
6133
6357
|
/**
|
|
6134
6358
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
6135
6359
|
*/
|
|
@@ -7936,6 +8160,23 @@ type GetXApiPricingResponse = (XApiPricing);
|
|
|
7936
8160
|
type GetXApiPricingError = ({
|
|
7937
8161
|
error?: string;
|
|
7938
8162
|
});
|
|
8163
|
+
type GetUsageData = {
|
|
8164
|
+
query?: {
|
|
8165
|
+
/**
|
|
8166
|
+
* For Stripe subscription users, `true` forces a subscription
|
|
8167
|
+
* reconciliation pass even when cached plan data looks complete.
|
|
8168
|
+
* Omit the parameter, or pass `false`, to use the default
|
|
8169
|
+
* first-time-only reconciliation behavior. Invalid boolean values are
|
|
8170
|
+
* rejected.
|
|
8171
|
+
*
|
|
8172
|
+
*/
|
|
8173
|
+
reconcile?: boolean;
|
|
8174
|
+
};
|
|
8175
|
+
};
|
|
8176
|
+
type GetUsageResponse = (UsageStats);
|
|
8177
|
+
type GetUsageError = (unknown | {
|
|
8178
|
+
error?: string;
|
|
8179
|
+
});
|
|
7939
8180
|
type GetUsageStatsData = {
|
|
7940
8181
|
query?: {
|
|
7941
8182
|
/**
|
|
@@ -7953,6 +8194,101 @@ type GetUsageStatsResponse = (UsageStats);
|
|
|
7953
8194
|
type GetUsageStatsError = (unknown | {
|
|
7954
8195
|
error?: string;
|
|
7955
8196
|
});
|
|
8197
|
+
type GetCallsUsageData = {
|
|
8198
|
+
query?: {
|
|
8199
|
+
channel?: 'whatsapp' | 'pstn';
|
|
8200
|
+
groupBy?: 'day' | 'number' | 'channel';
|
|
8201
|
+
/**
|
|
8202
|
+
* Scope to calls involving this number (typically one of YOUR numbers). E.164, leading + optional.
|
|
8203
|
+
*/
|
|
8204
|
+
number?: string;
|
|
8205
|
+
/**
|
|
8206
|
+
* Start of the window (inclusive). Default 30 days before `until`.
|
|
8207
|
+
*/
|
|
8208
|
+
since?: string;
|
|
8209
|
+
/**
|
|
8210
|
+
* End of the window (exclusive). Default now.
|
|
8211
|
+
*/
|
|
8212
|
+
until?: string;
|
|
8213
|
+
};
|
|
8214
|
+
};
|
|
8215
|
+
type GetCallsUsageResponse = ({
|
|
8216
|
+
since?: string;
|
|
8217
|
+
until?: string;
|
|
8218
|
+
groupBy?: ('day' | 'number' | 'channel') | null;
|
|
8219
|
+
totals?: {
|
|
8220
|
+
calls?: number;
|
|
8221
|
+
answered?: number;
|
|
8222
|
+
minutes?: number;
|
|
8223
|
+
/**
|
|
8224
|
+
* What Zernio bills for these calls.
|
|
8225
|
+
*/
|
|
8226
|
+
billableUSD?: number;
|
|
8227
|
+
/**
|
|
8228
|
+
* WhatsApp only: Meta's per-minute charge, billed by Meta directly to your WABA. Display only.
|
|
8229
|
+
*/
|
|
8230
|
+
metaUSD?: number;
|
|
8231
|
+
};
|
|
8232
|
+
/**
|
|
8233
|
+
* Present (possibly empty) when `groupBy` is set.
|
|
8234
|
+
*/
|
|
8235
|
+
groups?: Array<{
|
|
8236
|
+
/**
|
|
8237
|
+
* The group key: a `YYYY-MM-DD` UTC day, one of your numbers, or a channel.
|
|
8238
|
+
*/
|
|
8239
|
+
key?: string;
|
|
8240
|
+
calls?: number;
|
|
8241
|
+
answered?: number;
|
|
8242
|
+
minutes?: number;
|
|
8243
|
+
billableUSD?: number;
|
|
8244
|
+
metaUSD?: number;
|
|
8245
|
+
}>;
|
|
8246
|
+
});
|
|
8247
|
+
type GetCallsUsageError = (unknown | {
|
|
8248
|
+
error?: string;
|
|
8249
|
+
});
|
|
8250
|
+
type GetSmsUsageData = {
|
|
8251
|
+
query?: {
|
|
8252
|
+
groupBy?: 'day' | 'number';
|
|
8253
|
+
/**
|
|
8254
|
+
* Scope to one of YOUR SMS-enabled numbers (E.164, leading + optional).
|
|
8255
|
+
*/
|
|
8256
|
+
number?: string;
|
|
8257
|
+
/**
|
|
8258
|
+
* Start of the window (inclusive). Default 30 days before `until`.
|
|
8259
|
+
*/
|
|
8260
|
+
since?: string;
|
|
8261
|
+
/**
|
|
8262
|
+
* End of the window (exclusive). Default now.
|
|
8263
|
+
*/
|
|
8264
|
+
until?: string;
|
|
8265
|
+
};
|
|
8266
|
+
};
|
|
8267
|
+
type GetSmsUsageResponse = ({
|
|
8268
|
+
since?: string;
|
|
8269
|
+
until?: string;
|
|
8270
|
+
groupBy?: ('day' | 'number') | null;
|
|
8271
|
+
totals?: {
|
|
8272
|
+
sent?: number;
|
|
8273
|
+
received?: number;
|
|
8274
|
+
total?: number;
|
|
8275
|
+
};
|
|
8276
|
+
/**
|
|
8277
|
+
* Present (possibly empty) when `groupBy` is set.
|
|
8278
|
+
*/
|
|
8279
|
+
groups?: Array<{
|
|
8280
|
+
/**
|
|
8281
|
+
* A `YYYY-MM-DD` UTC day or one of your numbers.
|
|
8282
|
+
*/
|
|
8283
|
+
key?: string;
|
|
8284
|
+
sent?: number;
|
|
8285
|
+
received?: number;
|
|
8286
|
+
total?: number;
|
|
8287
|
+
}>;
|
|
8288
|
+
});
|
|
8289
|
+
type GetSmsUsageError = (unknown | {
|
|
8290
|
+
error?: string;
|
|
8291
|
+
});
|
|
7956
8292
|
type ListPostsData = {
|
|
7957
8293
|
query?: {
|
|
7958
8294
|
/**
|
|
@@ -14866,7 +15202,7 @@ type GetWhatsAppCallingConfigData = {
|
|
|
14866
15202
|
};
|
|
14867
15203
|
type GetWhatsAppCallingConfigResponse = ({
|
|
14868
15204
|
/**
|
|
14869
|
-
*
|
|
15205
|
+
* Phone number record ID (use on /v1/phone-numbers/{id}/whatsapp/calling)
|
|
14870
15206
|
*/
|
|
14871
15207
|
phoneNumberDocId?: string;
|
|
14872
15208
|
phoneNumber?: string;
|
|
@@ -14890,7 +15226,7 @@ type GetWhatsAppCallingConfigResponse = ({
|
|
|
14890
15226
|
type GetWhatsAppCallingConfigError = ({
|
|
14891
15227
|
error?: string;
|
|
14892
15228
|
} | unknown);
|
|
14893
|
-
type
|
|
15229
|
+
type EnableWhatsAppCallingLegacyData = {
|
|
14894
15230
|
body: {
|
|
14895
15231
|
accountId: string;
|
|
14896
15232
|
/**
|
|
@@ -14912,16 +15248,16 @@ type EnableWhatsAppCallingData = {
|
|
|
14912
15248
|
id: string;
|
|
14913
15249
|
};
|
|
14914
15250
|
};
|
|
14915
|
-
type
|
|
15251
|
+
type EnableWhatsAppCallingLegacyResponse = ({
|
|
14916
15252
|
success?: boolean;
|
|
14917
15253
|
callingEnabled?: boolean;
|
|
14918
15254
|
sipHostname?: string;
|
|
14919
15255
|
forwardTo?: string;
|
|
14920
15256
|
});
|
|
14921
|
-
type
|
|
15257
|
+
type EnableWhatsAppCallingLegacyError = ({
|
|
14922
15258
|
error?: string;
|
|
14923
15259
|
} | unknown);
|
|
14924
|
-
type
|
|
15260
|
+
type UpdateWhatsAppCallingLegacyData = {
|
|
14925
15261
|
body: {
|
|
14926
15262
|
accountId: string;
|
|
14927
15263
|
forwardTo?: string;
|
|
@@ -14934,11 +15270,11 @@ type UpdateWhatsAppCallingData = {
|
|
|
14934
15270
|
id: string;
|
|
14935
15271
|
};
|
|
14936
15272
|
};
|
|
14937
|
-
type
|
|
14938
|
-
type
|
|
15273
|
+
type UpdateWhatsAppCallingLegacyResponse = (unknown);
|
|
15274
|
+
type UpdateWhatsAppCallingLegacyError = ({
|
|
14939
15275
|
error?: string;
|
|
14940
15276
|
} | unknown);
|
|
14941
|
-
type
|
|
15277
|
+
type DisableWhatsAppCallingLegacyData = {
|
|
14942
15278
|
path: {
|
|
14943
15279
|
id: string;
|
|
14944
15280
|
};
|
|
@@ -14946,8 +15282,8 @@ type DisableWhatsAppCallingData = {
|
|
|
14946
15282
|
accountId: string;
|
|
14947
15283
|
};
|
|
14948
15284
|
};
|
|
14949
|
-
type
|
|
14950
|
-
type
|
|
15285
|
+
type DisableWhatsAppCallingLegacyResponse = (unknown);
|
|
15286
|
+
type DisableWhatsAppCallingLegacyError = ({
|
|
14951
15287
|
error?: string;
|
|
14952
15288
|
} | unknown);
|
|
14953
15289
|
type GetWhatsAppCallPermissionsData = {
|
|
@@ -15005,6 +15341,12 @@ type InitiateWhatsAppCallData = {
|
|
|
15005
15341
|
*/
|
|
15006
15342
|
biz_opaque_callback_data?: string;
|
|
15007
15343
|
};
|
|
15344
|
+
headers?: {
|
|
15345
|
+
/**
|
|
15346
|
+
* Optional client-generated unique key (e.g. a UUID) that makes dial retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
15347
|
+
*/
|
|
15348
|
+
'Idempotency-Key'?: string;
|
|
15349
|
+
};
|
|
15008
15350
|
};
|
|
15009
15351
|
type InitiateWhatsAppCallResponse = ({
|
|
15010
15352
|
success?: boolean;
|
|
@@ -15028,6 +15370,10 @@ type InitiateWhatsAppCallError = ({
|
|
|
15028
15370
|
type ListWhatsAppCallsData = {
|
|
15029
15371
|
query: {
|
|
15030
15372
|
accountId: string;
|
|
15373
|
+
/**
|
|
15374
|
+
* Return calls with startedAt strictly before this instant (use the previous page's nextCursor).
|
|
15375
|
+
*/
|
|
15376
|
+
before?: string;
|
|
15031
15377
|
direction?: 'inbound' | 'outbound';
|
|
15032
15378
|
limit?: number;
|
|
15033
15379
|
since?: string;
|
|
@@ -15065,6 +15411,10 @@ type ListWhatsAppCallsResponse = ({
|
|
|
15065
15411
|
currency?: string;
|
|
15066
15412
|
};
|
|
15067
15413
|
}>;
|
|
15414
|
+
/**
|
|
15415
|
+
* Pass as `before` for the next page; null on the last page.
|
|
15416
|
+
*/
|
|
15417
|
+
nextCursor?: (string) | null;
|
|
15068
15418
|
});
|
|
15069
15419
|
type ListWhatsAppCallsError = ({
|
|
15070
15420
|
error?: string;
|
|
@@ -15085,6 +15435,24 @@ type GetWhatsAppCallResponse = ({
|
|
|
15085
15435
|
type GetWhatsAppCallError = ({
|
|
15086
15436
|
error?: string;
|
|
15087
15437
|
} | unknown);
|
|
15438
|
+
type GetWhatsAppCallRecordingData = {
|
|
15439
|
+
path: {
|
|
15440
|
+
callId: string;
|
|
15441
|
+
};
|
|
15442
|
+
query: {
|
|
15443
|
+
accountId: string;
|
|
15444
|
+
/**
|
|
15445
|
+
* `json` returns `{ url }` instead of a 302 redirect.
|
|
15446
|
+
*/
|
|
15447
|
+
as?: 'json';
|
|
15448
|
+
};
|
|
15449
|
+
};
|
|
15450
|
+
type GetWhatsAppCallRecordingResponse = ({
|
|
15451
|
+
url?: string;
|
|
15452
|
+
});
|
|
15453
|
+
type GetWhatsAppCallRecordingError = (unknown | {
|
|
15454
|
+
error?: string;
|
|
15455
|
+
});
|
|
15088
15456
|
type GetWhatsAppCallEstimateData = {
|
|
15089
15457
|
query: {
|
|
15090
15458
|
accountId: string;
|
|
@@ -15117,447 +15485,1053 @@ type GetWhatsAppCallEstimateResponse = ({
|
|
|
15117
15485
|
type GetWhatsAppCallEstimateError = ({
|
|
15118
15486
|
error?: string;
|
|
15119
15487
|
});
|
|
15120
|
-
type
|
|
15121
|
-
query
|
|
15488
|
+
type ListCallsData = {
|
|
15489
|
+
query?: {
|
|
15122
15490
|
/**
|
|
15123
|
-
*
|
|
15491
|
+
* Return calls with startedAt strictly before this instant (use the previous page's nextCursor).
|
|
15124
15492
|
*/
|
|
15125
|
-
|
|
15493
|
+
before?: string;
|
|
15494
|
+
channel?: 'whatsapp' | 'pstn';
|
|
15495
|
+
direction?: 'inbound' | 'outbound';
|
|
15496
|
+
limit?: number;
|
|
15126
15497
|
/**
|
|
15127
|
-
* Exact
|
|
15498
|
+
* Exact filter: calls involving this number (typically one of YOUR numbers, to scope history to a single line). E.164, leading + optional.
|
|
15128
15499
|
*/
|
|
15129
|
-
|
|
15500
|
+
number?: string;
|
|
15501
|
+
/**
|
|
15502
|
+
* Free-text match on the from/to numbers. Non-digits are stripped, so partial queries like `302` or `+1 302` work.
|
|
15503
|
+
*/
|
|
15504
|
+
search?: string;
|
|
15505
|
+
status?: 'ringing' | 'answered' | 'ended' | 'failed';
|
|
15130
15506
|
};
|
|
15131
15507
|
};
|
|
15132
|
-
type
|
|
15133
|
-
|
|
15134
|
-
name?: string;
|
|
15135
|
-
language?: string;
|
|
15136
|
-
category?: string;
|
|
15137
|
-
body?: string;
|
|
15138
|
-
body_params?: Array<(string)>;
|
|
15139
|
-
buttons?: Array<{
|
|
15140
|
-
/**
|
|
15141
|
-
* QUICK_REPLY, URL, PHONE_NUMBER, OTP, FLOW, ...
|
|
15142
|
-
*/
|
|
15143
|
-
type?: string;
|
|
15144
|
-
text?: string;
|
|
15145
|
-
}>;
|
|
15146
|
-
} | null;
|
|
15147
|
-
});
|
|
15148
|
-
type GetWhatsAppLibraryTemplateError = (unknown | {
|
|
15149
|
-
error?: string;
|
|
15150
|
-
});
|
|
15151
|
-
type GetWhatsAppBusinessProfileData = {
|
|
15152
|
-
query: {
|
|
15508
|
+
type ListCallsResponse = ({
|
|
15509
|
+
calls?: Array<(CallRecord & {
|
|
15153
15510
|
/**
|
|
15154
|
-
*
|
|
15511
|
+
* CRM contact name for the counterparty, when resolved.
|
|
15155
15512
|
*/
|
|
15156
|
-
|
|
15513
|
+
contactName?: string;
|
|
15514
|
+
})>;
|
|
15515
|
+
/**
|
|
15516
|
+
* Pass as `before` for the next page; null on the last page.
|
|
15517
|
+
*/
|
|
15518
|
+
nextCursor?: (string) | null;
|
|
15519
|
+
});
|
|
15520
|
+
type ListCallsError = ({
|
|
15521
|
+
error?: string;
|
|
15522
|
+
} | unknown);
|
|
15523
|
+
type GetCallData = {
|
|
15524
|
+
path: {
|
|
15525
|
+
id: string;
|
|
15157
15526
|
};
|
|
15158
15527
|
};
|
|
15159
|
-
type
|
|
15160
|
-
|
|
15161
|
-
businessProfile?: {
|
|
15528
|
+
type GetCallResponse = ({
|
|
15529
|
+
call?: (CallRecord & {
|
|
15162
15530
|
/**
|
|
15163
|
-
*
|
|
15531
|
+
* CRM contact name for the counterparty, when resolved.
|
|
15164
15532
|
*/
|
|
15165
|
-
|
|
15166
|
-
|
|
15533
|
+
contactName?: string;
|
|
15534
|
+
});
|
|
15535
|
+
});
|
|
15536
|
+
type GetCallError = ({
|
|
15537
|
+
error?: string;
|
|
15538
|
+
} | unknown);
|
|
15539
|
+
type GetCallRecordingData = {
|
|
15540
|
+
path: {
|
|
15541
|
+
id: string;
|
|
15542
|
+
};
|
|
15543
|
+
query?: {
|
|
15167
15544
|
/**
|
|
15168
|
-
*
|
|
15169
|
-
*/
|
|
15170
|
-
description?: string;
|
|
15171
|
-
email?: string;
|
|
15172
|
-
profilePictureUrl?: string;
|
|
15173
|
-
websites?: Array<(string)>;
|
|
15174
|
-
/**
|
|
15175
|
-
* Business category
|
|
15545
|
+
* `json` returns `{ url }` instead of a 302 redirect.
|
|
15176
15546
|
*/
|
|
15177
|
-
|
|
15547
|
+
as?: 'json';
|
|
15178
15548
|
};
|
|
15549
|
+
};
|
|
15550
|
+
type GetCallRecordingResponse = ({
|
|
15551
|
+
url?: string;
|
|
15179
15552
|
});
|
|
15180
|
-
type
|
|
15553
|
+
type GetCallRecordingError = (unknown | {
|
|
15181
15554
|
error?: string;
|
|
15182
15555
|
});
|
|
15183
|
-
type
|
|
15556
|
+
type CreateVoiceCallData = {
|
|
15184
15557
|
body: {
|
|
15185
15558
|
/**
|
|
15186
|
-
*
|
|
15559
|
+
* Destination to dial, E.164 with leading +.
|
|
15187
15560
|
*/
|
|
15188
|
-
|
|
15561
|
+
to: string;
|
|
15189
15562
|
/**
|
|
15190
|
-
*
|
|
15563
|
+
* Which of your voice-enabled numbers to dial from. Optional when you have exactly one.
|
|
15191
15564
|
*/
|
|
15192
|
-
|
|
15565
|
+
fromNumber?: string;
|
|
15193
15566
|
/**
|
|
15194
|
-
*
|
|
15567
|
+
* Per-call agent override (tel:+E164, sip:..., or wss://...); defaults to the number's stored forward destination.
|
|
15195
15568
|
*/
|
|
15196
|
-
|
|
15569
|
+
forwardTo?: string;
|
|
15197
15570
|
/**
|
|
15198
|
-
*
|
|
15571
|
+
* Spoken to the callee when they answer, before the bridge.
|
|
15199
15572
|
*/
|
|
15200
|
-
|
|
15573
|
+
greeting?: string;
|
|
15201
15574
|
/**
|
|
15202
|
-
*
|
|
15575
|
+
* Per-call recording toggle; defaults to the number's setting.
|
|
15203
15576
|
*/
|
|
15204
|
-
|
|
15577
|
+
recordOverride?: boolean;
|
|
15205
15578
|
/**
|
|
15206
|
-
*
|
|
15579
|
+
* Per-call transcription toggle; defaults to the number's setting.
|
|
15207
15580
|
*/
|
|
15208
|
-
|
|
15581
|
+
transcribeOverride?: boolean;
|
|
15209
15582
|
/**
|
|
15210
|
-
*
|
|
15583
|
+
* 'auto' derives from the callee's country; 'en'/'es' force it.
|
|
15211
15584
|
*/
|
|
15212
|
-
|
|
15585
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
15213
15586
|
/**
|
|
15214
|
-
*
|
|
15587
|
+
* A retry with the same key returns the original call instead of dialing again.
|
|
15215
15588
|
*/
|
|
15216
|
-
|
|
15589
|
+
idempotencyKey?: string;
|
|
15590
|
+
/**
|
|
15591
|
+
* Answering-machine detection; defers the bridge until human vs machine is known.
|
|
15592
|
+
*/
|
|
15593
|
+
amd?: boolean;
|
|
15594
|
+
/**
|
|
15595
|
+
* Spoken to a detected machine, then hang up (implies `amd`). For outbound voicemail drops.
|
|
15596
|
+
*/
|
|
15597
|
+
voicemailDropMessage?: string;
|
|
15598
|
+
};
|
|
15599
|
+
headers?: {
|
|
15600
|
+
/**
|
|
15601
|
+
* Optional client-generated unique key (e.g. a UUID) that makes dial retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
15602
|
+
*/
|
|
15603
|
+
'Idempotency-Key'?: string;
|
|
15217
15604
|
};
|
|
15218
15605
|
};
|
|
15219
|
-
type
|
|
15606
|
+
type CreateVoiceCallResponse = ({
|
|
15220
15607
|
success?: boolean;
|
|
15221
|
-
|
|
15608
|
+
/**
|
|
15609
|
+
* Internal Call doc ID
|
|
15610
|
+
*/
|
|
15611
|
+
callId?: string;
|
|
15612
|
+
telnyxCallControlId?: string;
|
|
15613
|
+
status?: 'dialing';
|
|
15614
|
+
direction?: 'outbound';
|
|
15615
|
+
from?: string;
|
|
15616
|
+
to?: string;
|
|
15617
|
+
forwardTo?: string;
|
|
15618
|
+
greeting?: (string) | null;
|
|
15619
|
+
recordingEnabled?: boolean;
|
|
15620
|
+
transcriptionEnabled?: boolean;
|
|
15621
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
15222
15622
|
});
|
|
15223
|
-
type
|
|
15623
|
+
type CreateVoiceCallError = ({
|
|
15224
15624
|
error?: string;
|
|
15225
|
-
});
|
|
15226
|
-
type
|
|
15227
|
-
|
|
15228
|
-
|
|
15229
|
-
|
|
15230
|
-
|
|
15231
|
-
accountId: string;
|
|
15625
|
+
} | unknown);
|
|
15626
|
+
type ListVoiceCallsData = {
|
|
15627
|
+
query?: {
|
|
15628
|
+
before?: string;
|
|
15629
|
+
direction?: 'inbound' | 'outbound';
|
|
15630
|
+
limit?: number;
|
|
15232
15631
|
/**
|
|
15233
|
-
*
|
|
15632
|
+
* Exact filter: calls involving this number (typically one of your DIDs). E.164, leading + optional.
|
|
15234
15633
|
*/
|
|
15235
|
-
|
|
15634
|
+
number?: string;
|
|
15635
|
+
status?: 'ringing' | 'answered' | 'ended' | 'failed';
|
|
15236
15636
|
};
|
|
15237
15637
|
};
|
|
15238
|
-
type
|
|
15239
|
-
|
|
15240
|
-
|
|
15638
|
+
type ListVoiceCallsResponse = ({
|
|
15639
|
+
calls?: Array<CallRecord>;
|
|
15640
|
+
nextCursor?: (string) | null;
|
|
15241
15641
|
});
|
|
15242
|
-
type
|
|
15642
|
+
type ListVoiceCallsError = ({
|
|
15243
15643
|
error?: string;
|
|
15244
15644
|
});
|
|
15245
|
-
type
|
|
15246
|
-
|
|
15247
|
-
|
|
15248
|
-
* WhatsApp social account ID
|
|
15249
|
-
*/
|
|
15250
|
-
accountId: string;
|
|
15645
|
+
type GetVoiceCallData = {
|
|
15646
|
+
path: {
|
|
15647
|
+
id: string;
|
|
15251
15648
|
};
|
|
15252
15649
|
};
|
|
15253
|
-
type
|
|
15650
|
+
type GetVoiceCallResponse = ({
|
|
15651
|
+
call?: CallRecord;
|
|
15652
|
+
});
|
|
15653
|
+
type GetVoiceCallError = ({
|
|
15654
|
+
error?: string;
|
|
15655
|
+
} | unknown);
|
|
15656
|
+
type EndVoiceCallData = {
|
|
15657
|
+
path: {
|
|
15658
|
+
id: string;
|
|
15659
|
+
};
|
|
15660
|
+
};
|
|
15661
|
+
type EndVoiceCallResponse = ({
|
|
15254
15662
|
success?: boolean;
|
|
15255
|
-
|
|
15256
|
-
|
|
15257
|
-
|
|
15258
|
-
|
|
15259
|
-
|
|
15260
|
-
|
|
15261
|
-
|
|
15262
|
-
|
|
15263
|
-
|
|
15663
|
+
callId?: string;
|
|
15664
|
+
/**
|
|
15665
|
+
* `ending` when a hangup was issued; otherwise the call's current status.
|
|
15666
|
+
*/
|
|
15667
|
+
status?: string;
|
|
15668
|
+
});
|
|
15669
|
+
type EndVoiceCallError = ({
|
|
15670
|
+
error?: string;
|
|
15671
|
+
} | unknown);
|
|
15672
|
+
type GetVoiceCallRecordingData = {
|
|
15673
|
+
path: {
|
|
15674
|
+
id: string;
|
|
15675
|
+
};
|
|
15676
|
+
query?: {
|
|
15264
15677
|
/**
|
|
15265
|
-
*
|
|
15678
|
+
* `json` returns `{ url }` instead of a 302 redirect.
|
|
15266
15679
|
*/
|
|
15267
|
-
|
|
15680
|
+
as?: 'json';
|
|
15268
15681
|
};
|
|
15682
|
+
};
|
|
15683
|
+
type GetVoiceCallRecordingResponse = ({
|
|
15684
|
+
url?: string;
|
|
15269
15685
|
});
|
|
15270
|
-
type
|
|
15686
|
+
type GetVoiceCallRecordingError = (unknown | {
|
|
15271
15687
|
error?: string;
|
|
15272
|
-
}
|
|
15273
|
-
type
|
|
15688
|
+
});
|
|
15689
|
+
type TransferVoiceCallData = {
|
|
15274
15690
|
body: {
|
|
15275
15691
|
/**
|
|
15276
|
-
*
|
|
15277
|
-
*/
|
|
15278
|
-
accountId: string;
|
|
15279
|
-
/**
|
|
15280
|
-
* New display name (must follow WhatsApp naming guidelines)
|
|
15692
|
+
* +E164 phone number (tel: prefix optional) or a sip: URI. wss:// is not a valid transfer target.
|
|
15281
15693
|
*/
|
|
15282
|
-
|
|
15694
|
+
to: string;
|
|
15695
|
+
};
|
|
15696
|
+
path: {
|
|
15697
|
+
id: string;
|
|
15283
15698
|
};
|
|
15284
15699
|
};
|
|
15285
|
-
type
|
|
15700
|
+
type TransferVoiceCallResponse = ({
|
|
15286
15701
|
success?: boolean;
|
|
15287
|
-
|
|
15288
|
-
|
|
15289
|
-
name?: string;
|
|
15290
|
-
status?: 'PENDING_REVIEW';
|
|
15291
|
-
};
|
|
15702
|
+
callId?: string;
|
|
15703
|
+
transferredTo?: string;
|
|
15292
15704
|
});
|
|
15293
|
-
type
|
|
15705
|
+
type TransferVoiceCallError = ({
|
|
15294
15706
|
error?: string;
|
|
15295
|
-
});
|
|
15296
|
-
type
|
|
15707
|
+
} | unknown);
|
|
15708
|
+
type GetVoiceCallEstimateData = {
|
|
15297
15709
|
query: {
|
|
15710
|
+
minutes?: number;
|
|
15711
|
+
recording?: boolean;
|
|
15298
15712
|
/**
|
|
15299
|
-
*
|
|
15713
|
+
* Destination number, E.164 (leading + optional).
|
|
15300
15714
|
*/
|
|
15301
|
-
|
|
15715
|
+
to: string;
|
|
15716
|
+
transcription?: boolean;
|
|
15302
15717
|
};
|
|
15303
15718
|
};
|
|
15304
|
-
type
|
|
15719
|
+
type GetVoiceCallEstimateResponse = ({
|
|
15720
|
+
destinationCountry?: (string) | null;
|
|
15721
|
+
minutes?: number;
|
|
15722
|
+
/**
|
|
15723
|
+
* Billable cost per minute for the requested options.
|
|
15724
|
+
*/
|
|
15725
|
+
perMinuteUsd?: number;
|
|
15726
|
+
breakdown?: {
|
|
15727
|
+
telnyxCostUSD?: number;
|
|
15728
|
+
recordingCostUSD?: number;
|
|
15729
|
+
transcriptionCostUSD?: number;
|
|
15730
|
+
/**
|
|
15731
|
+
* What Zernio bills for the call.
|
|
15732
|
+
*/
|
|
15733
|
+
billableCostUSD?: number;
|
|
15734
|
+
/**
|
|
15735
|
+
* Equals billableCostUSD (no separate Meta bill on PSTN); kept for shape parity with the WhatsApp estimate.
|
|
15736
|
+
*/
|
|
15737
|
+
totalCostUSD?: number;
|
|
15738
|
+
};
|
|
15739
|
+
});
|
|
15740
|
+
type GetVoiceCallEstimateError = ({
|
|
15741
|
+
error?: string;
|
|
15742
|
+
});
|
|
15743
|
+
type CreateVoiceWebSessionResponse = ({
|
|
15305
15744
|
success?: boolean;
|
|
15306
15745
|
/**
|
|
15307
|
-
*
|
|
15746
|
+
* Login token for the browser WebRTC SDK.
|
|
15308
15747
|
*/
|
|
15309
|
-
|
|
15748
|
+
token?: string;
|
|
15310
15749
|
/**
|
|
15311
|
-
*
|
|
15750
|
+
* Pass to POST /v1/voice/calls/web/dial once the browser is registered.
|
|
15312
15751
|
*/
|
|
15313
|
-
|
|
15752
|
+
credentialId?: string;
|
|
15753
|
+
expiresAt?: string;
|
|
15754
|
+
sdk?: string;
|
|
15314
15755
|
});
|
|
15315
|
-
type
|
|
15756
|
+
type CreateVoiceWebSessionError = ({
|
|
15316
15757
|
error?: string;
|
|
15317
15758
|
} | unknown);
|
|
15318
|
-
type
|
|
15759
|
+
type DialVoiceWebCallData = {
|
|
15319
15760
|
body: {
|
|
15320
15761
|
/**
|
|
15321
|
-
*
|
|
15762
|
+
* The number to call, E.164 with leading +.
|
|
15322
15763
|
*/
|
|
15323
|
-
|
|
15764
|
+
to: string;
|
|
15324
15765
|
/**
|
|
15325
|
-
*
|
|
15326
|
-
*
|
|
15766
|
+
* The WebRTC credential id returned by POST /v1/voice/calls/web (the registered browser).
|
|
15327
15767
|
*/
|
|
15328
|
-
|
|
15768
|
+
credentialId: string;
|
|
15329
15769
|
/**
|
|
15330
|
-
*
|
|
15770
|
+
* Which of your voice-enabled numbers to call from (optional when you have one).
|
|
15331
15771
|
*/
|
|
15332
|
-
|
|
15772
|
+
fromNumber?: string;
|
|
15773
|
+
recordOverride?: boolean;
|
|
15333
15774
|
};
|
|
15334
15775
|
};
|
|
15335
|
-
type
|
|
15776
|
+
type DialVoiceWebCallResponse = ({
|
|
15336
15777
|
success?: boolean;
|
|
15337
|
-
|
|
15338
|
-
|
|
15778
|
+
callId?: string;
|
|
15779
|
+
telnyxCallControlId?: string;
|
|
15780
|
+
status?: 'dialing';
|
|
15781
|
+
direction?: 'outbound';
|
|
15782
|
+
from?: string;
|
|
15783
|
+
to?: string;
|
|
15784
|
+
recordingEnabled?: boolean;
|
|
15339
15785
|
});
|
|
15340
|
-
type
|
|
15786
|
+
type DialVoiceWebCallError = ({
|
|
15341
15787
|
error?: string;
|
|
15342
|
-
});
|
|
15343
|
-
type
|
|
15788
|
+
} | unknown);
|
|
15789
|
+
type SendSmsData = {
|
|
15344
15790
|
body: {
|
|
15345
15791
|
/**
|
|
15346
|
-
*
|
|
15792
|
+
* One of your SMS-enabled numbers (E.164; formatting is normalized).
|
|
15347
15793
|
*/
|
|
15348
|
-
|
|
15794
|
+
from: string;
|
|
15795
|
+
/**
|
|
15796
|
+
* Recipient number (E.164).
|
|
15797
|
+
*/
|
|
15798
|
+
to: string;
|
|
15799
|
+
/**
|
|
15800
|
+
* Message body. Required unless `mediaUrls` is set. Max 10 SMS segments (1530 GSM-7 or 670 unicode characters).
|
|
15801
|
+
*/
|
|
15802
|
+
text?: string;
|
|
15803
|
+
/**
|
|
15804
|
+
* Public media URLs to attach (sends as MMS). Max 10.
|
|
15805
|
+
*/
|
|
15806
|
+
mediaUrls?: Array<(string)>;
|
|
15807
|
+
};
|
|
15808
|
+
headers?: {
|
|
15809
|
+
/**
|
|
15810
|
+
* Optional client-generated unique key (e.g. a UUID) that makes send retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
15811
|
+
*/
|
|
15812
|
+
'Idempotency-Key'?: string;
|
|
15349
15813
|
};
|
|
15350
15814
|
};
|
|
15351
|
-
type
|
|
15352
|
-
|
|
15815
|
+
type SendSmsResponse = ({
|
|
15816
|
+
/**
|
|
15817
|
+
* Message ID
|
|
15818
|
+
*/
|
|
15819
|
+
id?: string;
|
|
15820
|
+
/**
|
|
15821
|
+
* Inbox conversation the message was threaded into.
|
|
15822
|
+
*/
|
|
15823
|
+
conversationId?: string;
|
|
15824
|
+
status?: 'sent';
|
|
15353
15825
|
});
|
|
15354
|
-
type
|
|
15826
|
+
type SendSmsError = ({
|
|
15355
15827
|
error?: string;
|
|
15356
15828
|
} | unknown);
|
|
15357
|
-
type
|
|
15829
|
+
type LookupSmsNumberData = {
|
|
15358
15830
|
query: {
|
|
15359
15831
|
/**
|
|
15360
|
-
*
|
|
15832
|
+
* Number to look up (E.164; formatting is normalized).
|
|
15361
15833
|
*/
|
|
15362
|
-
|
|
15834
|
+
number: string;
|
|
15363
15835
|
};
|
|
15364
15836
|
};
|
|
15365
|
-
type
|
|
15366
|
-
|
|
15837
|
+
type LookupSmsNumberResponse = ({
|
|
15838
|
+
phoneNumber?: string;
|
|
15839
|
+
carrierName?: (string) | null;
|
|
15840
|
+
lineType?: 'mobile' | 'landline' | 'voip' | 'toll-free' | 'unknown';
|
|
15367
15841
|
/**
|
|
15368
|
-
*
|
|
15842
|
+
* True when the line type can receive SMS (not a landline).
|
|
15369
15843
|
*/
|
|
15370
|
-
|
|
15844
|
+
smsReachable?: boolean;
|
|
15371
15845
|
});
|
|
15372
|
-
type
|
|
15846
|
+
type LookupSmsNumberError = ({
|
|
15373
15847
|
error?: string;
|
|
15374
15848
|
} | unknown);
|
|
15375
|
-
type
|
|
15376
|
-
query
|
|
15377
|
-
|
|
15378
|
-
|
|
15379
|
-
*/
|
|
15380
|
-
accountId: string;
|
|
15849
|
+
type ListSmsOptOutsData = {
|
|
15850
|
+
query?: {
|
|
15851
|
+
format?: 'json' | 'csv';
|
|
15852
|
+
limit?: number;
|
|
15381
15853
|
};
|
|
15382
15854
|
};
|
|
15383
|
-
type
|
|
15384
|
-
|
|
15385
|
-
|
|
15386
|
-
|
|
15855
|
+
type ListSmsOptOutsResponse = ({
|
|
15856
|
+
optOuts?: Array<{
|
|
15857
|
+
phoneNumber?: string;
|
|
15858
|
+
optedOutAt?: (string) | null;
|
|
15387
15859
|
/**
|
|
15388
|
-
*
|
|
15860
|
+
* The keyword they sent (e.g. STOP), when the carrier recorded one.
|
|
15389
15861
|
*/
|
|
15390
|
-
|
|
15862
|
+
keyword?: (string) | null;
|
|
15391
15863
|
/**
|
|
15392
|
-
*
|
|
15864
|
+
* Which of your numbers the recipient opted out from.
|
|
15393
15865
|
*/
|
|
15394
|
-
|
|
15866
|
+
from?: (string) | null;
|
|
15867
|
+
}>;
|
|
15868
|
+
count?: number;
|
|
15869
|
+
});
|
|
15870
|
+
type ListSmsOptOutsError = ({
|
|
15871
|
+
error?: string;
|
|
15872
|
+
});
|
|
15873
|
+
type StartSmsRegistrationData = {
|
|
15874
|
+
body: {
|
|
15875
|
+
registrationType: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
|
|
15395
15876
|
/**
|
|
15396
|
-
*
|
|
15877
|
+
* Your numbers this registration covers.
|
|
15397
15878
|
*/
|
|
15398
|
-
|
|
15399
|
-
throughput?: {
|
|
15400
|
-
/**
|
|
15401
|
-
* STANDARD or HIGH
|
|
15402
|
-
*/
|
|
15403
|
-
level?: string;
|
|
15404
|
-
};
|
|
15879
|
+
phoneNumbers: Array<(string)>;
|
|
15405
15880
|
/**
|
|
15406
|
-
*
|
|
15881
|
+
* Required for 10DLC. The legal entity behind the traffic (TCR brand).
|
|
15407
15882
|
*/
|
|
15408
|
-
|
|
15409
|
-
|
|
15883
|
+
brand?: {
|
|
15884
|
+
entityType: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR';
|
|
15885
|
+
displayName: string;
|
|
15886
|
+
/**
|
|
15887
|
+
* Legal company name. Required for every entityType except SOLE_PROPRIETOR.
|
|
15888
|
+
*/
|
|
15889
|
+
companyName?: string;
|
|
15890
|
+
/**
|
|
15891
|
+
* Required for every entityType except SOLE_PROPRIETOR.
|
|
15892
|
+
*/
|
|
15893
|
+
ein?: string;
|
|
15894
|
+
phone?: string;
|
|
15895
|
+
/**
|
|
15896
|
+
* Required for SOLE_PROPRIETOR; the verification OTP is texted there (US/CA mobile).
|
|
15897
|
+
*/
|
|
15898
|
+
mobilePhone?: string;
|
|
15899
|
+
street?: string;
|
|
15900
|
+
city?: string;
|
|
15901
|
+
state?: string;
|
|
15902
|
+
postalCode?: string;
|
|
15903
|
+
country: 'US' | 'CA';
|
|
15904
|
+
/**
|
|
15905
|
+
* Brand contact email; defaults to your account email when omitted.
|
|
15906
|
+
*/
|
|
15907
|
+
email?: string;
|
|
15908
|
+
website?: string;
|
|
15909
|
+
vertical: 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION';
|
|
15910
|
+
stockSymbol?: string;
|
|
15911
|
+
};
|
|
15410
15912
|
/**
|
|
15411
|
-
*
|
|
15913
|
+
* Required for 10DLC. What you'll send and how recipients opt in/out.
|
|
15412
15914
|
*/
|
|
15413
|
-
|
|
15915
|
+
campaign?: {
|
|
15916
|
+
usecase: string;
|
|
15917
|
+
description: string;
|
|
15918
|
+
/**
|
|
15919
|
+
* How a recipient ends up receiving your messages (the opt-in flow).
|
|
15920
|
+
*/
|
|
15921
|
+
messageFlow: string;
|
|
15922
|
+
sample1: string;
|
|
15923
|
+
sample2?: string;
|
|
15924
|
+
helpMessage: string;
|
|
15925
|
+
optinKeywords: string;
|
|
15926
|
+
optinMessage: string;
|
|
15927
|
+
optoutKeywords: string;
|
|
15928
|
+
optoutMessage: string;
|
|
15929
|
+
helpKeywords: string;
|
|
15930
|
+
embeddedLink?: boolean;
|
|
15931
|
+
embeddedPhone?: boolean;
|
|
15932
|
+
numberPool?: boolean;
|
|
15933
|
+
ageGated?: boolean;
|
|
15934
|
+
directLending?: boolean;
|
|
15935
|
+
};
|
|
15414
15936
|
/**
|
|
15415
|
-
*
|
|
15937
|
+
* Required for toll_free.
|
|
15416
15938
|
*/
|
|
15417
|
-
|
|
15418
|
-
|
|
15939
|
+
tollFree?: {
|
|
15940
|
+
businessName: string;
|
|
15941
|
+
corporateWebsite: string;
|
|
15942
|
+
phoneNumbers: Array<(string)>;
|
|
15943
|
+
useCase: string;
|
|
15944
|
+
useCaseSummary: string;
|
|
15945
|
+
productionMessageContent: string;
|
|
15946
|
+
/**
|
|
15947
|
+
* How recipients opt in to your messages.
|
|
15948
|
+
*/
|
|
15949
|
+
optInWorkflow: string;
|
|
15950
|
+
/**
|
|
15951
|
+
* Screenshot URL(s) showing the opt-in flow (at least one).
|
|
15952
|
+
*/
|
|
15953
|
+
optInWorkflowImageUrls: Array<(string)>;
|
|
15954
|
+
/**
|
|
15955
|
+
* Expected monthly message volume tier.
|
|
15956
|
+
*/
|
|
15957
|
+
messageVolume: '10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+';
|
|
15958
|
+
additionalInformation: string;
|
|
15959
|
+
businessAddr1: string;
|
|
15960
|
+
businessAddr2?: string;
|
|
15961
|
+
businessCity: string;
|
|
15962
|
+
businessState: string;
|
|
15963
|
+
businessZip: string;
|
|
15964
|
+
businessContactFirstName: string;
|
|
15965
|
+
businessContactLastName: string;
|
|
15966
|
+
businessContactEmail: string;
|
|
15967
|
+
businessContactPhone: string;
|
|
15968
|
+
businessRegistrationNumber: string;
|
|
15969
|
+
/**
|
|
15970
|
+
* e.g. EIN (US), Companies House (UK), ABN (AU).
|
|
15971
|
+
*/
|
|
15972
|
+
businessRegistrationType: string;
|
|
15973
|
+
/**
|
|
15974
|
+
* ISO 3166-1 alpha-2.
|
|
15975
|
+
*/
|
|
15976
|
+
businessRegistrationCountry: string;
|
|
15419
15977
|
};
|
|
15420
15978
|
};
|
|
15421
|
-
|
|
15422
|
-
|
|
15979
|
+
};
|
|
15980
|
+
type StartSmsRegistrationResponse = ({
|
|
15981
|
+
registrationId?: string;
|
|
15982
|
+
status?: 'pending';
|
|
15983
|
+
/**
|
|
15984
|
+
* True for sole-prop 10DLC: an OTP was texted to the brand's mobile; submit it via /verify-otp.
|
|
15985
|
+
*/
|
|
15986
|
+
awaitingOtp?: boolean;
|
|
15987
|
+
});
|
|
15988
|
+
type StartSmsRegistrationError = ({
|
|
15989
|
+
error?: string;
|
|
15990
|
+
} | unknown);
|
|
15991
|
+
type ListSmsRegistrationsResponse = ({
|
|
15992
|
+
registrations?: Array<{
|
|
15993
|
+
id?: string;
|
|
15994
|
+
registrationType?: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
|
|
15995
|
+
displayName?: (string) | null;
|
|
15996
|
+
status?: 'pending' | 'approved' | 'rejected';
|
|
15423
15997
|
/**
|
|
15424
|
-
*
|
|
15998
|
+
* Carrier-registry brand status (e.g. VERIFIED).
|
|
15425
15999
|
*/
|
|
15426
|
-
|
|
16000
|
+
brandStatus?: string;
|
|
16001
|
+
campaignStatus?: string;
|
|
15427
16002
|
/**
|
|
15428
|
-
*
|
|
16003
|
+
* TCR brand id, useful when referencing the brand in carrier support threads.
|
|
15429
16004
|
*/
|
|
15430
|
-
|
|
15431
|
-
|
|
15432
|
-
|
|
16005
|
+
brandId?: (string) | null;
|
|
16006
|
+
/**
|
|
16007
|
+
* TCR campaign id.
|
|
16008
|
+
*/
|
|
16009
|
+
campaignId?: (string) | null;
|
|
16010
|
+
declineReason?: (string) | null;
|
|
16011
|
+
phoneNumbers?: Array<(string)>;
|
|
16012
|
+
/**
|
|
16013
|
+
* Sole-prop 10DLC only; the OTP step is still pending.
|
|
16014
|
+
*/
|
|
16015
|
+
awaitingOtp?: boolean;
|
|
16016
|
+
/**
|
|
16017
|
+
* Carrier-assigned brand trust score; drives throughput.
|
|
16018
|
+
*/
|
|
16019
|
+
trustScore?: (number) | null;
|
|
16020
|
+
/**
|
|
16021
|
+
* Carrier throughput tier derived from the trust score.
|
|
16022
|
+
*/
|
|
16023
|
+
throughput?: {
|
|
16024
|
+
label?: string;
|
|
16025
|
+
smsPerMinute?: number;
|
|
16026
|
+
smsPerDay?: number;
|
|
15433
16027
|
};
|
|
15434
|
-
}
|
|
16028
|
+
}>;
|
|
15435
16029
|
});
|
|
15436
|
-
type
|
|
16030
|
+
type ListSmsRegistrationsError = ({
|
|
15437
16031
|
error?: string;
|
|
15438
16032
|
});
|
|
15439
|
-
type
|
|
15440
|
-
|
|
15441
|
-
|
|
16033
|
+
type GetSmsRegistrationData = {
|
|
16034
|
+
path: {
|
|
16035
|
+
id: string;
|
|
16036
|
+
};
|
|
16037
|
+
};
|
|
16038
|
+
type GetSmsRegistrationResponse = ({
|
|
16039
|
+
id?: string;
|
|
16040
|
+
registrationType?: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
|
|
16041
|
+
status?: 'pending' | 'approved' | 'rejected';
|
|
16042
|
+
brandStatus?: string;
|
|
16043
|
+
campaignStatus?: string;
|
|
16044
|
+
declineReason?: (string) | null;
|
|
16045
|
+
phoneNumbers?: Array<(string)>;
|
|
16046
|
+
awaitingOtp?: boolean;
|
|
16047
|
+
});
|
|
16048
|
+
type GetSmsRegistrationError = ({
|
|
16049
|
+
error?: string;
|
|
16050
|
+
} | unknown);
|
|
16051
|
+
type VerifySmsRegistrationOtpData = {
|
|
16052
|
+
body: {
|
|
16053
|
+
otpPin: string;
|
|
16054
|
+
};
|
|
16055
|
+
path: {
|
|
16056
|
+
id: string;
|
|
16057
|
+
};
|
|
16058
|
+
};
|
|
16059
|
+
type VerifySmsRegistrationOtpResponse = ({
|
|
16060
|
+
verified?: boolean;
|
|
16061
|
+
});
|
|
16062
|
+
type VerifySmsRegistrationOtpError = ({
|
|
16063
|
+
error?: string;
|
|
16064
|
+
} | unknown);
|
|
16065
|
+
type AppealSmsRegistrationData = {
|
|
16066
|
+
body: {
|
|
16067
|
+
appealReason: string;
|
|
16068
|
+
};
|
|
16069
|
+
path: {
|
|
16070
|
+
id: string;
|
|
16071
|
+
};
|
|
16072
|
+
};
|
|
16073
|
+
type AppealSmsRegistrationResponse = ({
|
|
16074
|
+
status?: 'pending';
|
|
16075
|
+
});
|
|
16076
|
+
type AppealSmsRegistrationError = (unknown | {
|
|
16077
|
+
error?: string;
|
|
16078
|
+
});
|
|
16079
|
+
type ShareSmsRegistrationData = {
|
|
16080
|
+
body: {
|
|
15442
16081
|
/**
|
|
15443
|
-
*
|
|
16082
|
+
* Your phone number's ID (from GET /v1/phone-numbers).
|
|
15444
16083
|
*/
|
|
15445
|
-
|
|
16084
|
+
numberId: string;
|
|
15446
16085
|
};
|
|
15447
16086
|
};
|
|
15448
|
-
type
|
|
15449
|
-
|
|
16087
|
+
type ShareSmsRegistrationResponse = ({
|
|
16088
|
+
url?: string;
|
|
16089
|
+
expiresAt?: string;
|
|
15450
16090
|
});
|
|
15451
|
-
type
|
|
16091
|
+
type ShareSmsRegistrationError = ({
|
|
15452
16092
|
error?: string;
|
|
15453
16093
|
} | unknown);
|
|
15454
|
-
type
|
|
16094
|
+
type GetWhatsAppLibraryTemplateData = {
|
|
15455
16095
|
query: {
|
|
15456
16096
|
/**
|
|
15457
16097
|
* WhatsApp social account ID
|
|
15458
16098
|
*/
|
|
15459
16099
|
accountId: string;
|
|
15460
16100
|
/**
|
|
15461
|
-
*
|
|
15462
|
-
*/
|
|
15463
|
-
after?: string;
|
|
15464
|
-
/**
|
|
15465
|
-
* Page size.
|
|
16101
|
+
* Exact library template name
|
|
15466
16102
|
*/
|
|
15467
|
-
|
|
16103
|
+
name: string;
|
|
15468
16104
|
};
|
|
15469
16105
|
};
|
|
15470
|
-
type
|
|
15471
|
-
|
|
15472
|
-
|
|
15473
|
-
|
|
15474
|
-
|
|
15475
|
-
|
|
15476
|
-
|
|
15477
|
-
|
|
15478
|
-
|
|
15479
|
-
|
|
15480
|
-
|
|
16106
|
+
type GetWhatsAppLibraryTemplateResponse = ({
|
|
16107
|
+
template?: {
|
|
16108
|
+
name?: string;
|
|
16109
|
+
language?: string;
|
|
16110
|
+
category?: string;
|
|
16111
|
+
body?: string;
|
|
16112
|
+
body_params?: Array<(string)>;
|
|
16113
|
+
buttons?: Array<{
|
|
16114
|
+
/**
|
|
16115
|
+
* QUICK_REPLY, URL, PHONE_NUMBER, OTP, FLOW, ...
|
|
16116
|
+
*/
|
|
16117
|
+
type?: string;
|
|
16118
|
+
text?: string;
|
|
16119
|
+
}>;
|
|
16120
|
+
} | null;
|
|
15481
16121
|
});
|
|
15482
|
-
type
|
|
16122
|
+
type GetWhatsAppLibraryTemplateError = (unknown | {
|
|
15483
16123
|
error?: string;
|
|
15484
|
-
}
|
|
15485
|
-
type
|
|
15486
|
-
|
|
16124
|
+
});
|
|
16125
|
+
type GetWhatsAppBusinessProfileData = {
|
|
16126
|
+
query: {
|
|
15487
16127
|
/**
|
|
15488
16128
|
* WhatsApp social account ID
|
|
15489
16129
|
*/
|
|
15490
16130
|
accountId: string;
|
|
15491
|
-
/**
|
|
15492
|
-
* Phone numbers (E.164, e.g. "+16505551234") or WhatsApp user IDs to block.
|
|
15493
|
-
*/
|
|
15494
|
-
users: Array<(string)>;
|
|
15495
16131
|
};
|
|
15496
16132
|
};
|
|
15497
|
-
type
|
|
15498
|
-
|
|
15499
|
-
|
|
15500
|
-
*/
|
|
15501
|
-
blocked?: Array<{
|
|
16133
|
+
type GetWhatsAppBusinessProfileResponse = ({
|
|
16134
|
+
success?: boolean;
|
|
16135
|
+
businessProfile?: {
|
|
15502
16136
|
/**
|
|
15503
|
-
*
|
|
16137
|
+
* Short description (max 139 chars)
|
|
15504
16138
|
*/
|
|
15505
|
-
|
|
16139
|
+
about?: string;
|
|
16140
|
+
address?: string;
|
|
15506
16141
|
/**
|
|
15507
|
-
*
|
|
16142
|
+
* Full description (max 512 chars)
|
|
15508
16143
|
*/
|
|
15509
|
-
|
|
15510
|
-
|
|
15511
|
-
|
|
15512
|
-
|
|
15513
|
-
|
|
15514
|
-
|
|
15515
|
-
|
|
15516
|
-
|
|
15517
|
-
}
|
|
16144
|
+
description?: string;
|
|
16145
|
+
email?: string;
|
|
16146
|
+
profilePictureUrl?: string;
|
|
16147
|
+
websites?: Array<(string)>;
|
|
16148
|
+
/**
|
|
16149
|
+
* Business category
|
|
16150
|
+
*/
|
|
16151
|
+
vertical?: string;
|
|
16152
|
+
};
|
|
15518
16153
|
});
|
|
15519
|
-
type
|
|
16154
|
+
type GetWhatsAppBusinessProfileError = (unknown | {
|
|
15520
16155
|
error?: string;
|
|
15521
|
-
}
|
|
15522
|
-
type
|
|
16156
|
+
});
|
|
16157
|
+
type UpdateWhatsAppBusinessProfileData = {
|
|
15523
16158
|
body: {
|
|
15524
16159
|
/**
|
|
15525
16160
|
* WhatsApp social account ID
|
|
15526
16161
|
*/
|
|
15527
16162
|
accountId: string;
|
|
15528
16163
|
/**
|
|
15529
|
-
*
|
|
16164
|
+
* Short business description (max 139 characters)
|
|
15530
16165
|
*/
|
|
15531
|
-
|
|
15532
|
-
};
|
|
15533
|
-
};
|
|
15534
|
-
type UnblockWhatsAppUsersResponse = ({
|
|
15535
|
-
/**
|
|
15536
|
-
* Users successfully unblocked.
|
|
15537
|
-
*/
|
|
15538
|
-
unblocked?: Array<{
|
|
16166
|
+
about?: string;
|
|
15539
16167
|
/**
|
|
15540
|
-
*
|
|
16168
|
+
* Business address
|
|
15541
16169
|
*/
|
|
15542
|
-
|
|
16170
|
+
address?: string;
|
|
15543
16171
|
/**
|
|
15544
|
-
*
|
|
16172
|
+
* Full business description (max 512 characters)
|
|
15545
16173
|
*/
|
|
15546
|
-
|
|
15547
|
-
|
|
15548
|
-
|
|
15549
|
-
|
|
15550
|
-
|
|
15551
|
-
|
|
15552
|
-
|
|
15553
|
-
|
|
15554
|
-
|
|
16174
|
+
description?: string;
|
|
16175
|
+
/**
|
|
16176
|
+
* Business email
|
|
16177
|
+
*/
|
|
16178
|
+
email?: string;
|
|
16179
|
+
/**
|
|
16180
|
+
* Business websites (max 2)
|
|
16181
|
+
*/
|
|
16182
|
+
websites?: Array<(string)>;
|
|
16183
|
+
/**
|
|
16184
|
+
* Business category (e.g., RETAIL, ENTERTAINMENT, etc.)
|
|
16185
|
+
*/
|
|
16186
|
+
vertical?: string;
|
|
16187
|
+
/**
|
|
16188
|
+
* Handle from resumable upload for profile picture
|
|
16189
|
+
*/
|
|
16190
|
+
profilePictureHandle?: string;
|
|
16191
|
+
};
|
|
16192
|
+
};
|
|
16193
|
+
type UpdateWhatsAppBusinessProfileResponse = ({
|
|
16194
|
+
success?: boolean;
|
|
16195
|
+
message?: string;
|
|
15555
16196
|
});
|
|
15556
|
-
type
|
|
16197
|
+
type UpdateWhatsAppBusinessProfileError = (unknown | {
|
|
15557
16198
|
error?: string;
|
|
15558
|
-
}
|
|
15559
|
-
type
|
|
15560
|
-
|
|
16199
|
+
});
|
|
16200
|
+
type UploadWhatsAppProfilePhotoData = {
|
|
16201
|
+
body: {
|
|
16202
|
+
/**
|
|
16203
|
+
* WhatsApp social account ID
|
|
16204
|
+
*/
|
|
16205
|
+
accountId: string;
|
|
16206
|
+
/**
|
|
16207
|
+
* Image file (JPEG or PNG, max 5MB, recommended 640x640)
|
|
16208
|
+
*/
|
|
16209
|
+
file: (Blob | File);
|
|
16210
|
+
};
|
|
16211
|
+
};
|
|
16212
|
+
type UploadWhatsAppProfilePhotoResponse = ({
|
|
16213
|
+
success?: boolean;
|
|
16214
|
+
message?: string;
|
|
16215
|
+
});
|
|
16216
|
+
type UploadWhatsAppProfilePhotoError = (unknown | {
|
|
16217
|
+
error?: string;
|
|
16218
|
+
});
|
|
16219
|
+
type GetWhatsAppDisplayNameData = {
|
|
16220
|
+
query: {
|
|
16221
|
+
/**
|
|
16222
|
+
* WhatsApp social account ID
|
|
16223
|
+
*/
|
|
16224
|
+
accountId: string;
|
|
16225
|
+
};
|
|
16226
|
+
};
|
|
16227
|
+
type GetWhatsAppDisplayNameResponse = ({
|
|
16228
|
+
success?: boolean;
|
|
16229
|
+
displayName?: {
|
|
16230
|
+
/**
|
|
16231
|
+
* Current verified display name
|
|
16232
|
+
*/
|
|
16233
|
+
name?: string;
|
|
16234
|
+
/**
|
|
16235
|
+
* Meta review status for the display name
|
|
16236
|
+
*/
|
|
16237
|
+
status?: 'APPROVED' | 'PENDING_REVIEW' | 'DECLINED' | 'NONE';
|
|
16238
|
+
/**
|
|
16239
|
+
* Display phone number
|
|
16240
|
+
*/
|
|
16241
|
+
phoneNumber?: string;
|
|
16242
|
+
};
|
|
16243
|
+
});
|
|
16244
|
+
type GetWhatsAppDisplayNameError = ({
|
|
16245
|
+
error?: string;
|
|
16246
|
+
} | unknown);
|
|
16247
|
+
type UpdateWhatsAppDisplayNameData = {
|
|
16248
|
+
body: {
|
|
16249
|
+
/**
|
|
16250
|
+
* WhatsApp social account ID
|
|
16251
|
+
*/
|
|
16252
|
+
accountId: string;
|
|
16253
|
+
/**
|
|
16254
|
+
* New display name (must follow WhatsApp naming guidelines)
|
|
16255
|
+
*/
|
|
16256
|
+
displayName: string;
|
|
16257
|
+
};
|
|
16258
|
+
};
|
|
16259
|
+
type UpdateWhatsAppDisplayNameResponse = ({
|
|
16260
|
+
success?: boolean;
|
|
16261
|
+
message?: string;
|
|
16262
|
+
displayName?: {
|
|
16263
|
+
name?: string;
|
|
16264
|
+
status?: 'PENDING_REVIEW';
|
|
16265
|
+
};
|
|
16266
|
+
});
|
|
16267
|
+
type UpdateWhatsAppDisplayNameError = (unknown | {
|
|
16268
|
+
error?: string;
|
|
16269
|
+
});
|
|
16270
|
+
type GetWhatsappBusinessUsernameData = {
|
|
16271
|
+
query: {
|
|
16272
|
+
/**
|
|
16273
|
+
* WhatsApp social account ID
|
|
16274
|
+
*/
|
|
16275
|
+
accountId: string;
|
|
16276
|
+
};
|
|
16277
|
+
};
|
|
16278
|
+
type GetWhatsappBusinessUsernameResponse = ({
|
|
16279
|
+
success?: boolean;
|
|
16280
|
+
/**
|
|
16281
|
+
* The current username, or null if none is set
|
|
16282
|
+
*/
|
|
16283
|
+
username?: (string) | null;
|
|
16284
|
+
/**
|
|
16285
|
+
* Approval state of the username
|
|
16286
|
+
*/
|
|
16287
|
+
status?: 'approved' | 'reserved' | 'none';
|
|
16288
|
+
});
|
|
16289
|
+
type GetWhatsappBusinessUsernameError = ({
|
|
16290
|
+
error?: string;
|
|
16291
|
+
} | unknown);
|
|
16292
|
+
type SetWhatsappBusinessUsernameData = {
|
|
16293
|
+
body: {
|
|
16294
|
+
/**
|
|
16295
|
+
* WhatsApp social account ID
|
|
16296
|
+
*/
|
|
16297
|
+
accountId: string;
|
|
16298
|
+
/**
|
|
16299
|
+
* Desired username. Letters, digits, period, and underscore only. Must contain at least one letter. No leading, trailing, or consecutive periods. No www prefix. No domain TLD suffix.
|
|
16300
|
+
*
|
|
16301
|
+
*/
|
|
16302
|
+
username: string;
|
|
16303
|
+
/**
|
|
16304
|
+
* Pass `force_transfer` to request a transfer if the username is held by another account
|
|
16305
|
+
*/
|
|
16306
|
+
transferAction?: 'none' | 'force_transfer';
|
|
16307
|
+
};
|
|
16308
|
+
};
|
|
16309
|
+
type SetWhatsappBusinessUsernameResponse = ({
|
|
16310
|
+
success?: boolean;
|
|
16311
|
+
username?: string;
|
|
16312
|
+
status?: 'approved' | 'reserved' | 'none';
|
|
16313
|
+
});
|
|
16314
|
+
type SetWhatsappBusinessUsernameError = (unknown | {
|
|
16315
|
+
error?: string;
|
|
16316
|
+
});
|
|
16317
|
+
type DeleteWhatsappBusinessUsernameData = {
|
|
16318
|
+
body: {
|
|
16319
|
+
/**
|
|
16320
|
+
* WhatsApp social account ID
|
|
16321
|
+
*/
|
|
16322
|
+
accountId: string;
|
|
16323
|
+
};
|
|
16324
|
+
};
|
|
16325
|
+
type DeleteWhatsappBusinessUsernameResponse = ({
|
|
16326
|
+
success?: boolean;
|
|
16327
|
+
});
|
|
16328
|
+
type DeleteWhatsappBusinessUsernameError = ({
|
|
16329
|
+
error?: string;
|
|
16330
|
+
} | unknown);
|
|
16331
|
+
type GetWhatsappBusinessUsernameSuggestionsData = {
|
|
16332
|
+
query: {
|
|
16333
|
+
/**
|
|
16334
|
+
* WhatsApp social account ID
|
|
16335
|
+
*/
|
|
16336
|
+
accountId: string;
|
|
16337
|
+
};
|
|
16338
|
+
};
|
|
16339
|
+
type GetWhatsappBusinessUsernameSuggestionsResponse = ({
|
|
16340
|
+
success?: boolean;
|
|
16341
|
+
/**
|
|
16342
|
+
* List of available username suggestions
|
|
16343
|
+
*/
|
|
16344
|
+
suggestions?: Array<(string)>;
|
|
16345
|
+
});
|
|
16346
|
+
type GetWhatsappBusinessUsernameSuggestionsError = ({
|
|
16347
|
+
error?: string;
|
|
16348
|
+
} | unknown);
|
|
16349
|
+
type GetWhatsAppNumberInfoData = {
|
|
16350
|
+
query: {
|
|
16351
|
+
/**
|
|
16352
|
+
* WhatsApp social account ID
|
|
16353
|
+
*/
|
|
16354
|
+
accountId: string;
|
|
16355
|
+
};
|
|
16356
|
+
};
|
|
16357
|
+
type GetWhatsAppNumberInfoResponse = ({
|
|
16358
|
+
phone?: {
|
|
16359
|
+
display_phone_number?: string;
|
|
16360
|
+
verified_name?: string;
|
|
16361
|
+
/**
|
|
16362
|
+
* APPROVED, AVAILABLE_WITHOUT_REVIEW, PENDING_REVIEW, DECLINED, EXPIRED, NONE
|
|
16363
|
+
*/
|
|
16364
|
+
name_status?: string;
|
|
16365
|
+
/**
|
|
16366
|
+
* GREEN, YELLOW, RED, UNKNOWN
|
|
16367
|
+
*/
|
|
16368
|
+
quality_rating?: string;
|
|
16369
|
+
/**
|
|
16370
|
+
* e.g. TIER_250, TIER_1K, TIER_UNLIMITED
|
|
16371
|
+
*/
|
|
16372
|
+
messaging_limit_tier?: string;
|
|
16373
|
+
throughput?: {
|
|
16374
|
+
/**
|
|
16375
|
+
* STANDARD or HIGH
|
|
16376
|
+
*/
|
|
16377
|
+
level?: string;
|
|
16378
|
+
};
|
|
16379
|
+
/**
|
|
16380
|
+
* e.g. CONNECTED
|
|
16381
|
+
*/
|
|
16382
|
+
status?: string;
|
|
16383
|
+
is_official_business_account?: boolean;
|
|
16384
|
+
/**
|
|
16385
|
+
* e.g. CLOUD_API
|
|
16386
|
+
*/
|
|
16387
|
+
platform_type?: string;
|
|
16388
|
+
/**
|
|
16389
|
+
* Meta's can_send_message health object (messaging + calling signals)
|
|
16390
|
+
*/
|
|
16391
|
+
health_status?: {
|
|
16392
|
+
[key: string]: unknown;
|
|
16393
|
+
};
|
|
16394
|
+
};
|
|
16395
|
+
waba?: {
|
|
16396
|
+
name?: string;
|
|
16397
|
+
/**
|
|
16398
|
+
* verified, not_verified, pending, ...
|
|
16399
|
+
*/
|
|
16400
|
+
business_verification_status?: string;
|
|
16401
|
+
/**
|
|
16402
|
+
* Meta integer timezone-enum id
|
|
16403
|
+
*/
|
|
16404
|
+
timezone_id?: string;
|
|
16405
|
+
health_status?: {
|
|
16406
|
+
[key: string]: unknown;
|
|
16407
|
+
};
|
|
16408
|
+
} | null;
|
|
16409
|
+
});
|
|
16410
|
+
type GetWhatsAppNumberInfoError = (unknown | {
|
|
16411
|
+
error?: string;
|
|
16412
|
+
});
|
|
16413
|
+
type GetWhatsAppBlockStatusData = {
|
|
16414
|
+
query: {
|
|
16415
|
+
accountId: string;
|
|
16416
|
+
/**
|
|
16417
|
+
* Consumer wa_id or E.164 phone (leading + optional)
|
|
16418
|
+
*/
|
|
16419
|
+
user: string;
|
|
16420
|
+
};
|
|
16421
|
+
};
|
|
16422
|
+
type GetWhatsAppBlockStatusResponse = ({
|
|
16423
|
+
blocked?: boolean;
|
|
16424
|
+
});
|
|
16425
|
+
type GetWhatsAppBlockStatusError = ({
|
|
16426
|
+
error?: string;
|
|
16427
|
+
} | unknown);
|
|
16428
|
+
type GetWhatsAppBlockedUsersData = {
|
|
16429
|
+
query: {
|
|
16430
|
+
/**
|
|
16431
|
+
* WhatsApp social account ID
|
|
16432
|
+
*/
|
|
16433
|
+
accountId: string;
|
|
16434
|
+
/**
|
|
16435
|
+
* Cursor from a previous response's `nextCursor`.
|
|
16436
|
+
*/
|
|
16437
|
+
after?: string;
|
|
16438
|
+
/**
|
|
16439
|
+
* Page size.
|
|
16440
|
+
*/
|
|
16441
|
+
limit?: number;
|
|
16442
|
+
};
|
|
16443
|
+
};
|
|
16444
|
+
type GetWhatsAppBlockedUsersResponse = ({
|
|
16445
|
+
blockedUsers?: Array<{
|
|
16446
|
+
/**
|
|
16447
|
+
* WhatsApp user ID (usually the phone number without `+`).
|
|
16448
|
+
*/
|
|
16449
|
+
waId?: string;
|
|
16450
|
+
}>;
|
|
16451
|
+
/**
|
|
16452
|
+
* Pass as `after` to fetch the next page. Null when there are no more pages.
|
|
16453
|
+
*/
|
|
16454
|
+
nextCursor?: (string) | null;
|
|
16455
|
+
});
|
|
16456
|
+
type GetWhatsAppBlockedUsersError = ({
|
|
16457
|
+
error?: string;
|
|
16458
|
+
} | unknown);
|
|
16459
|
+
type BlockWhatsAppUsersData = {
|
|
16460
|
+
body: {
|
|
16461
|
+
/**
|
|
16462
|
+
* WhatsApp social account ID
|
|
16463
|
+
*/
|
|
16464
|
+
accountId: string;
|
|
16465
|
+
/**
|
|
16466
|
+
* Phone numbers (E.164, e.g. "+16505551234") or WhatsApp user IDs to block.
|
|
16467
|
+
*/
|
|
16468
|
+
users: Array<(string)>;
|
|
16469
|
+
};
|
|
16470
|
+
};
|
|
16471
|
+
type BlockWhatsAppUsersResponse = ({
|
|
16472
|
+
/**
|
|
16473
|
+
* Users successfully blocked.
|
|
16474
|
+
*/
|
|
16475
|
+
blocked?: Array<{
|
|
16476
|
+
/**
|
|
16477
|
+
* The value you sent.
|
|
16478
|
+
*/
|
|
16479
|
+
input?: string;
|
|
16480
|
+
/**
|
|
16481
|
+
* Resolved WhatsApp user ID.
|
|
16482
|
+
*/
|
|
16483
|
+
waId?: string;
|
|
16484
|
+
}>;
|
|
16485
|
+
/**
|
|
16486
|
+
* Users that could not be blocked, with reasons.
|
|
16487
|
+
*/
|
|
16488
|
+
failed?: Array<{
|
|
16489
|
+
input?: string;
|
|
16490
|
+
errors?: Array<(string)>;
|
|
16491
|
+
}>;
|
|
16492
|
+
});
|
|
16493
|
+
type BlockWhatsAppUsersError = ({
|
|
16494
|
+
error?: string;
|
|
16495
|
+
} | unknown);
|
|
16496
|
+
type UnblockWhatsAppUsersData = {
|
|
16497
|
+
body: {
|
|
16498
|
+
/**
|
|
16499
|
+
* WhatsApp social account ID
|
|
16500
|
+
*/
|
|
16501
|
+
accountId: string;
|
|
16502
|
+
/**
|
|
16503
|
+
* Phone numbers (E.164) or WhatsApp user IDs to unblock.
|
|
16504
|
+
*/
|
|
16505
|
+
users: Array<(string)>;
|
|
16506
|
+
};
|
|
16507
|
+
};
|
|
16508
|
+
type UnblockWhatsAppUsersResponse = ({
|
|
16509
|
+
/**
|
|
16510
|
+
* Users successfully unblocked.
|
|
16511
|
+
*/
|
|
16512
|
+
unblocked?: Array<{
|
|
16513
|
+
/**
|
|
16514
|
+
* The value you sent.
|
|
16515
|
+
*/
|
|
16516
|
+
input?: string;
|
|
16517
|
+
/**
|
|
16518
|
+
* Resolved WhatsApp user ID.
|
|
16519
|
+
*/
|
|
16520
|
+
waId?: string;
|
|
16521
|
+
}>;
|
|
16522
|
+
/**
|
|
16523
|
+
* Users that could not be unblocked, with reasons.
|
|
16524
|
+
*/
|
|
16525
|
+
failed?: Array<{
|
|
16526
|
+
input?: string;
|
|
16527
|
+
errors?: Array<(string)>;
|
|
16528
|
+
}>;
|
|
16529
|
+
});
|
|
16530
|
+
type UnblockWhatsAppUsersError = ({
|
|
16531
|
+
error?: string;
|
|
16532
|
+
} | unknown);
|
|
16533
|
+
type GetWhatsAppDatasetData = {
|
|
16534
|
+
query: {
|
|
15561
16535
|
/**
|
|
15562
16536
|
* WhatsApp social account ID
|
|
15563
16537
|
*/
|
|
@@ -15566,247 +16540,1042 @@ type GetWhatsAppDatasetData = {
|
|
|
15566
16540
|
};
|
|
15567
16541
|
type GetWhatsAppDatasetResponse = ({
|
|
15568
16542
|
/**
|
|
15569
|
-
* Meta dataset ID linked to the WABA, or null if not provisioned yet
|
|
16543
|
+
* Meta dataset ID linked to the WABA, or null if not provisioned yet
|
|
16544
|
+
*/
|
|
16545
|
+
datasetId?: (string) | null;
|
|
16546
|
+
});
|
|
16547
|
+
type GetWhatsAppDatasetError = ({
|
|
16548
|
+
error?: string;
|
|
16549
|
+
} | unknown);
|
|
16550
|
+
type CreateWhatsAppDatasetData = {
|
|
16551
|
+
body: {
|
|
16552
|
+
/**
|
|
16553
|
+
* WhatsApp social account ID
|
|
16554
|
+
*/
|
|
16555
|
+
accountId: string;
|
|
16556
|
+
};
|
|
16557
|
+
};
|
|
16558
|
+
type CreateWhatsAppDatasetResponse = ({
|
|
16559
|
+
/**
|
|
16560
|
+
* Meta dataset ID linked to the WABA
|
|
16561
|
+
*/
|
|
16562
|
+
datasetId?: string;
|
|
16563
|
+
/**
|
|
16564
|
+
* True if Meta created a new dataset on this call; false if one already existed
|
|
16565
|
+
*/
|
|
16566
|
+
created?: boolean;
|
|
16567
|
+
});
|
|
16568
|
+
type CreateWhatsAppDatasetError = ({
|
|
16569
|
+
error?: string;
|
|
16570
|
+
} | unknown);
|
|
16571
|
+
type ListPhoneNumbersData = {
|
|
16572
|
+
query?: {
|
|
16573
|
+
/**
|
|
16574
|
+
* Filter by profile
|
|
16575
|
+
*/
|
|
16576
|
+
profileId?: string;
|
|
16577
|
+
/**
|
|
16578
|
+
* Filter by status (by default excludes released numbers). NOTE:
|
|
16579
|
+
* `status=pending_regulatory` returns the "provisioning" view — numbers
|
|
16580
|
+
* still in review PLUS recently-declined (last 30 days) ones, so a
|
|
16581
|
+
* failed registration surfaces (with `regulatoryDeclineReason`) instead
|
|
16582
|
+
* of silently disappearing. Declined numbers can be re-submitted via
|
|
16583
|
+
* POST /v1/phone-numbers/{id}/remediate. `verifying` is the
|
|
16584
|
+
* short-lived state after the number is provisioned on our side while
|
|
16585
|
+
* WhatsApp confirms the activation code; the number is not billed until
|
|
16586
|
+
* it reaches `active`.
|
|
16587
|
+
*
|
|
16588
|
+
*/
|
|
16589
|
+
status?: 'provisioning' | 'verifying' | 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16590
|
+
};
|
|
16591
|
+
};
|
|
16592
|
+
type ListPhoneNumbersResponse = ({
|
|
16593
|
+
numbers?: Array<{
|
|
16594
|
+
_id?: string;
|
|
16595
|
+
phoneNumber?: string;
|
|
16596
|
+
country?: string;
|
|
16597
|
+
status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16598
|
+
/**
|
|
16599
|
+
* For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
|
|
16600
|
+
*/
|
|
16601
|
+
registrantName?: (string) | null;
|
|
16602
|
+
/**
|
|
16603
|
+
* Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review.
|
|
16604
|
+
*/
|
|
16605
|
+
telnyxOrderId?: (string) | null;
|
|
16606
|
+
/**
|
|
16607
|
+
* Per-country monthly price in cents ($2..$25).
|
|
16608
|
+
*/
|
|
16609
|
+
monthlyCents?: number;
|
|
16610
|
+
/**
|
|
16611
|
+
* False for numbers you brought yourself (connected via Meta embedded signup) — they live on your own carrier, so SMS/Calls can't be enabled on them.
|
|
16612
|
+
*/
|
|
16613
|
+
hostedByZernio?: boolean;
|
|
16614
|
+
profileId?: {
|
|
16615
|
+
[key: string]: unknown;
|
|
16616
|
+
};
|
|
16617
|
+
provisionedAt?: string;
|
|
16618
|
+
metaPreverifiedId?: string;
|
|
16619
|
+
metaVerificationStatus?: string;
|
|
16620
|
+
/**
|
|
16621
|
+
* For regulated (Tier 3/4) numbers with an Onfido ID-verification step — the link to forward to the end user. Set once the order is placed; null otherwise. Poll this field after submitting KYC.
|
|
16622
|
+
*/
|
|
16623
|
+
onfidoVerificationUrl?: (string) | null;
|
|
16624
|
+
endUserFirstName?: (string) | null;
|
|
16625
|
+
endUserLastName?: (string) | null;
|
|
16626
|
+
/**
|
|
16627
|
+
* Reviewer rejection reason when status is regulatory_declined.
|
|
16628
|
+
*/
|
|
16629
|
+
regulatoryDeclineReason?: (string) | null;
|
|
16630
|
+
createdAt?: string;
|
|
16631
|
+
}>;
|
|
16632
|
+
/**
|
|
16633
|
+
* Connected (bring-your-own) WhatsApp numbers — your own WABA
|
|
16634
|
+
* numbers linked via Embedded Signup. Not provisioned or billed
|
|
16635
|
+
* by Zernio, so they are not in `numbers`; `accountId` is the
|
|
16636
|
+
* social-account id used by the messaging and inbox endpoints.
|
|
16637
|
+
* Included only on the default and `status=active` views.
|
|
16638
|
+
*
|
|
16639
|
+
*/
|
|
16640
|
+
connected?: Array<{
|
|
16641
|
+
accountId?: string;
|
|
16642
|
+
phoneNumber?: (string) | null;
|
|
16643
|
+
displayName?: (string) | null;
|
|
16644
|
+
profileId?: (string) | null;
|
|
16645
|
+
connectedAt?: (string) | null;
|
|
16646
|
+
}>;
|
|
16647
|
+
/**
|
|
16648
|
+
* The shared WhatsApp sandbox (one Zernio-owned number, all users test
|
|
16649
|
+
* against it). Present when the sandbox is configured; null otherwise.
|
|
16650
|
+
* The `accountId` lets you address the sandbox in compose endpoints.
|
|
16651
|
+
* `template` is the only template a sandbox send is allowed to use.
|
|
16652
|
+
*
|
|
16653
|
+
*/
|
|
16654
|
+
sandbox?: {
|
|
16655
|
+
phoneNumber?: string;
|
|
16656
|
+
accountId?: (string) | null;
|
|
16657
|
+
template?: {
|
|
16658
|
+
name?: string;
|
|
16659
|
+
language?: string;
|
|
16660
|
+
};
|
|
16661
|
+
isSandbox?: boolean;
|
|
16662
|
+
} | null;
|
|
16663
|
+
});
|
|
16664
|
+
type ListPhoneNumbersError = ({
|
|
16665
|
+
error?: string;
|
|
16666
|
+
});
|
|
16667
|
+
type GetPhoneNumberData = {
|
|
16668
|
+
path: {
|
|
16669
|
+
/**
|
|
16670
|
+
* Phone number record ID
|
|
16671
|
+
*/
|
|
16672
|
+
id: string;
|
|
16673
|
+
};
|
|
16674
|
+
};
|
|
16675
|
+
type GetPhoneNumberResponse = ({
|
|
16676
|
+
phoneNumber?: {
|
|
16677
|
+
id?: string;
|
|
16678
|
+
phoneNumber?: string;
|
|
16679
|
+
status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16680
|
+
country?: string;
|
|
16681
|
+
metaPreverifiedId?: string;
|
|
16682
|
+
metaVerificationStatus?: string;
|
|
16683
|
+
/**
|
|
16684
|
+
* For a regulated number with an Onfido ID step — the link to forward to the end user. Appears once the order is placed; null otherwise.
|
|
16685
|
+
*/
|
|
16686
|
+
onfidoVerificationUrl?: (string) | null;
|
|
16687
|
+
endUserFirstName?: (string) | null;
|
|
16688
|
+
endUserLastName?: (string) | null;
|
|
16689
|
+
/**
|
|
16690
|
+
* Reviewer rejection reason when status is regulatory_declined.
|
|
16691
|
+
*/
|
|
16692
|
+
regulatoryDeclineReason?: (string) | null;
|
|
16693
|
+
provisionedAt?: string;
|
|
16694
|
+
};
|
|
16695
|
+
});
|
|
16696
|
+
type GetPhoneNumberError = ({
|
|
16697
|
+
error?: string;
|
|
16698
|
+
});
|
|
16699
|
+
type ReleasePhoneNumberData = {
|
|
16700
|
+
path: {
|
|
16701
|
+
/**
|
|
16702
|
+
* Phone number record ID
|
|
16703
|
+
*/
|
|
16704
|
+
id: string;
|
|
16705
|
+
};
|
|
16706
|
+
};
|
|
16707
|
+
type ReleasePhoneNumberResponse = ({
|
|
16708
|
+
message?: string;
|
|
16709
|
+
phoneNumber?: {
|
|
16710
|
+
id?: string;
|
|
16711
|
+
phoneNumber?: string;
|
|
16712
|
+
/**
|
|
16713
|
+
* "released"
|
|
16714
|
+
*/
|
|
16715
|
+
status?: string;
|
|
16716
|
+
releasedAt?: string;
|
|
16717
|
+
};
|
|
16718
|
+
});
|
|
16719
|
+
type ReleasePhoneNumberError = (unknown | {
|
|
16720
|
+
error?: string;
|
|
16721
|
+
});
|
|
16722
|
+
type PurchasePhoneNumberData = {
|
|
16723
|
+
body: {
|
|
16724
|
+
/**
|
|
16725
|
+
* Profile to associate the number with
|
|
16726
|
+
*/
|
|
16727
|
+
profileId: string;
|
|
16728
|
+
/**
|
|
16729
|
+
* ISO 3166-1 alpha-2 country for the number (default US). International numbers require usage-based billing. Tier 3/4 countries return 202 { status: "kyc_required", kycUrl } — the customer must complete KYC at that URL before the number is ordered. See GET /v1/phone-numbers/countries.
|
|
16730
|
+
*
|
|
16731
|
+
*/
|
|
16732
|
+
country?: string;
|
|
16733
|
+
/**
|
|
16734
|
+
* A phone number is the unit; WhatsApp is one optional feature. Pass false to buy a STANDALONE number (Calls/SMS only): provisioning skips the Meta pre-verify/OTP steps and the number activates immediately. Omitted defaults to the WhatsApp provisioning path. WhatsApp can be connected to a standalone number later from the connect flow.
|
|
16735
|
+
*
|
|
16736
|
+
*/
|
|
16737
|
+
connectWhatsapp?: boolean;
|
|
16738
|
+
/**
|
|
16739
|
+
* SMS capability is per-number, not per-country. Pass true to provision from the SMS-capable inventory pool so the number can actually text (see also GET /v1/phone-numbers/available with sms=true, and smsAvailable on GET /v1/phone-numbers/countries).
|
|
16740
|
+
*
|
|
16741
|
+
*/
|
|
16742
|
+
wantsSms?: boolean;
|
|
16743
|
+
/**
|
|
16744
|
+
* Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
|
|
16745
|
+
*
|
|
16746
|
+
*/
|
|
16747
|
+
purchaseIntentId?: string;
|
|
16748
|
+
/**
|
|
16749
|
+
* Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).
|
|
16750
|
+
*
|
|
16751
|
+
*/
|
|
16752
|
+
allowMultiple?: boolean;
|
|
16753
|
+
};
|
|
16754
|
+
};
|
|
16755
|
+
type PurchasePhoneNumberResponse = (({
|
|
16756
|
+
message?: string;
|
|
16757
|
+
checkoutUrl?: string;
|
|
16758
|
+
} | {
|
|
16759
|
+
message?: string;
|
|
16760
|
+
phoneNumber?: {
|
|
16761
|
+
id?: string;
|
|
16762
|
+
phoneNumber?: string;
|
|
16763
|
+
status?: string;
|
|
16764
|
+
country?: string;
|
|
16765
|
+
provisionedAt?: string;
|
|
16766
|
+
metaPreverifiedId?: string;
|
|
16767
|
+
metaVerificationStatus?: string;
|
|
16768
|
+
};
|
|
16769
|
+
} | {
|
|
16770
|
+
status?: 'already_purchased';
|
|
16771
|
+
numberId?: string;
|
|
16772
|
+
phoneNumber?: string;
|
|
16773
|
+
}) | {
|
|
16774
|
+
status?: 'kyc_required';
|
|
16775
|
+
country?: string;
|
|
16776
|
+
kycUrl?: string;
|
|
16777
|
+
});
|
|
16778
|
+
type PurchasePhoneNumberError = (unknown | {
|
|
16779
|
+
error?: string;
|
|
16780
|
+
} | {
|
|
16781
|
+
error?: string;
|
|
16782
|
+
code?: 'PURCHASE_VELOCITY';
|
|
16783
|
+
});
|
|
16784
|
+
type ListPhoneNumberCountriesResponse = ({
|
|
16785
|
+
countries?: Array<{
|
|
16786
|
+
/**
|
|
16787
|
+
* ISO 3166-1 alpha-2
|
|
16788
|
+
*/
|
|
16789
|
+
code?: string;
|
|
16790
|
+
tier?: 1 | 2 | 3 | 4;
|
|
16791
|
+
monthlyCents?: number;
|
|
16792
|
+
needsKyc?: boolean;
|
|
16793
|
+
/**
|
|
16794
|
+
* Regular phone (PSTN) calling on the number, inbound + outbound. Available on every offerable country.
|
|
16795
|
+
*/
|
|
16796
|
+
callsAvailable?: boolean;
|
|
16797
|
+
/**
|
|
16798
|
+
* WhatsApp can be enabled on numbers from this country.
|
|
16799
|
+
*/
|
|
16800
|
+
whatsappAvailable?: boolean;
|
|
16801
|
+
/**
|
|
16802
|
+
* Whether this country's number type can do SMS. Use it to filter the picker when the buyer wants SMS (pair with `wantsSms` on purchase).
|
|
16803
|
+
*/
|
|
16804
|
+
smsAvailable?: boolean;
|
|
16805
|
+
/**
|
|
16806
|
+
* WhatsApp Business Calling (BIC) outbound availability, a Meta feature blocked in some countries. NOT the PSTN Calls feature (`callsAvailable`).
|
|
16807
|
+
*/
|
|
16808
|
+
outboundCallingAvailable?: boolean;
|
|
16809
|
+
}>;
|
|
16810
|
+
});
|
|
16811
|
+
type ListPhoneNumberCountriesError = ({
|
|
16812
|
+
error?: string;
|
|
16813
|
+
});
|
|
16814
|
+
type SearchAvailablePhoneNumbersData = {
|
|
16815
|
+
query?: {
|
|
16816
|
+
/**
|
|
16817
|
+
* Pattern to match within the number
|
|
16818
|
+
*/
|
|
16819
|
+
contains?: string;
|
|
16820
|
+
country?: string;
|
|
16821
|
+
limit?: number;
|
|
16822
|
+
/**
|
|
16823
|
+
* City
|
|
16824
|
+
*/
|
|
16825
|
+
locality?: string;
|
|
16826
|
+
/**
|
|
16827
|
+
* Area code
|
|
16828
|
+
*/
|
|
16829
|
+
prefix?: string;
|
|
16830
|
+
/**
|
|
16831
|
+
* true narrows the pool to SMS-capable numbers. Each result still carries its full `features` list for per-number capability badging.
|
|
16832
|
+
*/
|
|
16833
|
+
sms?: boolean;
|
|
16834
|
+
/**
|
|
16835
|
+
* Number type; defaults to the country's WhatsApp-safe type
|
|
16836
|
+
*/
|
|
16837
|
+
type?: string;
|
|
16838
|
+
};
|
|
16839
|
+
};
|
|
16840
|
+
type SearchAvailablePhoneNumbersResponse = ({
|
|
16841
|
+
country?: string;
|
|
16842
|
+
numberType?: string;
|
|
16843
|
+
/**
|
|
16844
|
+
* Echo of the `sms` filter applied to this search.
|
|
16845
|
+
*/
|
|
16846
|
+
requireSms?: boolean;
|
|
16847
|
+
numbers?: Array<{
|
|
16848
|
+
phoneNumber?: string;
|
|
16849
|
+
/**
|
|
16850
|
+
* Provider capability list for this number (e.g. voice, sms, mms).
|
|
16851
|
+
*/
|
|
16852
|
+
features?: Array<(string)>;
|
|
16853
|
+
}>;
|
|
16854
|
+
});
|
|
16855
|
+
type SearchAvailablePhoneNumbersError = (unknown | {
|
|
16856
|
+
error?: string;
|
|
16857
|
+
});
|
|
16858
|
+
type CheckPhoneNumberAvailabilityData = {
|
|
16859
|
+
query: {
|
|
16860
|
+
/**
|
|
16861
|
+
* ISO-2 country code.
|
|
16862
|
+
*/
|
|
16863
|
+
country: string;
|
|
16864
|
+
};
|
|
16865
|
+
};
|
|
16866
|
+
type CheckPhoneNumberAvailabilityResponse = ({
|
|
16867
|
+
country?: string;
|
|
16868
|
+
numberType?: string;
|
|
16869
|
+
/**
|
|
16870
|
+
* Whether deliverable voice inventory exists right now.
|
|
16871
|
+
*/
|
|
16872
|
+
available?: boolean;
|
|
16873
|
+
addressConstraint?: 'geo' | 'country' | 'none';
|
|
16874
|
+
/**
|
|
16875
|
+
* For `geo` only — the area(s) the registered address must be in.
|
|
16876
|
+
*/
|
|
16877
|
+
areas?: Array<(string)>;
|
|
16878
|
+
});
|
|
16879
|
+
type CheckPhoneNumberAvailabilityError = (unknown | {
|
|
16880
|
+
error?: string;
|
|
16881
|
+
});
|
|
16882
|
+
type GetWhatsAppPhoneNumbersData = {
|
|
16883
|
+
query?: {
|
|
16884
|
+
/**
|
|
16885
|
+
* Filter by profile
|
|
16886
|
+
*/
|
|
16887
|
+
profileId?: string;
|
|
16888
|
+
/**
|
|
16889
|
+
* Filter by status (by default excludes released numbers). NOTE:
|
|
16890
|
+
* `status=pending_regulatory` returns the "provisioning" view — numbers
|
|
16891
|
+
* still in review PLUS recently-declined (last 30 days) ones, so a
|
|
16892
|
+
* failed registration surfaces (with `regulatoryDeclineReason`) instead
|
|
16893
|
+
* of silently disappearing. Declined numbers can be re-submitted via
|
|
16894
|
+
* POST /v1/whatsapp/phone-numbers/{id}/remediate. `verifying` is the
|
|
16895
|
+
* short-lived state after the number is provisioned on our side while
|
|
16896
|
+
* WhatsApp confirms the activation code; the number is not billed until
|
|
16897
|
+
* it reaches `active`.
|
|
16898
|
+
*
|
|
16899
|
+
*/
|
|
16900
|
+
status?: 'provisioning' | 'verifying' | 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16901
|
+
};
|
|
16902
|
+
};
|
|
16903
|
+
type GetWhatsAppPhoneNumbersResponse = ({
|
|
16904
|
+
numbers?: Array<{
|
|
16905
|
+
_id?: string;
|
|
16906
|
+
phoneNumber?: string;
|
|
16907
|
+
country?: string;
|
|
16908
|
+
status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16909
|
+
/**
|
|
16910
|
+
* For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
|
|
16911
|
+
*/
|
|
16912
|
+
registrantName?: (string) | null;
|
|
16913
|
+
/**
|
|
16914
|
+
* Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review.
|
|
16915
|
+
*/
|
|
16916
|
+
telnyxOrderId?: (string) | null;
|
|
16917
|
+
/**
|
|
16918
|
+
* Per-country monthly price in cents ($2..$25).
|
|
16919
|
+
*/
|
|
16920
|
+
monthlyCents?: number;
|
|
16921
|
+
/**
|
|
16922
|
+
* False for numbers you brought yourself (connected via Meta embedded signup) — they live on your own carrier, so SMS/Calls can't be enabled on them.
|
|
16923
|
+
*/
|
|
16924
|
+
hostedByZernio?: boolean;
|
|
16925
|
+
profileId?: {
|
|
16926
|
+
[key: string]: unknown;
|
|
16927
|
+
};
|
|
16928
|
+
provisionedAt?: string;
|
|
16929
|
+
metaPreverifiedId?: string;
|
|
16930
|
+
metaVerificationStatus?: string;
|
|
16931
|
+
/**
|
|
16932
|
+
* For regulated (Tier 3/4) numbers with an Onfido ID-verification step — the link to forward to the end user. Set once the order is placed; null otherwise. Poll this field after submitting KYC.
|
|
16933
|
+
*/
|
|
16934
|
+
onfidoVerificationUrl?: (string) | null;
|
|
16935
|
+
endUserFirstName?: (string) | null;
|
|
16936
|
+
endUserLastName?: (string) | null;
|
|
16937
|
+
/**
|
|
16938
|
+
* Reviewer rejection reason when status is regulatory_declined.
|
|
16939
|
+
*/
|
|
16940
|
+
regulatoryDeclineReason?: (string) | null;
|
|
16941
|
+
createdAt?: string;
|
|
16942
|
+
}>;
|
|
16943
|
+
/**
|
|
16944
|
+
* Connected (bring-your-own) WhatsApp numbers — your own WABA
|
|
16945
|
+
* numbers linked via Embedded Signup. Not provisioned or billed
|
|
16946
|
+
* by Zernio, so they are not in `numbers`; `accountId` is the
|
|
16947
|
+
* social-account id used by the messaging and inbox endpoints.
|
|
16948
|
+
* Included only on the default and `status=active` views.
|
|
16949
|
+
*
|
|
16950
|
+
*/
|
|
16951
|
+
connected?: Array<{
|
|
16952
|
+
accountId?: string;
|
|
16953
|
+
phoneNumber?: (string) | null;
|
|
16954
|
+
displayName?: (string) | null;
|
|
16955
|
+
profileId?: (string) | null;
|
|
16956
|
+
connectedAt?: (string) | null;
|
|
16957
|
+
}>;
|
|
16958
|
+
/**
|
|
16959
|
+
* The shared WhatsApp sandbox (one Zernio-owned number, all users test
|
|
16960
|
+
* against it). Present when the sandbox is configured; null otherwise.
|
|
16961
|
+
* The `accountId` lets you address the sandbox in compose endpoints.
|
|
16962
|
+
* `template` is the only template a sandbox send is allowed to use.
|
|
16963
|
+
*
|
|
16964
|
+
*/
|
|
16965
|
+
sandbox?: {
|
|
16966
|
+
phoneNumber?: string;
|
|
16967
|
+
accountId?: (string) | null;
|
|
16968
|
+
template?: {
|
|
16969
|
+
name?: string;
|
|
16970
|
+
language?: string;
|
|
16971
|
+
};
|
|
16972
|
+
isSandbox?: boolean;
|
|
16973
|
+
} | null;
|
|
16974
|
+
});
|
|
16975
|
+
type GetWhatsAppPhoneNumbersError = ({
|
|
16976
|
+
error?: string;
|
|
16977
|
+
});
|
|
16978
|
+
type PurchaseWhatsAppPhoneNumberData = {
|
|
16979
|
+
body: {
|
|
16980
|
+
/**
|
|
16981
|
+
* Profile to associate the number with
|
|
16982
|
+
*/
|
|
16983
|
+
profileId: string;
|
|
16984
|
+
/**
|
|
16985
|
+
* ISO 3166-1 alpha-2 country for the number (default US). International numbers require usage-based billing. Tier 3/4 countries return 202 { status: "kyc_required", kycUrl } — the customer must complete KYC at that URL before the number is ordered. See GET /v1/whatsapp/phone-numbers/countries.
|
|
16986
|
+
*
|
|
16987
|
+
*/
|
|
16988
|
+
country?: string;
|
|
16989
|
+
/**
|
|
16990
|
+
* Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
|
|
16991
|
+
*
|
|
16992
|
+
*/
|
|
16993
|
+
purchaseIntentId?: string;
|
|
16994
|
+
/**
|
|
16995
|
+
* Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).
|
|
16996
|
+
*
|
|
16997
|
+
*/
|
|
16998
|
+
allowMultiple?: boolean;
|
|
16999
|
+
};
|
|
17000
|
+
};
|
|
17001
|
+
type PurchaseWhatsAppPhoneNumberResponse = (({
|
|
17002
|
+
message?: string;
|
|
17003
|
+
checkoutUrl?: string;
|
|
17004
|
+
} | {
|
|
17005
|
+
message?: string;
|
|
17006
|
+
phoneNumber?: {
|
|
17007
|
+
id?: string;
|
|
17008
|
+
phoneNumber?: string;
|
|
17009
|
+
status?: string;
|
|
17010
|
+
country?: string;
|
|
17011
|
+
provisionedAt?: string;
|
|
17012
|
+
metaPreverifiedId?: string;
|
|
17013
|
+
metaVerificationStatus?: string;
|
|
17014
|
+
};
|
|
17015
|
+
} | {
|
|
17016
|
+
status?: 'already_purchased';
|
|
17017
|
+
numberId?: string;
|
|
17018
|
+
phoneNumber?: string;
|
|
17019
|
+
}) | {
|
|
17020
|
+
status?: 'kyc_required';
|
|
17021
|
+
country?: string;
|
|
17022
|
+
kycUrl?: string;
|
|
17023
|
+
});
|
|
17024
|
+
type PurchaseWhatsAppPhoneNumberError = (unknown | {
|
|
17025
|
+
error?: string;
|
|
17026
|
+
} | {
|
|
17027
|
+
error?: string;
|
|
17028
|
+
code?: 'PURCHASE_VELOCITY';
|
|
17029
|
+
});
|
|
17030
|
+
type ListWhatsAppNumberCountriesResponse = ({
|
|
17031
|
+
countries?: Array<{
|
|
17032
|
+
/**
|
|
17033
|
+
* ISO 3166-1 alpha-2
|
|
17034
|
+
*/
|
|
17035
|
+
code?: string;
|
|
17036
|
+
tier?: 1 | 2 | 3 | 4;
|
|
17037
|
+
monthlyCents?: number;
|
|
17038
|
+
needsKyc?: boolean;
|
|
17039
|
+
outboundCallingAvailable?: boolean;
|
|
17040
|
+
}>;
|
|
17041
|
+
});
|
|
17042
|
+
type ListWhatsAppNumberCountriesError = ({
|
|
17043
|
+
error?: string;
|
|
17044
|
+
});
|
|
17045
|
+
type SearchAvailableWhatsAppNumbersData = {
|
|
17046
|
+
query?: {
|
|
17047
|
+
/**
|
|
17048
|
+
* Pattern to match within the number
|
|
17049
|
+
*/
|
|
17050
|
+
contains?: string;
|
|
17051
|
+
country?: string;
|
|
17052
|
+
limit?: number;
|
|
17053
|
+
/**
|
|
17054
|
+
* City
|
|
17055
|
+
*/
|
|
17056
|
+
locality?: string;
|
|
17057
|
+
/**
|
|
17058
|
+
* Area code
|
|
17059
|
+
*/
|
|
17060
|
+
prefix?: string;
|
|
17061
|
+
/**
|
|
17062
|
+
* Number type; defaults to the country's WhatsApp-safe type
|
|
17063
|
+
*/
|
|
17064
|
+
type?: string;
|
|
17065
|
+
};
|
|
17066
|
+
};
|
|
17067
|
+
type SearchAvailableWhatsAppNumbersResponse = ({
|
|
17068
|
+
country?: string;
|
|
17069
|
+
numberType?: string;
|
|
17070
|
+
numbers?: Array<{
|
|
17071
|
+
phoneNumber?: string;
|
|
17072
|
+
}>;
|
|
17073
|
+
});
|
|
17074
|
+
type SearchAvailableWhatsAppNumbersError = (unknown | {
|
|
17075
|
+
error?: string;
|
|
17076
|
+
});
|
|
17077
|
+
type CheckWhatsAppNumberAvailabilityData = {
|
|
17078
|
+
query: {
|
|
17079
|
+
/**
|
|
17080
|
+
* ISO-2 country code.
|
|
17081
|
+
*/
|
|
17082
|
+
country: string;
|
|
17083
|
+
};
|
|
17084
|
+
};
|
|
17085
|
+
type CheckWhatsAppNumberAvailabilityResponse = ({
|
|
17086
|
+
country?: string;
|
|
17087
|
+
numberType?: string;
|
|
17088
|
+
/**
|
|
17089
|
+
* Whether deliverable voice inventory exists right now.
|
|
17090
|
+
*/
|
|
17091
|
+
available?: boolean;
|
|
17092
|
+
addressConstraint?: 'geo' | 'country' | 'none';
|
|
17093
|
+
/**
|
|
17094
|
+
* For `geo` only — the area(s) the registered address must be in.
|
|
17095
|
+
*/
|
|
17096
|
+
areas?: Array<(string)>;
|
|
17097
|
+
});
|
|
17098
|
+
type CheckWhatsAppNumberAvailabilityError = (unknown | {
|
|
17099
|
+
error?: string;
|
|
17100
|
+
});
|
|
17101
|
+
type GetPhoneNumberKycFormData = {
|
|
17102
|
+
query: {
|
|
17103
|
+
country: string;
|
|
17104
|
+
};
|
|
17105
|
+
};
|
|
17106
|
+
type GetPhoneNumberKycFormResponse = ({
|
|
17107
|
+
country?: string;
|
|
17108
|
+
numberType?: string;
|
|
17109
|
+
fields?: Array<{
|
|
17110
|
+
requirementId?: string;
|
|
17111
|
+
label?: string;
|
|
17112
|
+
/**
|
|
17113
|
+
* "action" = an out-of-band verification (e.g. Onfido); not filled here, fulfilled after the order via a link.
|
|
17114
|
+
*/
|
|
17115
|
+
kind?: 'text' | 'date' | 'address' | 'file' | 'action';
|
|
17116
|
+
/**
|
|
17117
|
+
* Plain-English explanation of what to provide.
|
|
17118
|
+
*/
|
|
17119
|
+
description?: (string) | null;
|
|
17120
|
+
/**
|
|
17121
|
+
* Concrete example value.
|
|
17122
|
+
*/
|
|
17123
|
+
example?: (string) | null;
|
|
17124
|
+
/**
|
|
17125
|
+
* ISO country the value must be local to
|
|
17126
|
+
*/
|
|
17127
|
+
localTo?: (string) | null;
|
|
17128
|
+
}>;
|
|
17129
|
+
/**
|
|
17130
|
+
* Present when this account already has an approved verification for the country that can be reused (skip the form). `fromPhoneNumber`/`details` mirror the newest option; `options` lists ALL approved verifications (agencies hold one per end client) — pass the chosen option's `fromPhoneNumber` as `reuseFrom` on POST.
|
|
17131
|
+
*/
|
|
17132
|
+
reusable?: {
|
|
17133
|
+
available?: boolean;
|
|
17134
|
+
fromPhoneNumber?: string;
|
|
17135
|
+
/**
|
|
17136
|
+
* Human-readable summary of the verification on file (field labels + values, plus the address as one line). Best-effort — may be empty if the provider lookup fails.
|
|
17137
|
+
*/
|
|
17138
|
+
details?: Array<{
|
|
17139
|
+
label?: string;
|
|
17140
|
+
value?: string;
|
|
17141
|
+
}>;
|
|
17142
|
+
/**
|
|
17143
|
+
* One entry per distinct approved verification, newest first.
|
|
17144
|
+
*/
|
|
17145
|
+
options?: Array<{
|
|
17146
|
+
fromPhoneNumber?: string;
|
|
17147
|
+
details?: Array<{
|
|
17148
|
+
label?: string;
|
|
17149
|
+
value?: string;
|
|
17150
|
+
}>;
|
|
17151
|
+
}>;
|
|
17152
|
+
} | null;
|
|
17153
|
+
});
|
|
17154
|
+
type GetPhoneNumberKycFormError = (unknown | {
|
|
17155
|
+
error?: string;
|
|
17156
|
+
});
|
|
17157
|
+
type SubmitPhoneNumberKycData = {
|
|
17158
|
+
body: {
|
|
17159
|
+
profileId: string;
|
|
17160
|
+
country: string;
|
|
17161
|
+
/**
|
|
17162
|
+
* Idempotency token for this submission attempt. A retry/double-submit with the same token returns the same number; omit and each call creates a new number.
|
|
17163
|
+
*/
|
|
17164
|
+
submissionId?: string;
|
|
17165
|
+
/**
|
|
17166
|
+
* Provision several same-country numbers from one submission (1-5). The single verification covers all of them; each number is billed only when it activates. Numbers that fail to order are skipped (best-effort).
|
|
17167
|
+
*/
|
|
17168
|
+
quantity?: number;
|
|
17169
|
+
/**
|
|
17170
|
+
* Reuse a prior approved verification for this country (skips document/field collection; places the order immediately).
|
|
17171
|
+
*/
|
|
17172
|
+
reuse?: boolean;
|
|
17173
|
+
/**
|
|
17174
|
+
* Which approved verification to reuse when several exist: the phone number it was originally approved for (GET reusable.options[].fromPhoneNumber). Omitted = newest. No match = 409.
|
|
17175
|
+
*/
|
|
17176
|
+
reuseFrom?: string;
|
|
17177
|
+
/**
|
|
17178
|
+
* End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
|
|
17179
|
+
*/
|
|
17180
|
+
endUserFirstName?: string;
|
|
17181
|
+
/**
|
|
17182
|
+
* End user's legal last name. Same condition as endUserFirstName.
|
|
17183
|
+
*/
|
|
17184
|
+
endUserLastName?: string;
|
|
17185
|
+
/**
|
|
17186
|
+
* requirementId → textual value
|
|
17187
|
+
*/
|
|
17188
|
+
values?: {
|
|
17189
|
+
[key: string]: (string);
|
|
17190
|
+
};
|
|
17191
|
+
/**
|
|
17192
|
+
* One per document requirement. Each is EITHER inline base64 OR a `documentId` returned by POST /v1/phone-numbers/kyc/upload-document (use the upload endpoint for large files to stay under the request-size limit).
|
|
17193
|
+
*/
|
|
17194
|
+
documents?: Array<({
|
|
17195
|
+
requirementId: string;
|
|
17196
|
+
filename: string;
|
|
17197
|
+
base64: string;
|
|
17198
|
+
} | {
|
|
17199
|
+
requirementId: string;
|
|
17200
|
+
/**
|
|
17201
|
+
* Id from POST /v1/phone-numbers/kyc/upload-document.
|
|
17202
|
+
*/
|
|
17203
|
+
documentId: string;
|
|
17204
|
+
})>;
|
|
17205
|
+
address?: {
|
|
17206
|
+
requirementId?: string;
|
|
17207
|
+
country_code?: string;
|
|
17208
|
+
business_name?: string;
|
|
17209
|
+
first_name?: string;
|
|
17210
|
+
last_name?: string;
|
|
17211
|
+
street_address?: string;
|
|
17212
|
+
locality?: string;
|
|
17213
|
+
administrative_area?: string;
|
|
17214
|
+
postal_code?: string;
|
|
17215
|
+
};
|
|
17216
|
+
};
|
|
17217
|
+
};
|
|
17218
|
+
type SubmitPhoneNumberKycResponse = ({
|
|
17219
|
+
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
17220
|
+
/**
|
|
17221
|
+
* The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
|
|
17222
|
+
*/
|
|
17223
|
+
phoneNumber?: {
|
|
17224
|
+
id?: string;
|
|
17225
|
+
status?: string;
|
|
17226
|
+
country?: string;
|
|
17227
|
+
};
|
|
17228
|
+
/**
|
|
17229
|
+
* Every number provisioned from this submission. Length equals the requested `quantity` on full success (fewer if some orders failed; best-effort). The first element mirrors `phoneNumber`.
|
|
17230
|
+
*/
|
|
17231
|
+
numbers?: Array<{
|
|
17232
|
+
id?: string;
|
|
17233
|
+
status?: string;
|
|
17234
|
+
phoneNumber?: string;
|
|
17235
|
+
country?: string;
|
|
17236
|
+
}>;
|
|
17237
|
+
});
|
|
17238
|
+
type SubmitPhoneNumberKycError = (unknown | {
|
|
17239
|
+
error?: string;
|
|
17240
|
+
});
|
|
17241
|
+
type UploadPhoneNumberKycDocumentData = {
|
|
17242
|
+
body: (Blob | File);
|
|
17243
|
+
headers: {
|
|
17244
|
+
/**
|
|
17245
|
+
* URL-encoded original filename.
|
|
17246
|
+
*/
|
|
17247
|
+
'X-Filename': string;
|
|
17248
|
+
};
|
|
17249
|
+
};
|
|
17250
|
+
type UploadPhoneNumberKycDocumentResponse = ({
|
|
17251
|
+
/**
|
|
17252
|
+
* Reference this id in the KYC submit's documents[].documentId.
|
|
15570
17253
|
*/
|
|
15571
|
-
|
|
17254
|
+
documentId?: string;
|
|
15572
17255
|
});
|
|
15573
|
-
type
|
|
17256
|
+
type UploadPhoneNumberKycDocumentError = (unknown | {
|
|
15574
17257
|
error?: string;
|
|
15575
|
-
}
|
|
15576
|
-
type
|
|
17258
|
+
});
|
|
17259
|
+
type ValidatePhoneNumberKycAddressData = {
|
|
15577
17260
|
body: {
|
|
15578
17261
|
/**
|
|
15579
|
-
*
|
|
17262
|
+
* ISO 3166-1 alpha-2 country code.
|
|
15580
17263
|
*/
|
|
15581
|
-
|
|
17264
|
+
country: string;
|
|
17265
|
+
street_address: string;
|
|
17266
|
+
/**
|
|
17267
|
+
* City / town.
|
|
17268
|
+
*/
|
|
17269
|
+
locality: string;
|
|
17270
|
+
/**
|
|
17271
|
+
* State / province / region. When omitted, the pre-check is skipped (the final submit still validates).
|
|
17272
|
+
*/
|
|
17273
|
+
administrative_area?: string;
|
|
17274
|
+
postal_code: string;
|
|
15582
17275
|
};
|
|
15583
17276
|
};
|
|
15584
|
-
type
|
|
17277
|
+
type ValidatePhoneNumberKycAddressResponse = ({
|
|
17278
|
+
ok?: boolean;
|
|
15585
17279
|
/**
|
|
15586
|
-
*
|
|
17280
|
+
* true when no `administrative_area` was supplied, so no pre-check ran.
|
|
15587
17281
|
*/
|
|
15588
|
-
|
|
17282
|
+
skipped?: boolean;
|
|
17283
|
+
});
|
|
17284
|
+
type ValidatePhoneNumberKycAddressError = ({
|
|
15589
17285
|
/**
|
|
15590
|
-
*
|
|
17286
|
+
* Human-readable message.
|
|
15591
17287
|
*/
|
|
15592
|
-
created?: boolean;
|
|
15593
|
-
});
|
|
15594
|
-
type CreateWhatsAppDatasetError = ({
|
|
15595
17288
|
error?: string;
|
|
15596
|
-
|
|
15597
|
-
|
|
15598
|
-
|
|
17289
|
+
type?: string;
|
|
17290
|
+
code?: string;
|
|
17291
|
+
param?: string;
|
|
17292
|
+
details?: {
|
|
17293
|
+
addressSuggestions?: Array<{
|
|
17294
|
+
field?: string;
|
|
17295
|
+
label?: string;
|
|
17296
|
+
value?: string;
|
|
17297
|
+
}>;
|
|
17298
|
+
};
|
|
17299
|
+
} | {
|
|
17300
|
+
error?: string;
|
|
17301
|
+
});
|
|
17302
|
+
type CreatePhoneNumberKycLinkData = {
|
|
17303
|
+
body: {
|
|
17304
|
+
profileId: string;
|
|
15599
17305
|
/**
|
|
15600
|
-
*
|
|
17306
|
+
* ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).
|
|
15601
17307
|
*/
|
|
15602
|
-
|
|
17308
|
+
country: string;
|
|
15603
17309
|
/**
|
|
15604
|
-
*
|
|
15605
|
-
|
|
15606
|
-
|
|
15607
|
-
|
|
15608
|
-
|
|
15609
|
-
|
|
15610
|
-
|
|
15611
|
-
|
|
15612
|
-
|
|
17310
|
+
* Optional white-label of the hosted page the end customer sees.
|
|
17311
|
+
*/
|
|
17312
|
+
branding?: {
|
|
17313
|
+
/**
|
|
17314
|
+
* Your company name, shown on the hosted page.
|
|
17315
|
+
*/
|
|
17316
|
+
companyName?: string;
|
|
17317
|
+
/**
|
|
17318
|
+
* Logo shown above the form.
|
|
17319
|
+
*/
|
|
17320
|
+
logoUrl?: string;
|
|
17321
|
+
/**
|
|
17322
|
+
* Hex color (e.g. #1a73e8) used as a brand accent on the page.
|
|
17323
|
+
*/
|
|
17324
|
+
brandColor?: string;
|
|
17325
|
+
};
|
|
17326
|
+
/**
|
|
17327
|
+
* Where to send the end customer's browser after a successful
|
|
17328
|
+
* submit. On completion Zernio appends `kyc=submitted` and
|
|
17329
|
+
* `country=<ISO-2>` as query params. When omitted, the hosted
|
|
17330
|
+
* page shows a built-in confirmation screen instead.
|
|
15613
17331
|
*
|
|
15614
17332
|
*/
|
|
15615
|
-
|
|
17333
|
+
redirect_url?: string;
|
|
15616
17334
|
};
|
|
15617
17335
|
};
|
|
15618
|
-
type
|
|
15619
|
-
|
|
15620
|
-
|
|
15621
|
-
|
|
15622
|
-
|
|
15623
|
-
|
|
17336
|
+
type CreatePhoneNumberKycLinkResponse = ({
|
|
17337
|
+
/**
|
|
17338
|
+
* The hosted link to send your end customer.
|
|
17339
|
+
*/
|
|
17340
|
+
url?: string;
|
|
17341
|
+
token?: string;
|
|
17342
|
+
expiresAt?: string;
|
|
17343
|
+
});
|
|
17344
|
+
type CreatePhoneNumberKycLinkError = (unknown | {
|
|
17345
|
+
error?: string;
|
|
17346
|
+
});
|
|
17347
|
+
type CreatePhoneNumberPortInData = {
|
|
17348
|
+
body: {
|
|
15624
17349
|
/**
|
|
15625
|
-
*
|
|
17350
|
+
* E.164 numbers to port in.
|
|
15626
17351
|
*/
|
|
15627
|
-
|
|
17352
|
+
phoneNumbers: Array<(string)>;
|
|
15628
17353
|
/**
|
|
15629
|
-
*
|
|
17354
|
+
* End-user / current-carrier account info that authorizes the port.
|
|
15630
17355
|
*/
|
|
15631
|
-
|
|
17356
|
+
endUser: {
|
|
17357
|
+
entityName: string;
|
|
17358
|
+
authPersonName: string;
|
|
17359
|
+
billingPhoneNumber?: string;
|
|
17360
|
+
accountNumber?: string;
|
|
17361
|
+
/**
|
|
17362
|
+
* Transfer PIN. Forwarded to the carrier, never stored.
|
|
17363
|
+
*/
|
|
17364
|
+
pinPasscode?: string;
|
|
17365
|
+
streetAddress: string;
|
|
17366
|
+
extendedAddress?: string;
|
|
17367
|
+
locality: string;
|
|
17368
|
+
administrativeArea: string;
|
|
17369
|
+
postalCode: string;
|
|
17370
|
+
countryCode: string;
|
|
17371
|
+
};
|
|
15632
17372
|
/**
|
|
15633
|
-
*
|
|
17373
|
+
* Document id from POST /v1/phone-numbers/port-in/documents (kind=loa).
|
|
15634
17374
|
*/
|
|
15635
|
-
|
|
15636
|
-
profileId?: {
|
|
15637
|
-
[key: string]: unknown;
|
|
15638
|
-
};
|
|
15639
|
-
provisionedAt?: string;
|
|
15640
|
-
metaPreverifiedId?: string;
|
|
15641
|
-
metaVerificationStatus?: string;
|
|
17375
|
+
loaDocumentId: string;
|
|
15642
17376
|
/**
|
|
15643
|
-
*
|
|
17377
|
+
* Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice).
|
|
15644
17378
|
*/
|
|
15645
|
-
|
|
15646
|
-
endUserFirstName?: (string) | null;
|
|
15647
|
-
endUserLastName?: (string) | null;
|
|
17379
|
+
invoiceDocumentId: string;
|
|
15648
17380
|
/**
|
|
15649
|
-
*
|
|
17381
|
+
* Requested port date; the carrier confirms the actual FOC later.
|
|
15650
17382
|
*/
|
|
15651
|
-
|
|
15652
|
-
|
|
15653
|
-
}
|
|
17383
|
+
focDatetimeRequested?: string;
|
|
17384
|
+
customerReference?: string;
|
|
17385
|
+
};
|
|
17386
|
+
};
|
|
17387
|
+
type CreatePhoneNumberPortInResponse = ({
|
|
15654
17388
|
/**
|
|
15655
|
-
*
|
|
15656
|
-
* numbers linked via Embedded Signup. Not provisioned or billed
|
|
15657
|
-
* by Zernio, so they are not in `numbers`; `accountId` is the
|
|
15658
|
-
* social-account id used by the messaging and inbox endpoints.
|
|
15659
|
-
* Included only on the default and `status=active` views.
|
|
15660
|
-
*
|
|
17389
|
+
* Porting order ID.
|
|
15661
17390
|
*/
|
|
15662
|
-
|
|
15663
|
-
|
|
15664
|
-
|
|
15665
|
-
|
|
15666
|
-
|
|
15667
|
-
|
|
17391
|
+
id?: string;
|
|
17392
|
+
telnyxPortingOrderId?: string;
|
|
17393
|
+
status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
|
|
17394
|
+
phoneNumbers?: Array<(string)>;
|
|
17395
|
+
orders?: Array<{
|
|
17396
|
+
id?: string;
|
|
17397
|
+
telnyxPortingOrderId?: string;
|
|
17398
|
+
status?: string;
|
|
17399
|
+
phoneNumbers?: Array<(string)>;
|
|
17400
|
+
/**
|
|
17401
|
+
* Present when this split order failed to submit (it stays as a cancellable draft).
|
|
17402
|
+
*/
|
|
17403
|
+
error?: string;
|
|
15668
17404
|
}>;
|
|
15669
|
-
/**
|
|
15670
|
-
* The shared WhatsApp sandbox (one Zernio-owned number, all users test
|
|
15671
|
-
* against it). Present when the sandbox is configured; null otherwise.
|
|
15672
|
-
* The `accountId` lets you address the sandbox in compose endpoints.
|
|
15673
|
-
* `template` is the only template a sandbox send is allowed to use.
|
|
15674
|
-
*
|
|
15675
|
-
*/
|
|
15676
|
-
sandbox?: {
|
|
15677
|
-
phoneNumber?: string;
|
|
15678
|
-
accountId?: (string) | null;
|
|
15679
|
-
template?: {
|
|
15680
|
-
name?: string;
|
|
15681
|
-
language?: string;
|
|
15682
|
-
};
|
|
15683
|
-
isSandbox?: boolean;
|
|
15684
|
-
} | null;
|
|
15685
17405
|
});
|
|
15686
|
-
type
|
|
17406
|
+
type CreatePhoneNumberPortInError = ({
|
|
15687
17407
|
error?: string;
|
|
17408
|
+
} | unknown);
|
|
17409
|
+
type ListPhoneNumberPortInsResponse = ({
|
|
17410
|
+
orders?: Array<{
|
|
17411
|
+
id?: string;
|
|
17412
|
+
status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
|
|
17413
|
+
/**
|
|
17414
|
+
* Raw carrier status string.
|
|
17415
|
+
*/
|
|
17416
|
+
telnyxStatusValue?: (string) | null;
|
|
17417
|
+
phoneNumbers?: Array<(string)>;
|
|
17418
|
+
fastPortEligible?: (boolean) | null;
|
|
17419
|
+
focDatetimeRequested?: (string) | null;
|
|
17420
|
+
focDatetimeActual?: (string) | null;
|
|
17421
|
+
declineReason?: (string) | null;
|
|
17422
|
+
submittedAt?: (string) | null;
|
|
17423
|
+
portedAt?: (string) | null;
|
|
17424
|
+
createdAt?: string;
|
|
17425
|
+
}>;
|
|
15688
17426
|
});
|
|
15689
|
-
type
|
|
17427
|
+
type ListPhoneNumberPortInsError = ({
|
|
17428
|
+
error?: string;
|
|
17429
|
+
});
|
|
17430
|
+
type CheckPhoneNumberPortabilityData = {
|
|
15690
17431
|
body: {
|
|
15691
17432
|
/**
|
|
15692
|
-
*
|
|
17433
|
+
* E.164 numbers to check, e.g. +13035550000.
|
|
15693
17434
|
*/
|
|
15694
|
-
|
|
17435
|
+
phoneNumbers: Array<(string)>;
|
|
17436
|
+
};
|
|
17437
|
+
};
|
|
17438
|
+
type CheckPhoneNumberPortabilityResponse = ({
|
|
17439
|
+
results?: Array<{
|
|
17440
|
+
phoneNumber?: string;
|
|
17441
|
+
portable?: boolean;
|
|
15695
17442
|
/**
|
|
15696
|
-
*
|
|
15697
|
-
*
|
|
17443
|
+
* Qualifies for the carrier's accelerated FastPort lane.
|
|
15698
17444
|
*/
|
|
15699
|
-
|
|
17445
|
+
fastPortable?: boolean;
|
|
15700
17446
|
/**
|
|
15701
|
-
*
|
|
15702
|
-
*
|
|
17447
|
+
* Carrier reason when not portable; null when portable.
|
|
15703
17448
|
*/
|
|
15704
|
-
|
|
17449
|
+
notPortableReason?: (string) | null;
|
|
17450
|
+
}>;
|
|
17451
|
+
});
|
|
17452
|
+
type CheckPhoneNumberPortabilityError = ({
|
|
17453
|
+
error?: string;
|
|
17454
|
+
});
|
|
17455
|
+
type UploadPhoneNumberPortInDocumentData = {
|
|
17456
|
+
body: {
|
|
15705
17457
|
/**
|
|
15706
|
-
*
|
|
15707
|
-
*
|
|
17458
|
+
* The document (PDF/JPEG/PNG, 10MB max).
|
|
15708
17459
|
*/
|
|
15709
|
-
|
|
17460
|
+
file: (Blob | File);
|
|
17461
|
+
/**
|
|
17462
|
+
* Informational; used for the stored filename.
|
|
17463
|
+
*/
|
|
17464
|
+
kind?: 'loa' | 'invoice';
|
|
15710
17465
|
};
|
|
15711
17466
|
};
|
|
15712
|
-
type
|
|
15713
|
-
|
|
15714
|
-
checkoutUrl?: string;
|
|
15715
|
-
} | {
|
|
15716
|
-
message?: string;
|
|
15717
|
-
phoneNumber?: {
|
|
15718
|
-
id?: string;
|
|
15719
|
-
phoneNumber?: string;
|
|
15720
|
-
status?: string;
|
|
15721
|
-
country?: string;
|
|
15722
|
-
provisionedAt?: string;
|
|
15723
|
-
metaPreverifiedId?: string;
|
|
15724
|
-
metaVerificationStatus?: string;
|
|
15725
|
-
};
|
|
15726
|
-
} | {
|
|
15727
|
-
status?: 'already_purchased';
|
|
15728
|
-
numberId?: string;
|
|
15729
|
-
phoneNumber?: string;
|
|
15730
|
-
}) | {
|
|
15731
|
-
status?: 'kyc_required';
|
|
15732
|
-
country?: string;
|
|
15733
|
-
kycUrl?: string;
|
|
17467
|
+
type UploadPhoneNumberPortInDocumentResponse = ({
|
|
17468
|
+
documentId?: string;
|
|
15734
17469
|
});
|
|
15735
|
-
type
|
|
15736
|
-
error?: string;
|
|
15737
|
-
} | {
|
|
17470
|
+
type UploadPhoneNumberPortInDocumentError = (unknown | {
|
|
15738
17471
|
error?: string;
|
|
15739
|
-
code?: 'PURCHASE_VELOCITY';
|
|
15740
17472
|
});
|
|
15741
|
-
type
|
|
15742
|
-
|
|
17473
|
+
type CancelPhoneNumberPortInData = {
|
|
17474
|
+
path: {
|
|
15743
17475
|
/**
|
|
15744
|
-
*
|
|
17476
|
+
* Porting order ID (from the port-in list).
|
|
15745
17477
|
*/
|
|
15746
|
-
|
|
15747
|
-
|
|
15748
|
-
|
|
15749
|
-
|
|
15750
|
-
|
|
15751
|
-
|
|
17478
|
+
id: string;
|
|
17479
|
+
};
|
|
17480
|
+
};
|
|
17481
|
+
type CancelPhoneNumberPortInResponse = ({
|
|
17482
|
+
id?: string;
|
|
17483
|
+
status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
|
|
15752
17484
|
});
|
|
15753
|
-
type
|
|
17485
|
+
type CancelPhoneNumberPortInError = ({
|
|
15754
17486
|
error?: string;
|
|
15755
|
-
});
|
|
15756
|
-
type
|
|
15757
|
-
|
|
17487
|
+
} | unknown);
|
|
17488
|
+
type ReviewPhoneNumberKycPacketData = {
|
|
17489
|
+
body: {
|
|
17490
|
+
country: string;
|
|
17491
|
+
numberType: string;
|
|
15758
17492
|
/**
|
|
15759
|
-
*
|
|
17493
|
+
* requirementId to declared textual value.
|
|
15760
17494
|
*/
|
|
15761
|
-
|
|
15762
|
-
|
|
15763
|
-
|
|
17495
|
+
values?: {
|
|
17496
|
+
[key: string]: (string);
|
|
17497
|
+
};
|
|
15764
17498
|
/**
|
|
15765
|
-
*
|
|
17499
|
+
* Declared address (street_address, locality, ...), so a mismatched proof-of-address can be flagged.
|
|
15766
17500
|
*/
|
|
15767
|
-
|
|
17501
|
+
address?: {
|
|
17502
|
+
[key: string]: (string);
|
|
17503
|
+
};
|
|
17504
|
+
docs: Array<{
|
|
17505
|
+
requirementId: string;
|
|
17506
|
+
/**
|
|
17507
|
+
* Id from POST /v1/phone-numbers/kyc/upload-document.
|
|
17508
|
+
*/
|
|
17509
|
+
documentId: string;
|
|
17510
|
+
}>;
|
|
17511
|
+
};
|
|
17512
|
+
};
|
|
17513
|
+
type ReviewPhoneNumberKycPacketResponse = ({
|
|
17514
|
+
advisories?: Array<{
|
|
17515
|
+
requirementId?: string;
|
|
15768
17516
|
/**
|
|
15769
|
-
*
|
|
17517
|
+
* One short plain-language concern about that requirement's document.
|
|
15770
17518
|
*/
|
|
15771
|
-
|
|
17519
|
+
concern?: string;
|
|
17520
|
+
}>;
|
|
17521
|
+
});
|
|
17522
|
+
type ReviewPhoneNumberKycPacketError = ({
|
|
17523
|
+
error?: string;
|
|
17524
|
+
});
|
|
17525
|
+
type GetPhoneNumberRemediationData = {
|
|
17526
|
+
path: {
|
|
15772
17527
|
/**
|
|
15773
|
-
*
|
|
17528
|
+
* Phone number record ID.
|
|
15774
17529
|
*/
|
|
15775
|
-
|
|
17530
|
+
id: string;
|
|
15776
17531
|
};
|
|
15777
17532
|
};
|
|
15778
|
-
type
|
|
17533
|
+
type GetPhoneNumberRemediationResponse = ({
|
|
15779
17534
|
country?: string;
|
|
15780
17535
|
numberType?: string;
|
|
15781
|
-
|
|
15782
|
-
|
|
17536
|
+
declineReason?: (string) | null;
|
|
17537
|
+
/**
|
|
17538
|
+
* Same field shape as GET /v1/phone-numbers/kyc.
|
|
17539
|
+
*/
|
|
17540
|
+
fields?: Array<{
|
|
17541
|
+
[key: string]: unknown;
|
|
15783
17542
|
}>;
|
|
15784
17543
|
});
|
|
15785
|
-
type
|
|
17544
|
+
type GetPhoneNumberRemediationError = (unknown | {
|
|
15786
17545
|
error?: string;
|
|
15787
17546
|
});
|
|
15788
|
-
type
|
|
15789
|
-
|
|
17547
|
+
type RemediatePhoneNumberData = {
|
|
17548
|
+
body: {
|
|
17549
|
+
values?: {
|
|
17550
|
+
[key: string]: (string);
|
|
17551
|
+
};
|
|
17552
|
+
documents?: Array<({
|
|
17553
|
+
requirementId: string;
|
|
17554
|
+
filename: string;
|
|
17555
|
+
base64: string;
|
|
17556
|
+
} | {
|
|
17557
|
+
requirementId: string;
|
|
17558
|
+
documentId: string;
|
|
17559
|
+
})>;
|
|
15790
17560
|
/**
|
|
15791
|
-
*
|
|
17561
|
+
* Same shape as the KYC submit address.
|
|
15792
17562
|
*/
|
|
15793
|
-
|
|
17563
|
+
address?: {
|
|
17564
|
+
[key: string]: unknown;
|
|
17565
|
+
};
|
|
17566
|
+
};
|
|
17567
|
+
path: {
|
|
17568
|
+
id: string;
|
|
15794
17569
|
};
|
|
15795
17570
|
};
|
|
15796
|
-
type
|
|
15797
|
-
|
|
15798
|
-
|
|
15799
|
-
|
|
15800
|
-
|
|
15801
|
-
|
|
15802
|
-
available?: boolean;
|
|
15803
|
-
addressConstraint?: 'geo' | 'country' | 'none';
|
|
15804
|
-
/**
|
|
15805
|
-
* For `geo` only — the area(s) the registered address must be in.
|
|
15806
|
-
*/
|
|
15807
|
-
areas?: Array<(string)>;
|
|
17571
|
+
type RemediatePhoneNumberResponse = ({
|
|
17572
|
+
status?: string;
|
|
17573
|
+
phoneNumber?: {
|
|
17574
|
+
id?: string;
|
|
17575
|
+
status?: string;
|
|
17576
|
+
};
|
|
15808
17577
|
});
|
|
15809
|
-
type
|
|
17578
|
+
type RemediatePhoneNumberError = (unknown | {
|
|
15810
17579
|
error?: string;
|
|
15811
17580
|
});
|
|
15812
17581
|
type GetWhatsAppNumberKycFormData = {
|
|
@@ -16116,6 +17885,285 @@ type RemediateWhatsAppNumberResponse = ({
|
|
|
16116
17885
|
type RemediateWhatsAppNumberError = (unknown | {
|
|
16117
17886
|
error?: string;
|
|
16118
17887
|
});
|
|
17888
|
+
type EnableVoiceOnNumberData = {
|
|
17889
|
+
body?: {
|
|
17890
|
+
/**
|
|
17891
|
+
* tel:+E164, sip:..., or wss://... destination for inbound calls. Empty string clears the forward (outbound-only); omitted preserves the current one.
|
|
17892
|
+
*/
|
|
17893
|
+
forwardTo?: string;
|
|
17894
|
+
recordingEnabled?: boolean;
|
|
17895
|
+
transcriptionEnabled?: boolean;
|
|
17896
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
17897
|
+
/**
|
|
17898
|
+
* Voicemail is taken when there's no live destination. Default on.
|
|
17899
|
+
*/
|
|
17900
|
+
voicemailEnabled?: boolean;
|
|
17901
|
+
/**
|
|
17902
|
+
* Custom spoken greeting; empty string restores the default.
|
|
17903
|
+
*/
|
|
17904
|
+
voicemailGreeting?: string;
|
|
17905
|
+
/**
|
|
17906
|
+
* Outside the windows, inbound skips the forward and goes to voicemail. Off = 24/7.
|
|
17907
|
+
*/
|
|
17908
|
+
businessHoursEnabled?: boolean;
|
|
17909
|
+
/**
|
|
17910
|
+
* IANA timezone the windows are evaluated in.
|
|
17911
|
+
*/
|
|
17912
|
+
businessHoursTimezone?: string;
|
|
17913
|
+
businessHours?: Array<{
|
|
17914
|
+
/**
|
|
17915
|
+
* 0 = Sunday.
|
|
17916
|
+
*/
|
|
17917
|
+
day: number;
|
|
17918
|
+
open: string;
|
|
17919
|
+
close: string;
|
|
17920
|
+
}>;
|
|
17921
|
+
/**
|
|
17922
|
+
* E.164 numbers rejected before answer. Replaces the whole list; bare 10-digit values are normalized as US numbers.
|
|
17923
|
+
*/
|
|
17924
|
+
blockedCallers?: Array<(string)>;
|
|
17925
|
+
/**
|
|
17926
|
+
* Caller ID on the forwarded leg: your number (`business`) or the original caller's (`caller`).
|
|
17927
|
+
*/
|
|
17928
|
+
forwardCallerId?: 'business' | 'caller';
|
|
17929
|
+
/**
|
|
17930
|
+
* IVR menu (supersedes the plain forward within business hours).
|
|
17931
|
+
*/
|
|
17932
|
+
ivrEnabled?: boolean;
|
|
17933
|
+
ivrPrompt?: string;
|
|
17934
|
+
ivrOptions?: Array<{
|
|
17935
|
+
digit: string;
|
|
17936
|
+
/**
|
|
17937
|
+
* tel:+E164, sip:..., or wss://... destination for this digit.
|
|
17938
|
+
*/
|
|
17939
|
+
forwardTo: string;
|
|
17940
|
+
label?: string;
|
|
17941
|
+
}>;
|
|
17942
|
+
};
|
|
17943
|
+
path: {
|
|
17944
|
+
/**
|
|
17945
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
17946
|
+
*/
|
|
17947
|
+
id: string;
|
|
17948
|
+
};
|
|
17949
|
+
};
|
|
17950
|
+
type EnableVoiceOnNumberResponse = ({
|
|
17951
|
+
enabled?: boolean;
|
|
17952
|
+
phoneNumber?: string;
|
|
17953
|
+
pstnForwardTo?: (string) | null;
|
|
17954
|
+
recordingEnabled?: boolean;
|
|
17955
|
+
transcriptionEnabled?: boolean;
|
|
17956
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
17957
|
+
voicemailEnabled?: boolean;
|
|
17958
|
+
voicemailGreeting?: (string) | null;
|
|
17959
|
+
businessHoursEnabled?: boolean;
|
|
17960
|
+
businessHoursTimezone?: (string) | null;
|
|
17961
|
+
businessHours?: Array<{
|
|
17962
|
+
day?: number;
|
|
17963
|
+
open?: string;
|
|
17964
|
+
close?: string;
|
|
17965
|
+
}>;
|
|
17966
|
+
blockedCallers?: Array<(string)>;
|
|
17967
|
+
forwardCallerId?: 'business' | 'caller';
|
|
17968
|
+
ivrEnabled?: boolean;
|
|
17969
|
+
ivrPrompt?: (string) | null;
|
|
17970
|
+
ivrOptions?: Array<{
|
|
17971
|
+
digit?: string;
|
|
17972
|
+
forwardTo?: string;
|
|
17973
|
+
label?: string;
|
|
17974
|
+
}>;
|
|
17975
|
+
});
|
|
17976
|
+
type EnableVoiceOnNumberError = ({
|
|
17977
|
+
error?: string;
|
|
17978
|
+
} | unknown);
|
|
17979
|
+
type DisableVoiceOnNumberData = {
|
|
17980
|
+
path: {
|
|
17981
|
+
id: string;
|
|
17982
|
+
};
|
|
17983
|
+
};
|
|
17984
|
+
type DisableVoiceOnNumberResponse = ({
|
|
17985
|
+
enabled?: boolean;
|
|
17986
|
+
phoneNumber?: string;
|
|
17987
|
+
});
|
|
17988
|
+
type DisableVoiceOnNumberError = ({
|
|
17989
|
+
error?: string;
|
|
17990
|
+
} | unknown);
|
|
17991
|
+
type EnableSmsOnNumberData = {
|
|
17992
|
+
path: {
|
|
17993
|
+
/**
|
|
17994
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
17995
|
+
*/
|
|
17996
|
+
id: string;
|
|
17997
|
+
};
|
|
17998
|
+
};
|
|
17999
|
+
type EnableSmsOnNumberResponse = ({
|
|
18000
|
+
enabled?: boolean;
|
|
18001
|
+
/**
|
|
18002
|
+
* The SMS social account ID (present when enabled).
|
|
18003
|
+
*/
|
|
18004
|
+
id?: string;
|
|
18005
|
+
phoneNumber?: string;
|
|
18006
|
+
/**
|
|
18007
|
+
* False for US numbers until their registration is approved.
|
|
18008
|
+
*/
|
|
18009
|
+
isActive?: boolean;
|
|
18010
|
+
country?: string;
|
|
18011
|
+
/**
|
|
18012
|
+
* Null when capability can't be read yet (still provisioning).
|
|
18013
|
+
*/
|
|
18014
|
+
smsCapable?: (boolean) | null;
|
|
18015
|
+
mmsCapable?: boolean;
|
|
18016
|
+
domesticOnly?: boolean;
|
|
18017
|
+
/**
|
|
18018
|
+
* Number is still provisioning at the carrier; retry shortly.
|
|
18019
|
+
*/
|
|
18020
|
+
notReady?: boolean;
|
|
18021
|
+
/**
|
|
18022
|
+
* US only; a carrier registration is required before delivery.
|
|
18023
|
+
*/
|
|
18024
|
+
needsRegistration?: boolean;
|
|
18025
|
+
/**
|
|
18026
|
+
* A prior non-rejected registration already covers this number; no re-submit needed.
|
|
18027
|
+
*/
|
|
18028
|
+
alreadyRegistered?: boolean;
|
|
18029
|
+
registrationStatus?: ('pending' | 'approved' | 'rejected') | null;
|
|
18030
|
+
/**
|
|
18031
|
+
* Present when an existing approved registration can cover this number via /sms/reuse-registration.
|
|
18032
|
+
*/
|
|
18033
|
+
reusable?: {
|
|
18034
|
+
registrationId?: string;
|
|
18035
|
+
status?: string;
|
|
18036
|
+
} | null;
|
|
18037
|
+
/**
|
|
18038
|
+
* Human-readable explanation when `enabled` is false.
|
|
18039
|
+
*/
|
|
18040
|
+
message?: string;
|
|
18041
|
+
});
|
|
18042
|
+
type EnableSmsOnNumberError = ({
|
|
18043
|
+
error?: string;
|
|
18044
|
+
} | unknown);
|
|
18045
|
+
type DisableSmsOnNumberData = {
|
|
18046
|
+
path: {
|
|
18047
|
+
id: string;
|
|
18048
|
+
};
|
|
18049
|
+
};
|
|
18050
|
+
type DisableSmsOnNumberResponse = ({
|
|
18051
|
+
enabled?: boolean;
|
|
18052
|
+
phoneNumber?: string;
|
|
18053
|
+
/**
|
|
18054
|
+
* False when SMS was already off. Legacy field; prefer `enabled`.
|
|
18055
|
+
*/
|
|
18056
|
+
disabled?: boolean;
|
|
18057
|
+
});
|
|
18058
|
+
type DisableSmsOnNumberError = ({
|
|
18059
|
+
error?: string;
|
|
18060
|
+
} | unknown);
|
|
18061
|
+
type ReuseSmsRegistrationForNumberData = {
|
|
18062
|
+
path: {
|
|
18063
|
+
id: string;
|
|
18064
|
+
};
|
|
18065
|
+
};
|
|
18066
|
+
type ReuseSmsRegistrationForNumberResponse = ({
|
|
18067
|
+
registrationId?: string;
|
|
18068
|
+
status?: 'pending' | 'approved' | 'rejected';
|
|
18069
|
+
});
|
|
18070
|
+
type ReuseSmsRegistrationForNumberError = ({
|
|
18071
|
+
error?: string;
|
|
18072
|
+
} | unknown);
|
|
18073
|
+
type GetWhatsAppCallingData = {
|
|
18074
|
+
path: {
|
|
18075
|
+
/**
|
|
18076
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
18077
|
+
*/
|
|
18078
|
+
id: string;
|
|
18079
|
+
};
|
|
18080
|
+
};
|
|
18081
|
+
type GetWhatsAppCallingResponse = ({
|
|
18082
|
+
phoneNumber?: string;
|
|
18083
|
+
callingEnabled?: boolean;
|
|
18084
|
+
/**
|
|
18085
|
+
* Public calling deep link (https://wa.me/call/<number>). Null while calling is disabled.
|
|
18086
|
+
*/
|
|
18087
|
+
callDeepLink?: (string) | null;
|
|
18088
|
+
/**
|
|
18089
|
+
* tel:+E164 / sip:... / wss://... destination
|
|
18090
|
+
*/
|
|
18091
|
+
forwardTo?: (string) | null;
|
|
18092
|
+
recordingEnabled?: boolean;
|
|
18093
|
+
sipAuthUsername?: (string) | null;
|
|
18094
|
+
/**
|
|
18095
|
+
* True when a SIP digest password is stored. The plaintext is never returned.
|
|
18096
|
+
*/
|
|
18097
|
+
sipAuthPasswordConfigured?: boolean;
|
|
18098
|
+
callIconCountries?: Array<(string)> | null;
|
|
18099
|
+
/**
|
|
18100
|
+
* True when the number's country blocks business-initiated (outbound) WhatsApp calling; inbound still works.
|
|
18101
|
+
*/
|
|
18102
|
+
outboundDisabled?: boolean;
|
|
18103
|
+
});
|
|
18104
|
+
type GetWhatsAppCallingError = ({
|
|
18105
|
+
error?: string;
|
|
18106
|
+
} | unknown);
|
|
18107
|
+
type EnableWhatsAppCallingData = {
|
|
18108
|
+
body: {
|
|
18109
|
+
accountId: string;
|
|
18110
|
+
/**
|
|
18111
|
+
* tel:+E164 / sip:... / wss://... destination
|
|
18112
|
+
*/
|
|
18113
|
+
forwardTo: string;
|
|
18114
|
+
sipAuthUsername?: string;
|
|
18115
|
+
/**
|
|
18116
|
+
* Stored encrypted, never returned by any endpoint.
|
|
18117
|
+
*/
|
|
18118
|
+
sipAuthPassword?: string;
|
|
18119
|
+
recordingEnabled?: boolean;
|
|
18120
|
+
callIconCountries?: Array<(string)>;
|
|
18121
|
+
};
|
|
18122
|
+
path: {
|
|
18123
|
+
/**
|
|
18124
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
18125
|
+
*/
|
|
18126
|
+
id: string;
|
|
18127
|
+
};
|
|
18128
|
+
};
|
|
18129
|
+
type EnableWhatsAppCallingResponse = ({
|
|
18130
|
+
success?: boolean;
|
|
18131
|
+
callingEnabled?: boolean;
|
|
18132
|
+
sipHostname?: string;
|
|
18133
|
+
forwardTo?: string;
|
|
18134
|
+
});
|
|
18135
|
+
type EnableWhatsAppCallingError = ({
|
|
18136
|
+
error?: string;
|
|
18137
|
+
} | unknown);
|
|
18138
|
+
type UpdateWhatsAppCallingData = {
|
|
18139
|
+
body: {
|
|
18140
|
+
accountId: string;
|
|
18141
|
+
forwardTo?: string;
|
|
18142
|
+
sipAuthUsername?: (string) | null;
|
|
18143
|
+
sipAuthPassword?: (string) | null;
|
|
18144
|
+
recordingEnabled?: boolean;
|
|
18145
|
+
callIconCountries?: Array<(string)> | null;
|
|
18146
|
+
};
|
|
18147
|
+
path: {
|
|
18148
|
+
id: string;
|
|
18149
|
+
};
|
|
18150
|
+
};
|
|
18151
|
+
type UpdateWhatsAppCallingResponse = (unknown);
|
|
18152
|
+
type UpdateWhatsAppCallingError = ({
|
|
18153
|
+
error?: string;
|
|
18154
|
+
} | unknown);
|
|
18155
|
+
type DisableWhatsAppCallingData = {
|
|
18156
|
+
path: {
|
|
18157
|
+
id: string;
|
|
18158
|
+
};
|
|
18159
|
+
query: {
|
|
18160
|
+
accountId: string;
|
|
18161
|
+
};
|
|
18162
|
+
};
|
|
18163
|
+
type DisableWhatsAppCallingResponse = (unknown);
|
|
18164
|
+
type DisableWhatsAppCallingError = ({
|
|
18165
|
+
error?: string;
|
|
18166
|
+
} | unknown);
|
|
16119
18167
|
type GetWhatsAppPhoneNumberData = {
|
|
16120
18168
|
path: {
|
|
16121
18169
|
/**
|
|
@@ -22019,4 +24067,4 @@ type GetTrackingTagStatsError = (unknown | {
|
|
|
22019
24067
|
error?: string;
|
|
22020
24068
|
});
|
|
22021
24069
|
|
|
22022
|
-
export { type AccountWithFollowerStats, type AccountsListResponse, type ActivateSequenceData, type ActivateSequenceError, type ActivateSequenceResponse, type ActivateWorkflowData, type ActivateWorkflowError, type ActivateWorkflowResponse, type Ad, type AdBudget, type AdCampaign, type AdDailyMetrics, type AdMetrics, type AdStatus, type AdTreeAdSet, type AdTreeCampaign, type AddBroadcastRecipientsData, type AddBroadcastRecipientsError, type AddBroadcastRecipientsResponse, type AddConversionAssociationsData, type AddConversionAssociationsError, type AddConversionAssociationsResponse, type AddDiscordMemberRoleData, type AddDiscordMemberRoleError, type AddDiscordMemberRoleResponse, type AddMessageReactionData, type AddMessageReactionError, type AddMessageReactionResponse, type AddTrackingTagSharedAccountData, type AddTrackingTagSharedAccountError, type AddTrackingTagSharedAccountResponse, type AddUsersToAdAudienceData, type AddUsersToAdAudienceError, type AddUsersToAdAudienceResponse, type AddWhatsAppGroupParticipantsData, type AddWhatsAppGroupParticipantsError, type AddWhatsAppGroupParticipantsResponse, type AdjustConversionsData, type AdjustConversionsError, type AdjustConversionsResponse, type AnalyticsListResponse, type AnalyticsOverview, type AnalyticsSinglePostResponse, type ApiKey, type ApproveWhatsAppGroupJoinRequestsData, type ApproveWhatsAppGroupJoinRequestsError, type ApproveWhatsAppGroupJoinRequestsResponse, type ArchiveLeadFormData, type ArchiveLeadFormError, type ArchiveLeadFormResponse, type BatchGetGoogleBusinessReviewsData, type BatchGetGoogleBusinessReviewsError, type BatchGetGoogleBusinessReviewsResponse, type BidStrategy, type BlockWhatsAppUsersData, type BlockWhatsAppUsersError, type BlockWhatsAppUsersResponse, type BlueskyPlatformData, type BookmarkPostData, type BookmarkPostError, type BookmarkPostResponse, type BoostPostData, type BoostPostError, type BoostPostResponse, type BulkCreateContactsData, type BulkCreateContactsError, type BulkCreateContactsResponse, type BulkUpdateAdCampaignStatusData, type BulkUpdateAdCampaignStatusError, type BulkUpdateAdCampaignStatusResponse, type BulkUploadPostsData, type BulkUploadPostsError, type BulkUploadPostsResponse, type BulkUploadResult, type BusinessCenter, type CancelBroadcastData, type CancelBroadcastError, type CancelBroadcastResponse, type CheckWhatsAppNumberAvailabilityData, type CheckWhatsAppNumberAvailabilityError, type CheckWhatsAppNumberAvailabilityResponse, type ClearContactFieldValueData, type ClearContactFieldValueError, type ClearContactFieldValueResponse, type ClientOptions, type CompleteGoogleBusinessVerificationData, type CompleteGoogleBusinessVerificationError, type CompleteGoogleBusinessVerificationResponse, type CompleteTelegramConnectData, type CompleteTelegramConnectError, type CompleteTelegramConnectResponse, type CompleteWhatsAppPhoneSelectionData, type CompleteWhatsAppPhoneSelectionError, type CompleteWhatsAppPhoneSelectionResponse, type ConfigureTikTokAdsBrandIdentityData, type ConfigureTikTokAdsBrandIdentityError, type ConfigureTikTokAdsBrandIdentityResponse, type ConnectAdsData, type ConnectAdsError, type ConnectAdsResponse, type ConnectBlueskyCredentialsData, type ConnectBlueskyCredentialsError, type ConnectBlueskyCredentialsResponse, type ConnectWhatsAppCredentialsData, type ConnectWhatsAppCredentialsError, type ConnectWhatsAppCredentialsResponse, type ConversionDestination, type ConversionEvent, type CreateAccountGroupData, type CreateAccountGroupError, type CreateAccountGroupResponse, type CreateAdAudienceData, type CreateAdAudienceError, type CreateAdAudienceResponse, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyResponse, type CreateBroadcastData, type CreateBroadcastError, type CreateBroadcastResponse, type CreateCommentAutomationData, type CreateCommentAutomationError, type CreateCommentAutomationResponse, type CreateContactData, type CreateContactError, type CreateContactResponse, type CreateConversionDestinationData, type CreateConversionDestinationError, type CreateConversionDestinationResponse, type CreateCtwaAdData, type CreateCtwaAdError, type CreateCtwaAdResponse, type CreateCustomFieldData, type CreateCustomFieldError, type CreateCustomFieldResponse, type CreateDiscordScheduledEventData, type CreateDiscordScheduledEventError, type CreateDiscordScheduledEventResponse, type CreateGoogleBusinessMediaData, type CreateGoogleBusinessMediaError, type CreateGoogleBusinessMediaResponse, type CreateGoogleBusinessPlaceActionData, type CreateGoogleBusinessPlaceActionError, type CreateGoogleBusinessPlaceActionResponse, type CreateInboxConversationData, type CreateInboxConversationError, type CreateInboxConversationResponse, type CreateInviteTokenData, type CreateInviteTokenError, type CreateInviteTokenResponse, type CreateLeadFormData, type CreateLeadFormError, type CreateLeadFormResponse, type CreatePostData, type CreatePostError, type CreatePostResponse, type CreateProfileData, type CreateProfileError, type CreateProfileResponse, type CreateQueueSlotData, type CreateQueueSlotError, type CreateQueueSlotResponse, type CreateSequenceData, type CreateSequenceError, type CreateSequenceResponse, type CreateStandaloneAdData, type CreateStandaloneAdError, type CreateStandaloneAdResponse, type CreateTestLeadData, type CreateTestLeadError, type CreateTestLeadResponse, type CreateTrackingTagData, type CreateTrackingTagError, type CreateTrackingTagResponse, type CreateWebhookSettingsData, type CreateWebhookSettingsError, type CreateWebhookSettingsResponse, type CreateWhatsAppDatasetData, type CreateWhatsAppDatasetError, type CreateWhatsAppDatasetResponse, type CreateWhatsAppFlowData, type CreateWhatsAppFlowError, type CreateWhatsAppFlowResponse, type CreateWhatsAppGroupChatData, type CreateWhatsAppGroupChatError, type CreateWhatsAppGroupChatResponse, type CreateWhatsAppGroupInviteLinkData, type CreateWhatsAppGroupInviteLinkError, type CreateWhatsAppGroupInviteLinkResponse, type CreateWhatsAppNumberKycLinkData, type CreateWhatsAppNumberKycLinkError, type CreateWhatsAppNumberKycLinkResponse, type CreateWhatsAppSandboxSessionData, type CreateWhatsAppSandboxSessionError, type CreateWhatsAppSandboxSessionResponse, type CreateWhatsAppTemplateData, type CreateWhatsAppTemplateError, type CreateWhatsAppTemplateResponse, type CreateWorkflowData, type CreateWorkflowError, type CreateWorkflowResponse, type CtwaMultiResponse, type CtwaSingleResponse, type DeleteAccountData, type DeleteAccountError, type DeleteAccountGroupData, type DeleteAccountGroupError, type DeleteAccountGroupResponse, type DeleteAccountResponse, type DeleteAdAudienceData, type DeleteAdAudienceError, type DeleteAdAudienceResponse, type DeleteAdCampaignData, type DeleteAdCampaignError, type DeleteAdCampaignResponse, type DeleteAdData, type DeleteAdError, type DeleteAdResponse, type DeleteApiKeyData, type DeleteApiKeyError, type DeleteApiKeyResponse, type DeleteBroadcastData, type DeleteBroadcastError, type DeleteBroadcastResponse, type DeleteCommentAutomationData, type DeleteCommentAutomationError, type DeleteCommentAutomationResponse, type DeleteContactData, type DeleteContactError, type DeleteContactResponse, type DeleteConversionDestinationData, type DeleteConversionDestinationError, type DeleteConversionDestinationResponse, type DeleteCustomFieldData, type DeleteCustomFieldError, type DeleteCustomFieldResponse, type DeleteDiscordScheduledEventData, type DeleteDiscordScheduledEventError, type DeleteDiscordScheduledEventResponse, type DeleteGoogleBusinessMediaData, type DeleteGoogleBusinessMediaError, type DeleteGoogleBusinessMediaResponse, type DeleteGoogleBusinessPlaceActionData, type DeleteGoogleBusinessPlaceActionError, type DeleteGoogleBusinessPlaceActionResponse, type DeleteGoogleBusinessReviewReplyData, type DeleteGoogleBusinessReviewReplyError, type DeleteGoogleBusinessReviewReplyResponse, type DeleteInboxCommentData, type DeleteInboxCommentError, type DeleteInboxCommentResponse, type DeleteInboxMessageData, type DeleteInboxMessageError, type DeleteInboxMessageResponse, type DeleteInboxReviewReplyData, type DeleteInboxReviewReplyError, type DeleteInboxReviewReplyResponse, type DeleteInstagramIceBreakersData, type DeleteInstagramIceBreakersError, type DeleteInstagramIceBreakersResponse, type DeleteMessengerMenuData, type DeleteMessengerMenuError, type DeleteMessengerMenuResponse, type DeletePostData, type DeletePostError, type DeletePostResponse, type DeleteProfileData, type DeleteProfileError, type DeleteProfileResponse, type DeleteQueueSlotData, type DeleteQueueSlotError, type DeleteQueueSlotResponse, type DeleteSequenceData, type DeleteSequenceError, type DeleteSequenceResponse, type DeleteTelegramCommandsData, type DeleteTelegramCommandsError, type DeleteTelegramCommandsResponse, type DeleteWebhookSettingsData, type DeleteWebhookSettingsError, type DeleteWebhookSettingsResponse, type DeleteWhatsAppFlowData, type DeleteWhatsAppFlowError, type DeleteWhatsAppFlowResponse, type DeleteWhatsAppGroupChatData, type DeleteWhatsAppGroupChatError, type DeleteWhatsAppGroupChatResponse, type DeleteWhatsAppSandboxSessionData, type DeleteWhatsAppSandboxSessionError, type DeleteWhatsAppSandboxSessionResponse, type DeleteWhatsAppTemplateData, type DeleteWhatsAppTemplateError, type DeleteWhatsAppTemplateResponse, type DeleteWhatsappBusinessUsernameData, type DeleteWhatsappBusinessUsernameError, type DeleteWhatsappBusinessUsernameResponse, type DeleteWorkflowData, type DeleteWorkflowError, type DeleteWorkflowResponse, type DeprecateWhatsAppFlowData, type DeprecateWhatsAppFlowError, type DeprecateWhatsAppFlowResponse, type DisableWhatsAppCallingData, type DisableWhatsAppCallingError, type DisableWhatsAppCallingResponse, type DiscordPlatformData, type DiscordScheduledEvent, type DmButton, type DuplicateAdCampaignData, type DuplicateAdCampaignError, type DuplicateAdCampaignResponse, type DuplicateWorkflowData, type DuplicateWorkflowError, type DuplicateWorkflowResponse, type EditInboxMessageData, type EditInboxMessageError, type EditInboxMessageResponse, type EditPostData, type EditPostError, type EditPostResponse, type EnableWhatsAppCallingData, type EnableWhatsAppCallingError, type EnableWhatsAppCallingResponse, type EnrollContactsData, type EnrollContactsError, type EnrollContactsResponse, type ErrorResponse, type EstimateAdReachData, type EstimateAdReachError, type EstimateAdReachResponse, type ExternalPostMediaItem, type ExternalPostSummary, type ExternalPostWebhookPost, type FacebookPlatformData, type FetchGoogleBusinessVerificationOptionsData, type FetchGoogleBusinessVerificationOptionsError, type FetchGoogleBusinessVerificationOptionsResponse, type FollowUserData, type FollowUserError, type FollowUserResponse, type FollowerStatsResponse, type FoodMenu, type FoodMenuItem, type FoodMenuItemAttributes, type FoodMenuLabel, type FoodMenuSection, type GeoRestriction, type GetAccountHealthData, type GetAccountHealthError, type GetAccountHealthResponse, type GetAdAnalyticsData, type GetAdAnalyticsError, type GetAdAnalyticsResponse, type GetAdAudienceData, type GetAdAudienceError, type GetAdAudienceResponse, type GetAdCommentsData, type GetAdCommentsError, type GetAdCommentsResponse, type GetAdData, type GetAdError, type GetAdResponse, type GetAdTrackingTagsData, type GetAdTrackingTagsError, type GetAdTrackingTagsResponse, type GetAdTreeData, type GetAdTreeError, type GetAdTreeResponse, type GetAdsTimelineData, type GetAdsTimelineError, type GetAdsTimelineResponse, type GetAllAccountsHealthData, type GetAllAccountsHealthError, type GetAllAccountsHealthResponse, type GetAnalyticsData, type GetAnalyticsError, type GetAnalyticsResponse, type GetBestTimeToPostData, type GetBestTimeToPostError, type GetBestTimeToPostResponse, type GetBroadcastData, type GetBroadcastError, type GetBroadcastResponse, type GetCampaignAnalyticsData, type GetCampaignAnalyticsError, type GetCampaignAnalyticsResponse, type GetCommentAutomationData, type GetCommentAutomationError, type GetCommentAutomationResponse, type GetConnectUrlData, type GetConnectUrlError, type GetConnectUrlResponse, type GetContactChannelsData, type GetContactChannelsError, type GetContactChannelsResponse, type GetContactData, type GetContactError, type GetContactResponse, type GetContentDecayData, type GetContentDecayError, type GetContentDecayResponse, type GetConversionDestinationData, type GetConversionDestinationError, type GetConversionDestinationResponse, type GetConversionMetricsData, type GetConversionMetricsError, type GetConversionMetricsResponse, type GetConversionsQualityData, type GetConversionsQualityError, type GetConversionsQualityResponse, type GetDailyMetricsData, type GetDailyMetricsError, type GetDailyMetricsResponse, type GetDiscordChannelsData, type GetDiscordChannelsError, type GetDiscordChannelsResponse, type GetDiscordScheduledEventData, type GetDiscordScheduledEventError, type GetDiscordScheduledEventResponse, type GetDiscordSettingsData, type GetDiscordSettingsError, type GetDiscordSettingsResponse, type GetFacebookPageInsightsData, type GetFacebookPageInsightsError, type GetFacebookPageInsightsResponse, type GetFacebookPagesData, type GetFacebookPagesError, type GetFacebookPagesResponse, type GetFollowerStatsData, type GetFollowerStatsError, type GetFollowerStatsResponse, type GetGmbAttributeMetadataData, type GetGmbAttributeMetadataError, type GetGmbAttributeMetadataResponse, type GetGmbLocationsData, type GetGmbLocationsError, type GetGmbLocationsResponse, type GetGoogleBusinessAttributesData, type GetGoogleBusinessAttributesError, type GetGoogleBusinessAttributesResponse, type GetGoogleBusinessFoodMenusData, type GetGoogleBusinessFoodMenusError, type GetGoogleBusinessFoodMenusResponse, type GetGoogleBusinessLocationDetailsData, type GetGoogleBusinessLocationDetailsError, type GetGoogleBusinessLocationDetailsResponse, type GetGoogleBusinessPerformanceData, type GetGoogleBusinessPerformanceError, type GetGoogleBusinessPerformanceResponse, type GetGoogleBusinessReviewsData, type GetGoogleBusinessReviewsError, type GetGoogleBusinessReviewsResponse, type GetGoogleBusinessSearchKeywordsData, type GetGoogleBusinessSearchKeywordsError, type GetGoogleBusinessSearchKeywordsResponse, type GetGoogleBusinessServicesData, type GetGoogleBusinessServicesError, type GetGoogleBusinessServicesResponse, type GetGoogleBusinessVerificationsData, type GetGoogleBusinessVerificationsError, type GetGoogleBusinessVerificationsResponse, type GetInboxConversationAnalyticsData, type GetInboxConversationAnalyticsError, type GetInboxConversationAnalyticsResponse, type GetInboxConversationData, type GetInboxConversationError, type GetInboxConversationMessagesData, type GetInboxConversationMessagesError, type GetInboxConversationMessagesResponse, type GetInboxConversationResponse, type GetInboxHeatmapData, type GetInboxHeatmapError, type GetInboxHeatmapResponse, type GetInboxPostCommentsData, type GetInboxPostCommentsError, type GetInboxPostCommentsResponse, type GetInboxResponseTimeData, type GetInboxResponseTimeError, type GetInboxResponseTimeResponse, type GetInboxSourceBreakdownData, type GetInboxSourceBreakdownError, type GetInboxSourceBreakdownResponse, type GetInboxTopAccountsData, type GetInboxTopAccountsError, type GetInboxTopAccountsResponse, type GetInboxVolumeData, type GetInboxVolumeError, type GetInboxVolumeResponse, type GetInstagramAccountInsightsData, type GetInstagramAccountInsightsError, type GetInstagramAccountInsightsResponse, type GetInstagramDemographicsData, type GetInstagramDemographicsError, type GetInstagramDemographicsResponse, type GetInstagramFollowerHistoryData, type GetInstagramFollowerHistoryError, type GetInstagramFollowerHistoryResponse, type GetInstagramIceBreakersData, type GetInstagramIceBreakersError, type GetInstagramIceBreakersResponse, type GetInstagramStoryInsightsData, type GetInstagramStoryInsightsError, type GetInstagramStoryInsightsResponse, type GetLeadFormData, type GetLeadFormError, type GetLeadFormResponse, type GetLinkedInAggregateAnalyticsData, type GetLinkedInAggregateAnalyticsError, type GetLinkedInAggregateAnalyticsResponse, type GetLinkedInMentionsData, type GetLinkedInMentionsError, type GetLinkedInMentionsResponse, type GetLinkedInOrgAggregateAnalyticsData, type GetLinkedInOrgAggregateAnalyticsError, type GetLinkedInOrgAggregateAnalyticsResponse, type GetLinkedInOrganizationsData, type GetLinkedInOrganizationsError, type GetLinkedInOrganizationsResponse, type GetLinkedInPostAnalyticsData, type GetLinkedInPostAnalyticsError, type GetLinkedInPostAnalyticsResponse, type GetLinkedInPostReactionsData, type GetLinkedInPostReactionsError, type GetLinkedInPostReactionsResponse, type GetMediaPresignedUrlData, type GetMediaPresignedUrlError, type GetMediaPresignedUrlResponse, type GetMessengerMenuData, type GetMessengerMenuError, type GetMessengerMenuResponse, type GetNextQueueSlotData, type GetNextQueueSlotError, type GetNextQueueSlotResponse, type GetPendingOAuthDataData, type GetPendingOAuthDataError, type GetPendingOAuthDataResponse, type GetPinterestBoardsData, type GetPinterestBoardsError, type GetPinterestBoardsResponse, type GetPostData, type GetPostError, type GetPostResponse, type GetPostTimelineData, type GetPostTimelineError, type GetPostTimelineResponse, type GetPostingFrequencyData, type GetPostingFrequencyError, type GetPostingFrequencyResponse, type GetProfileData, type GetProfileError, type GetProfileResponse, type GetRedditFeedData, type GetRedditFeedError, type GetRedditFeedResponse, type GetRedditFlairsData, type GetRedditFlairsError, type GetRedditFlairsResponse, type GetRedditSubredditsData, type GetRedditSubredditsError, type GetRedditSubredditsResponse, type GetSequenceData, type GetSequenceError, type GetSequenceResponse, type GetTelegramCommandsData, type GetTelegramCommandsError, type GetTelegramCommandsResponse, type GetTelegramConnectStatusData, type GetTelegramConnectStatusError, type GetTelegramConnectStatusResponse, type GetTikTokAccountInsightsData, type GetTikTokAccountInsightsError, type GetTikTokAccountInsightsResponse, type GetTikTokCreatorInfoData, type GetTikTokCreatorInfoError, type GetTikTokCreatorInfoResponse, type GetTrackingTagData, type GetTrackingTagError, type GetTrackingTagResponse, type GetTrackingTagStatsData, type GetTrackingTagStatsError, type GetTrackingTagStatsResponse, type GetUsageStatsData, type GetUsageStatsError, type GetUsageStatsResponse, type GetUserData, type GetUserError, type GetUserResponse, type GetWebhookLogsData, type GetWebhookLogsError, type GetWebhookLogsResponse, type GetWebhookSettingsError, type GetWebhookSettingsResponse, type GetWhatsAppBlockStatusData, type GetWhatsAppBlockStatusError, type GetWhatsAppBlockStatusResponse, type GetWhatsAppBlockedUsersData, type GetWhatsAppBlockedUsersError, type GetWhatsAppBlockedUsersResponse, type GetWhatsAppBusinessProfileData, type GetWhatsAppBusinessProfileError, type GetWhatsAppBusinessProfileResponse, type GetWhatsAppCallData, type GetWhatsAppCallError, type GetWhatsAppCallEstimateData, type GetWhatsAppCallEstimateError, type GetWhatsAppCallEstimateResponse, type GetWhatsAppCallPermissionsData, type GetWhatsAppCallPermissionsError, type GetWhatsAppCallPermissionsResponse, type GetWhatsAppCallResponse, type GetWhatsAppCallingConfigData, type GetWhatsAppCallingConfigError, type GetWhatsAppCallingConfigResponse, type GetWhatsAppDatasetData, type GetWhatsAppDatasetError, type GetWhatsAppDatasetResponse, type GetWhatsAppDisplayNameData, type GetWhatsAppDisplayNameError, type GetWhatsAppDisplayNameResponse, type GetWhatsAppFlowData, type GetWhatsAppFlowError, type GetWhatsAppFlowJsonData, type GetWhatsAppFlowJsonError, type GetWhatsAppFlowJsonResponse, type GetWhatsAppFlowPreviewData, type GetWhatsAppFlowPreviewError, type GetWhatsAppFlowPreviewResponse, type GetWhatsAppFlowResponse, type GetWhatsAppGroupChatData, type GetWhatsAppGroupChatError, type GetWhatsAppGroupChatResponse, type GetWhatsAppLibraryTemplateData, type GetWhatsAppLibraryTemplateError, type GetWhatsAppLibraryTemplateResponse, type GetWhatsAppNumberInfoData, type GetWhatsAppNumberInfoError, type GetWhatsAppNumberInfoResponse, type GetWhatsAppNumberKycFormData, type GetWhatsAppNumberKycFormError, type GetWhatsAppNumberKycFormResponse, type GetWhatsAppNumberRemediationData, type GetWhatsAppNumberRemediationError, type GetWhatsAppNumberRemediationResponse, type GetWhatsAppPhoneNumberData, type GetWhatsAppPhoneNumberError, type GetWhatsAppPhoneNumberResponse, type GetWhatsAppPhoneNumbersData, type GetWhatsAppPhoneNumbersError, type GetWhatsAppPhoneNumbersResponse, type GetWhatsAppTemplateData, type GetWhatsAppTemplateError, type GetWhatsAppTemplateResponse, type GetWhatsAppTemplatesData, type GetWhatsAppTemplatesError, type GetWhatsAppTemplatesResponse, type GetWhatsappBusinessUsernameData, type GetWhatsappBusinessUsernameError, type GetWhatsappBusinessUsernameResponse, type GetWhatsappBusinessUsernameSuggestionsData, type GetWhatsappBusinessUsernameSuggestionsError, type GetWhatsappBusinessUsernameSuggestionsResponse, type GetWorkflowData, type GetWorkflowError, type GetWorkflowResponse, type GetWorkflowVersionData, type GetWorkflowVersionError, type GetWorkflowVersionResponse, type GetXApiPricingError, type GetXApiPricingResponse, type GetYouTubeChannelInsightsData, type GetYouTubeChannelInsightsError, type GetYouTubeChannelInsightsResponse, type GetYouTubeDailyViewsData, type GetYouTubeDailyViewsError, type GetYouTubeDailyViewsResponse, type GetYouTubeDemographicsData, type GetYouTubeDemographicsError, type GetYouTubeDemographicsResponse, type GetYouTubeVideoRetentionData, type GetYouTubeVideoRetentionError, type GetYouTubeVideoRetentionResponse, type GetYoutubePlaylistsData, type GetYoutubePlaylistsError, type GetYoutubePlaylistsResponse, type GoogleBusinessPlatformData, type HandleOAuthCallbackData, type HandleOAuthCallbackError, type HandleOAuthCallbackResponse, type HideInboxCommentData, type HideInboxCommentError, type HideInboxCommentResponse, type InboxWebhookAccount, type InboxWebhookConversation, type InboxWebhookMessage, type InitiateTelegramConnectData, type InitiateTelegramConnectError, type InitiateTelegramConnectResponse, type InitiateWhatsAppCallData, type InitiateWhatsAppCallError, type InitiateWhatsAppCallResponse, type InstagramAccountInsightsResponse, type InstagramDemographicsResponse, type InstagramPlatformData, Late, LateApiError, type LikeInboxCommentData, type LikeInboxCommentError, type LikeInboxCommentResponse, type LinkedInAggregateAnalyticsDailyResponse, type LinkedInAggregateAnalyticsTotalResponse, type LinkedInPlatformData, type ListAccountGroupsError, type ListAccountGroupsResponse, type ListAccountsData, type ListAccountsError, type ListAccountsResponse, type ListAdAccountsData, type ListAdAccountsError, type ListAdAccountsResponse, type ListAdAudiencesData, type ListAdAudiencesError, type ListAdAudiencesResponse, type ListAdCampaignsData, type ListAdCampaignsError, type ListAdCampaignsResponse, type ListAdCatalogProductSetsData, type ListAdCatalogProductSetsError, type ListAdCatalogProductSetsResponse, type ListAdCatalogsData, type ListAdCatalogsError, type ListAdCatalogsResponse, type ListAdsBusinessCentersData, type ListAdsBusinessCentersError, type ListAdsBusinessCentersResponse, type ListAdsData, type ListAdsError, type ListAdsResponse, type ListApiKeysError, type ListApiKeysResponse, type ListBroadcastRecipientsData, type ListBroadcastRecipientsError, type ListBroadcastRecipientsResponse, type ListBroadcastsData, type ListBroadcastsError, type ListBroadcastsResponse, type ListCommentAutomationLogsData, type ListCommentAutomationLogsError, type ListCommentAutomationLogsResponse, type ListCommentAutomationsData, type ListCommentAutomationsError, type ListCommentAutomationsResponse, type ListContactsData, type ListContactsError, type ListContactsResponse, type ListConversionAssociationsData, type ListConversionAssociationsError, type ListConversionAssociationsResponse, type ListConversionDestinationsData, type ListConversionDestinationsError, type ListConversionDestinationsResponse, type ListCustomFieldsData, type ListCustomFieldsError, type ListCustomFieldsResponse, type ListDiscordGuildMembersData, type ListDiscordGuildMembersError, type ListDiscordGuildMembersResponse, type ListDiscordGuildRolesData, type ListDiscordGuildRolesError, type ListDiscordGuildRolesResponse, type ListDiscordPinnedMessagesData, type ListDiscordPinnedMessagesError, type ListDiscordPinnedMessagesResponse, type ListDiscordScheduledEventsData, type ListDiscordScheduledEventsError, type ListDiscordScheduledEventsResponse, type ListFacebookPagesData, type ListFacebookPagesError, type ListFacebookPagesResponse, type ListFormLeadsData, type ListFormLeadsError, type ListFormLeadsResponse, type ListGoogleBusinessLocationsData, type ListGoogleBusinessLocationsError, type ListGoogleBusinessLocationsResponse, type ListGoogleBusinessMediaData, type ListGoogleBusinessMediaError, type ListGoogleBusinessMediaResponse, type ListGoogleBusinessPlaceActionsData, type ListGoogleBusinessPlaceActionsError, type ListGoogleBusinessPlaceActionsResponse, type ListInboxCommentsData, type ListInboxCommentsError, type ListInboxCommentsResponse, type ListInboxConversationAnalyticsData, type ListInboxConversationAnalyticsError, type ListInboxConversationAnalyticsResponse, type ListInboxConversationsData, type ListInboxConversationsError, type ListInboxConversationsResponse, type ListInboxMentionsData, type ListInboxMentionsError, type ListInboxMentionsResponse, type ListInboxReviewsData, type ListInboxReviewsError, type ListInboxReviewsResponse, type ListInstagramStoriesData, type ListInstagramStoriesError, type ListInstagramStoriesResponse, type ListLeadFormsData, type ListLeadFormsError, type ListLeadFormsResponse, type ListLeadsData, type ListLeadsError, type ListLeadsResponse, type ListLinkedInOrganizationsData, type ListLinkedInOrganizationsError, type ListLinkedInOrganizationsResponse, type ListLogsData, type ListLogsError, type ListLogsResponse, type ListPinterestBoardsForSelectionData, type ListPinterestBoardsForSelectionError, type ListPinterestBoardsForSelectionResponse, type ListPostsData, type ListPostsError, type ListPostsResponse, type ListProfilesData, type ListProfilesError, type ListProfilesResponse, type ListQueueSlotsData, type ListQueueSlotsError, type ListQueueSlotsResponse, type ListSequenceEnrollmentsData, type ListSequenceEnrollmentsError, type ListSequenceEnrollmentsResponse, type ListSequencesData, type ListSequencesError, type ListSequencesResponse, type ListSnapchatProfilesData, type ListSnapchatProfilesError, type ListSnapchatProfilesResponse, type ListTrackingTagSharedAccountsData, type ListTrackingTagSharedAccountsError, type ListTrackingTagSharedAccountsResponse, type ListTrackingTagsData, type ListTrackingTagsError, type ListTrackingTagsResponse, type ListUsersError, type ListUsersResponse, type ListWhatsAppCallsData, type ListWhatsAppCallsError, type ListWhatsAppCallsResponse, type ListWhatsAppConversionsData, type ListWhatsAppConversionsError, type ListWhatsAppConversionsResponse, type ListWhatsAppFlowResponsesData, type ListWhatsAppFlowResponsesError, type ListWhatsAppFlowResponsesResponse, type ListWhatsAppFlowVersionsData, type ListWhatsAppFlowVersionsError, type ListWhatsAppFlowVersionsResponse, type ListWhatsAppFlowsData, type ListWhatsAppFlowsError, type ListWhatsAppFlowsResponse, type ListWhatsAppGroupChatsData, type ListWhatsAppGroupChatsError, type ListWhatsAppGroupChatsResponse, type ListWhatsAppGroupJoinRequestsData, type ListWhatsAppGroupJoinRequestsError, type ListWhatsAppGroupJoinRequestsResponse, type ListWhatsAppNumberCountriesError, type ListWhatsAppNumberCountriesResponse, type ListWhatsAppPhoneNumbersData, type ListWhatsAppPhoneNumbersError, type ListWhatsAppPhoneNumbersResponse, type ListWhatsAppSandboxSessionsError, type ListWhatsAppSandboxSessionsResponse, type ListWorkflowExecutionEventsData, type ListWorkflowExecutionEventsError, type ListWorkflowExecutionEventsResponse, type ListWorkflowExecutionsData, type ListWorkflowExecutionsError, type ListWorkflowExecutionsResponse, type ListWorkflowVersionsData, type ListWorkflowVersionsError, type ListWorkflowVersionsResponse, type ListWorkflowsData, type ListWorkflowsError, type ListWorkflowsResponse, type MarkConversationReadData, type MarkConversationReadError, type MarkConversationReadResponse, type MediaItem, type MediaUploadResponse, type Money, type MoveAccountToProfileData, type MoveAccountToProfileError, type MoveAccountToProfileResponse, type Pagination, type ParameterLimitParam, type ParameterPageParam, type PauseSequenceData, type PauseSequenceError, type PauseSequenceResponse, type PauseWorkflowData, type PauseWorkflowError, type PauseWorkflowResponse, type PinDiscordMessageData, type PinDiscordMessageError, type PinDiscordMessageResponse, type PinterestPlatformData, type PlatformAnalytics, type PlatformTarget, type Post, type PostAnalytics, type PostCreateResponse, type PostDeleteResponse, type PostGetResponse, type PostRetryResponse, type PostUpdateResponse, type PostsListResponse, type PreviewQueueData, type PreviewQueueError, type PreviewQueueResponse, type Profile, type ProfileCreateResponse, type ProfileDeleteResponse, type ProfileGetResponse, type ProfileUpdateResponse, type ProfilesListResponse, type PublishWhatsAppFlowData, type PublishWhatsAppFlowError, type PublishWhatsAppFlowResponse, type PurchaseWhatsAppPhoneNumberData, type PurchaseWhatsAppPhoneNumberError, type PurchaseWhatsAppPhoneNumberResponse, type QueueDeleteResponse, type QueueNextSlotResponse, type QueuePreviewResponse, type QueueSchedule, type QueueSlot, type QueueSlotsResponse, type QueueUpdateResponse, RateLimitError, type RecyclingConfig, type RecyclingState, type RedditPlatformData, type RedditPost, type RejectWhatsAppGroupJoinRequestsData, type RejectWhatsAppGroupJoinRequestsError, type RejectWhatsAppGroupJoinRequestsResponse, type ReleaseWhatsAppPhoneNumberData, type ReleaseWhatsAppPhoneNumberError, type ReleaseWhatsAppPhoneNumberResponse, type RemediateWhatsAppNumberData, type RemediateWhatsAppNumberError, type RemediateWhatsAppNumberResponse, type RemoveBookmarkData, type RemoveBookmarkError, type RemoveBookmarkResponse, type RemoveConversionAssociationsData, type RemoveConversionAssociationsError, type RemoveConversionAssociationsResponse, type RemoveDiscordMemberRoleData, type RemoveDiscordMemberRoleError, type RemoveDiscordMemberRoleResponse, type RemoveMessageReactionData, type RemoveMessageReactionError, type RemoveMessageReactionResponse, type RemoveTrackingTagSharedAccountData, type RemoveTrackingTagSharedAccountError, type RemoveTrackingTagSharedAccountResponse, type RemoveWhatsAppGroupParticipantsData, type RemoveWhatsAppGroupParticipantsError, type RemoveWhatsAppGroupParticipantsResponse, type ReplyToGoogleBusinessReviewData, type ReplyToGoogleBusinessReviewError, type ReplyToGoogleBusinessReviewResponse, type ReplyToInboxPostData, type ReplyToInboxPostError, type ReplyToInboxPostResponse, type ReplyToInboxReviewData, type ReplyToInboxReviewError, type ReplyToInboxReviewResponse, type RestoreWorkflowVersionData, type RestoreWorkflowVersionError, type RestoreWorkflowVersionResponse, type RetryPostData, type RetryPostError, type RetryPostResponse, type RetweetPostData, type RetweetPostError, type RetweetPostResponse, type ReviewWebhookReview, type ScheduleBroadcastData, type ScheduleBroadcastError, type ScheduleBroadcastResponse, type SearchAdInterestsData, type SearchAdInterestsError, type SearchAdInterestsResponse, type SearchAdTargetingData, type SearchAdTargetingError, type SearchAdTargetingResponse, type SearchAvailableWhatsAppNumbersData, type SearchAvailableWhatsAppNumbersError, type SearchAvailableWhatsAppNumbersResponse, type SearchRedditData, type SearchRedditError, type SearchRedditResponse, type SelectFacebookPageData, type SelectFacebookPageError, type SelectFacebookPageResponse, type SelectGoogleBusinessLocationData, type SelectGoogleBusinessLocationError, type SelectGoogleBusinessLocationResponse, type SelectLinkedInOrganizationData, type SelectLinkedInOrganizationError, type SelectLinkedInOrganizationResponse, type SelectPinterestBoardData, type SelectPinterestBoardError, type SelectPinterestBoardResponse, type SelectSnapchatProfileData, type SelectSnapchatProfileError, type SelectSnapchatProfileResponse, type SendBroadcastData, type SendBroadcastError, type SendBroadcastResponse, type SendConversionsData, type SendConversionsError, type SendConversionsResponse, type SendDiscordDirectMessageData, type SendDiscordDirectMessageError, type SendDiscordDirectMessageResponse, type SendInboxMessageData, type SendInboxMessageError, type SendInboxMessageResponse, type SendPrivateReplyToCommentData, type SendPrivateReplyToCommentError, type SendPrivateReplyToCommentResponse, type SendTypingIndicatorData, type SendTypingIndicatorError, type SendTypingIndicatorResponse, type SendWhatsAppConversionData, type SendWhatsAppConversionError, type SendWhatsAppConversionResponse, type SendWhatsAppFlowMessageData, type SendWhatsAppFlowMessageError, type SendWhatsAppFlowMessageResponse, type SetContactFieldValueData, type SetContactFieldValueError, type SetContactFieldValueResponse, type SetInstagramIceBreakersData, type SetInstagramIceBreakersError, type SetInstagramIceBreakersResponse, type SetMessengerMenuData, type SetMessengerMenuError, type SetMessengerMenuResponse, type SetTelegramCommandsData, type SetTelegramCommandsError, type SetTelegramCommandsResponse, type SetWhatsappBusinessUsernameData, type SetWhatsappBusinessUsernameError, type SetWhatsappBusinessUsernameResponse, type SharedAdAccount, type SnapchatPlatformData, type SocialAccount, type StartGoogleBusinessVerificationData, type StartGoogleBusinessVerificationError, type StartGoogleBusinessVerificationResponse, type SubmitWhatsAppNumberKycData, type SubmitWhatsAppNumberKycError, type SubmitWhatsAppNumberKycResponse, type SyncExternalPostsData, type SyncExternalPostsError, type SyncExternalPostsResponse, type TargetingSpec, type TelegramPlatformData, type TestWebhookData, type TestWebhookError, type TestWebhookResponse, type ThreadsPlatformData, type TikTokPlatformData, type TrackingTag, type TriggerWorkflowData, type TriggerWorkflowError, type TriggerWorkflowResponse, type TwitterPlatformData, type UnblockWhatsAppUsersData, type UnblockWhatsAppUsersError, type UnblockWhatsAppUsersResponse, type UndoRetweetData, type UndoRetweetError, type UndoRetweetResponse, type UnenrollContactData, type UnenrollContactError, type UnenrollContactResponse, type UnfollowUserData, type UnfollowUserError, type UnfollowUserResponse, type UnhideInboxCommentData, type UnhideInboxCommentError, type UnhideInboxCommentResponse, type UnlikeInboxCommentData, type UnlikeInboxCommentError, type UnlikeInboxCommentResponse, type UnpinDiscordMessageData, type UnpinDiscordMessageError, type UnpinDiscordMessageResponse, type UnpublishPostData, type UnpublishPostError, type UnpublishPostResponse, type UpdateAccountData, type UpdateAccountError, type UpdateAccountGroupData, type UpdateAccountGroupError, type UpdateAccountGroupResponse, type UpdateAccountResponse, type UpdateAdCampaignData, type UpdateAdCampaignError, type UpdateAdCampaignResponse, type UpdateAdCampaignStatusData, type UpdateAdCampaignStatusError, type UpdateAdCampaignStatusResponse, type UpdateAdData, type UpdateAdError, type UpdateAdResponse, type UpdateAdSetData, type UpdateAdSetError, type UpdateAdSetResponse, type UpdateAdSetStatusData, type UpdateAdSetStatusError, type UpdateAdSetStatusResponse, type UpdateAdTrackingTagsData, type UpdateAdTrackingTagsError, type UpdateAdTrackingTagsResponse, type UpdateBroadcastData, type UpdateBroadcastError, type UpdateBroadcastResponse, type UpdateCommentAutomationData, type UpdateCommentAutomationError, type UpdateCommentAutomationResponse, type UpdateContactData, type UpdateContactError, type UpdateContactResponse, type UpdateConversionDestinationData, type UpdateConversionDestinationError, type UpdateConversionDestinationResponse, type UpdateCustomFieldData, type UpdateCustomFieldError, type UpdateCustomFieldResponse, type UpdateDiscordScheduledEventData, type UpdateDiscordScheduledEventError, type UpdateDiscordScheduledEventResponse, type UpdateDiscordSettingsData, type UpdateDiscordSettingsError, type UpdateDiscordSettingsResponse, type UpdateFacebookPageData, type UpdateFacebookPageError, type UpdateFacebookPageResponse, type UpdateGmbLocationData, type UpdateGmbLocationError, type UpdateGmbLocationResponse, type UpdateGoogleBusinessAttributesData, type UpdateGoogleBusinessAttributesError, type UpdateGoogleBusinessAttributesResponse, type UpdateGoogleBusinessFoodMenusData, type UpdateGoogleBusinessFoodMenusError, type UpdateGoogleBusinessFoodMenusResponse, type UpdateGoogleBusinessLocationDetailsData, type UpdateGoogleBusinessLocationDetailsError, type UpdateGoogleBusinessLocationDetailsResponse, type UpdateGoogleBusinessPlaceActionData, type UpdateGoogleBusinessPlaceActionError, type UpdateGoogleBusinessPlaceActionResponse, type UpdateGoogleBusinessServicesData, type UpdateGoogleBusinessServicesError, type UpdateGoogleBusinessServicesResponse, type UpdateInboxConversationData, type UpdateInboxConversationError, type UpdateInboxConversationResponse, type UpdateLinkedInOrganizationData, type UpdateLinkedInOrganizationError, type UpdateLinkedInOrganizationResponse, type UpdatePinterestBoardsData, type UpdatePinterestBoardsError, type UpdatePinterestBoardsResponse, type UpdatePostData, type UpdatePostError, type UpdatePostMetadataData, type UpdatePostMetadataError, type UpdatePostMetadataResponse, type UpdatePostResponse, type UpdateProfileData, type UpdateProfileError, type UpdateProfileResponse, type UpdateQueueSlotData, type UpdateQueueSlotError, type UpdateQueueSlotResponse, type UpdateRedditSubredditsData, type UpdateRedditSubredditsError, type UpdateRedditSubredditsResponse, type UpdateSequenceData, type UpdateSequenceError, type UpdateSequenceResponse, type UpdateTrackingTagData, type UpdateTrackingTagError, type UpdateTrackingTagResponse, type UpdateWebhookSettingsData, type UpdateWebhookSettingsError, type UpdateWebhookSettingsResponse, type UpdateWhatsAppBusinessProfileData, type UpdateWhatsAppBusinessProfileError, type UpdateWhatsAppBusinessProfileResponse, type UpdateWhatsAppCallingData, type UpdateWhatsAppCallingError, type UpdateWhatsAppCallingResponse, type UpdateWhatsAppDisplayNameData, type UpdateWhatsAppDisplayNameError, type UpdateWhatsAppDisplayNameResponse, type UpdateWhatsAppFlowData, type UpdateWhatsAppFlowError, type UpdateWhatsAppFlowResponse, type UpdateWhatsAppGroupChatData, type UpdateWhatsAppGroupChatError, type UpdateWhatsAppGroupChatResponse, type UpdateWhatsAppTemplateData, type UpdateWhatsAppTemplateError, type UpdateWhatsAppTemplateResponse, type UpdateWorkflowData, type UpdateWorkflowError, type UpdateWorkflowResponse, type UpdateYoutubeDefaultPlaylistData, type UpdateYoutubeDefaultPlaylistError, type UpdateYoutubeDefaultPlaylistResponse, type UploadMediaDirectData, type UploadMediaDirectError, type UploadMediaDirectResponse, type UploadTokenResponse, type UploadTokenStatusResponse, type UploadWhatsAppFlowJsonData, type UploadWhatsAppFlowJsonError, type UploadWhatsAppFlowJsonResponse, type UploadWhatsAppNumberKycDocumentData, type UploadWhatsAppNumberKycDocumentError, type UploadWhatsAppNumberKycDocumentResponse, type UploadWhatsAppProfilePhotoData, type UploadWhatsAppProfilePhotoError, type UploadWhatsAppProfilePhotoResponse, type UploadedFile, type UsageStats, type User, type UserGetResponse, type UsersListResponse, type ValidateMediaData, type ValidateMediaError, type ValidateMediaResponse, type ValidatePostData, type ValidatePostError, type ValidatePostLengthData, type ValidatePostLengthError, type ValidatePostLengthResponse, type ValidatePostResponse, type ValidateSubredditData, type ValidateSubredditError, type ValidateSubredditResponse, type ValidateWhatsAppNumberKycAddressData, type ValidateWhatsAppNumberKycAddressError, type ValidateWhatsAppNumberKycAddressResponse, ValidationError, type Webhook, type WebhookLog, type WebhookPayloadAccountAdsInitialSyncCompleted, type WebhookPayloadAccountConnected, type WebhookPayloadAccountDisconnected, type WebhookPayloadAdStatusChanged, type WebhookPayloadCallEnded, type WebhookPayloadCallFailed, type WebhookPayloadCallPermissionRequest, type WebhookPayloadCallReceived, type WebhookPayloadComment, type WebhookPayloadConversationStarted, type WebhookPayloadExternalPost, type WebhookPayloadLead, type WebhookPayloadMessage, type WebhookPayloadMessageDeleted, type WebhookPayloadMessageDeliveryStatus, type WebhookPayloadMessageEdited, type WebhookPayloadMessageSent, type WebhookPayloadPost, type WebhookPayloadPostPlatform, type WebhookPayloadReaction, type WebhookPayloadReviewNew, type WebhookPayloadReviewUpdated, type WebhookPayloadTest, type WebhookPayloadWhatsAppTemplateStatusUpdated, type WhatsAppBodyComponent, type WhatsAppButtonsComponent, type WhatsAppFooterComponent, type WhatsAppHeaderComponent, type WhatsAppSandboxSession, type WhatsAppTemplateButton, type WhatsAppTemplateComponent, type WorkflowEdge, type WorkflowExecutionEvent, type WorkflowNode, type XApiOperation, type XApiPricing, type YouTubeDailyViewsResponse, type YouTubeDemographicsResponse, type YouTubePlatformData, type YouTubeScopeMissingResponse, type YouTubeVideoRetentionResponse, Zernio, ZernioApiError, type action, type action2, type actionSource, type adType, type adType2, type adType3, type aggregation, type aggregation2, type autoArchiveDuration, type billingPeriod, type billingSystem, type budgetLevel, type commercialContentType, type contentType, type contentType2, type contentType3, Zernio as default, type direction, type direction2, type disconnectionType, type endReason, type entity_type, type errorCategory, type errorCategory2, type errorSource, type event, type event10, type event11, type event12, type event13, type event14, type event15, type event16, type event17, type event18, type event19, type event2, type event20, type event21, type event22, type event23, type event24, type event3, type event4, type event5, type event6, type event7, type event8, type event9, type format, type gapFreq, type gender, type goal, type graduationStrategy, type incomeTier, type interactiveType, type kind, type level, type mediaType, type mediaType2, type metric, type metricType, type offerType, type otp_type, parseApiError, type parseMode, type permission, type platform, type platform10, type platform2, type platform3, type platform4, type platform5, type platform6, type platform7, type platform8, type platform9, type privacy_level, type replySettings, type response, type reviewStatus, type scope, type source, type status, type status10, type status11, type status12, type status2, type status3, type status4, type status5, type status6, type status7, type status8, type status9, type syncStatus, type syncStatus2, type timeframe, type topicType, type trialGraduationStrategy, type type, type type2, type type3, type type4, type type5, type type6, type type7, type type8, type type9, type visibility };
|
|
24070
|
+
export { type AccountWithFollowerStats, type AccountsListResponse, type ActivateSequenceData, type ActivateSequenceError, type ActivateSequenceResponse, type ActivateWorkflowData, type ActivateWorkflowError, type ActivateWorkflowResponse, type Ad, type AdBudget, type AdCampaign, type AdDailyMetrics, type AdMetrics, type AdStatus, type AdTreeAdSet, type AdTreeCampaign, type AddBroadcastRecipientsData, type AddBroadcastRecipientsError, type AddBroadcastRecipientsResponse, type AddConversionAssociationsData, type AddConversionAssociationsError, type AddConversionAssociationsResponse, type AddDiscordMemberRoleData, type AddDiscordMemberRoleError, type AddDiscordMemberRoleResponse, type AddMessageReactionData, type AddMessageReactionError, type AddMessageReactionResponse, type AddTrackingTagSharedAccountData, type AddTrackingTagSharedAccountError, type AddTrackingTagSharedAccountResponse, type AddUsersToAdAudienceData, type AddUsersToAdAudienceError, type AddUsersToAdAudienceResponse, type AddWhatsAppGroupParticipantsData, type AddWhatsAppGroupParticipantsError, type AddWhatsAppGroupParticipantsResponse, type AdjustConversionsData, type AdjustConversionsError, type AdjustConversionsResponse, type AnalyticsListResponse, type AnalyticsOverview, type AnalyticsSinglePostResponse, type ApiKey, type AppealSmsRegistrationData, type AppealSmsRegistrationError, type AppealSmsRegistrationResponse, type ApproveWhatsAppGroupJoinRequestsData, type ApproveWhatsAppGroupJoinRequestsError, type ApproveWhatsAppGroupJoinRequestsResponse, type ArchiveLeadFormData, type ArchiveLeadFormError, type ArchiveLeadFormResponse, type BatchGetGoogleBusinessReviewsData, type BatchGetGoogleBusinessReviewsError, type BatchGetGoogleBusinessReviewsResponse, type BidStrategy, type BlockWhatsAppUsersData, type BlockWhatsAppUsersError, type BlockWhatsAppUsersResponse, type BlueskyPlatformData, type BookmarkPostData, type BookmarkPostError, type BookmarkPostResponse, type BoostPostData, type BoostPostError, type BoostPostResponse, type BulkCreateContactsData, type BulkCreateContactsError, type BulkCreateContactsResponse, type BulkUpdateAdCampaignStatusData, type BulkUpdateAdCampaignStatusError, type BulkUpdateAdCampaignStatusResponse, type BulkUploadPostsData, type BulkUploadPostsError, type BulkUploadPostsResponse, type BulkUploadResult, type BusinessCenter, type CallRecord, type CancelBroadcastData, type CancelBroadcastError, type CancelBroadcastResponse, type CancelPhoneNumberPortInData, type CancelPhoneNumberPortInError, type CancelPhoneNumberPortInResponse, type CheckPhoneNumberAvailabilityData, type CheckPhoneNumberAvailabilityError, type CheckPhoneNumberAvailabilityResponse, type CheckPhoneNumberPortabilityData, type CheckPhoneNumberPortabilityError, type CheckPhoneNumberPortabilityResponse, type CheckWhatsAppNumberAvailabilityData, type CheckWhatsAppNumberAvailabilityError, type CheckWhatsAppNumberAvailabilityResponse, type ClearContactFieldValueData, type ClearContactFieldValueError, type ClearContactFieldValueResponse, type ClientOptions, type CompleteGoogleBusinessVerificationData, type CompleteGoogleBusinessVerificationError, type CompleteGoogleBusinessVerificationResponse, type CompleteTelegramConnectData, type CompleteTelegramConnectError, type CompleteTelegramConnectResponse, type CompleteWhatsAppPhoneSelectionData, type CompleteWhatsAppPhoneSelectionError, type CompleteWhatsAppPhoneSelectionResponse, type ConfigureTikTokAdsBrandIdentityData, type ConfigureTikTokAdsBrandIdentityError, type ConfigureTikTokAdsBrandIdentityResponse, type ConnectAdsData, type ConnectAdsError, type ConnectAdsResponse, type ConnectBlueskyCredentialsData, type ConnectBlueskyCredentialsError, type ConnectBlueskyCredentialsResponse, type ConnectWhatsAppCredentialsData, type ConnectWhatsAppCredentialsError, type ConnectWhatsAppCredentialsResponse, type ConversionDestination, type ConversionEvent, type CreateAccountGroupData, type CreateAccountGroupError, type CreateAccountGroupResponse, type CreateAdAudienceData, type CreateAdAudienceError, type CreateAdAudienceResponse, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyResponse, type CreateBroadcastData, type CreateBroadcastError, type CreateBroadcastResponse, type CreateCommentAutomationData, type CreateCommentAutomationError, type CreateCommentAutomationResponse, type CreateContactData, type CreateContactError, type CreateContactResponse, type CreateConversionDestinationData, type CreateConversionDestinationError, type CreateConversionDestinationResponse, type CreateCtwaAdData, type CreateCtwaAdError, type CreateCtwaAdResponse, type CreateCustomFieldData, type CreateCustomFieldError, type CreateCustomFieldResponse, type CreateDiscordScheduledEventData, type CreateDiscordScheduledEventError, type CreateDiscordScheduledEventResponse, type CreateGoogleBusinessMediaData, type CreateGoogleBusinessMediaError, type CreateGoogleBusinessMediaResponse, type CreateGoogleBusinessPlaceActionData, type CreateGoogleBusinessPlaceActionError, type CreateGoogleBusinessPlaceActionResponse, type CreateInboxConversationData, type CreateInboxConversationError, type CreateInboxConversationResponse, type CreateInviteTokenData, type CreateInviteTokenError, type CreateInviteTokenResponse, type CreateLeadFormData, type CreateLeadFormError, type CreateLeadFormResponse, type CreatePhoneNumberKycLinkData, type CreatePhoneNumberKycLinkError, type CreatePhoneNumberKycLinkResponse, type CreatePhoneNumberPortInData, type CreatePhoneNumberPortInError, type CreatePhoneNumberPortInResponse, type CreatePostData, type CreatePostError, type CreatePostResponse, type CreateProfileData, type CreateProfileError, type CreateProfileResponse, type CreateQueueSlotData, type CreateQueueSlotError, type CreateQueueSlotResponse, type CreateSequenceData, type CreateSequenceError, type CreateSequenceResponse, type CreateStandaloneAdData, type CreateStandaloneAdError, type CreateStandaloneAdResponse, type CreateTestLeadData, type CreateTestLeadError, type CreateTestLeadResponse, type CreateTrackingTagData, type CreateTrackingTagError, type CreateTrackingTagResponse, type CreateVoiceCallData, type CreateVoiceCallError, type CreateVoiceCallResponse, type CreateVoiceWebSessionError, type CreateVoiceWebSessionResponse, type CreateWebhookSettingsData, type CreateWebhookSettingsError, type CreateWebhookSettingsResponse, type CreateWhatsAppDatasetData, type CreateWhatsAppDatasetError, type CreateWhatsAppDatasetResponse, type CreateWhatsAppFlowData, type CreateWhatsAppFlowError, type CreateWhatsAppFlowResponse, type CreateWhatsAppGroupChatData, type CreateWhatsAppGroupChatError, type CreateWhatsAppGroupChatResponse, type CreateWhatsAppGroupInviteLinkData, type CreateWhatsAppGroupInviteLinkError, type CreateWhatsAppGroupInviteLinkResponse, type CreateWhatsAppNumberKycLinkData, type CreateWhatsAppNumberKycLinkError, type CreateWhatsAppNumberKycLinkResponse, type CreateWhatsAppSandboxSessionData, type CreateWhatsAppSandboxSessionError, type CreateWhatsAppSandboxSessionResponse, type CreateWhatsAppTemplateData, type CreateWhatsAppTemplateError, type CreateWhatsAppTemplateResponse, type CreateWorkflowData, type CreateWorkflowError, type CreateWorkflowResponse, type CtwaMultiResponse, type CtwaSingleResponse, type DeleteAccountData, type DeleteAccountError, type DeleteAccountGroupData, type DeleteAccountGroupError, type DeleteAccountGroupResponse, type DeleteAccountResponse, type DeleteAdAudienceData, type DeleteAdAudienceError, type DeleteAdAudienceResponse, type DeleteAdCampaignData, type DeleteAdCampaignError, type DeleteAdCampaignResponse, type DeleteAdData, type DeleteAdError, type DeleteAdResponse, type DeleteApiKeyData, type DeleteApiKeyError, type DeleteApiKeyResponse, type DeleteBroadcastData, type DeleteBroadcastError, type DeleteBroadcastResponse, type DeleteCommentAutomationData, type DeleteCommentAutomationError, type DeleteCommentAutomationResponse, type DeleteContactData, type DeleteContactError, type DeleteContactResponse, type DeleteConversionDestinationData, type DeleteConversionDestinationError, type DeleteConversionDestinationResponse, type DeleteCustomFieldData, type DeleteCustomFieldError, type DeleteCustomFieldResponse, type DeleteDiscordScheduledEventData, type DeleteDiscordScheduledEventError, type DeleteDiscordScheduledEventResponse, type DeleteGoogleBusinessMediaData, type DeleteGoogleBusinessMediaError, type DeleteGoogleBusinessMediaResponse, type DeleteGoogleBusinessPlaceActionData, type DeleteGoogleBusinessPlaceActionError, type DeleteGoogleBusinessPlaceActionResponse, type DeleteGoogleBusinessReviewReplyData, type DeleteGoogleBusinessReviewReplyError, type DeleteGoogleBusinessReviewReplyResponse, type DeleteInboxCommentData, type DeleteInboxCommentError, type DeleteInboxCommentResponse, type DeleteInboxMessageData, type DeleteInboxMessageError, type DeleteInboxMessageResponse, type DeleteInboxReviewReplyData, type DeleteInboxReviewReplyError, type DeleteInboxReviewReplyResponse, type DeleteInstagramIceBreakersData, type DeleteInstagramIceBreakersError, type DeleteInstagramIceBreakersResponse, type DeleteMessengerMenuData, type DeleteMessengerMenuError, type DeleteMessengerMenuResponse, type DeletePostData, type DeletePostError, type DeletePostResponse, type DeleteProfileData, type DeleteProfileError, type DeleteProfileResponse, type DeleteQueueSlotData, type DeleteQueueSlotError, type DeleteQueueSlotResponse, type DeleteSequenceData, type DeleteSequenceError, type DeleteSequenceResponse, type DeleteTelegramCommandsData, type DeleteTelegramCommandsError, type DeleteTelegramCommandsResponse, type DeleteWebhookSettingsData, type DeleteWebhookSettingsError, type DeleteWebhookSettingsResponse, type DeleteWhatsAppFlowData, type DeleteWhatsAppFlowError, type DeleteWhatsAppFlowResponse, type DeleteWhatsAppGroupChatData, type DeleteWhatsAppGroupChatError, type DeleteWhatsAppGroupChatResponse, type DeleteWhatsAppSandboxSessionData, type DeleteWhatsAppSandboxSessionError, type DeleteWhatsAppSandboxSessionResponse, type DeleteWhatsAppTemplateData, type DeleteWhatsAppTemplateError, type DeleteWhatsAppTemplateResponse, type DeleteWhatsappBusinessUsernameData, type DeleteWhatsappBusinessUsernameError, type DeleteWhatsappBusinessUsernameResponse, type DeleteWorkflowData, type DeleteWorkflowError, type DeleteWorkflowResponse, type DeprecateWhatsAppFlowData, type DeprecateWhatsAppFlowError, type DeprecateWhatsAppFlowResponse, type DialVoiceWebCallData, type DialVoiceWebCallError, type DialVoiceWebCallResponse, type DisableSmsOnNumberData, type DisableSmsOnNumberError, type DisableSmsOnNumberResponse, type DisableVoiceOnNumberData, type DisableVoiceOnNumberError, type DisableVoiceOnNumberResponse, type DisableWhatsAppCallingData, type DisableWhatsAppCallingError, type DisableWhatsAppCallingLegacyData, type DisableWhatsAppCallingLegacyError, type DisableWhatsAppCallingLegacyResponse, type DisableWhatsAppCallingResponse, type DiscordPlatformData, type DiscordScheduledEvent, type DmButton, type DuplicateAdCampaignData, type DuplicateAdCampaignError, type DuplicateAdCampaignResponse, type DuplicateWorkflowData, type DuplicateWorkflowError, type DuplicateWorkflowResponse, type EditInboxMessageData, type EditInboxMessageError, type EditInboxMessageResponse, type EditPostData, type EditPostError, type EditPostResponse, type EnableSmsOnNumberData, type EnableSmsOnNumberError, type EnableSmsOnNumberResponse, type EnableVoiceOnNumberData, type EnableVoiceOnNumberError, type EnableVoiceOnNumberResponse, type EnableWhatsAppCallingData, type EnableWhatsAppCallingError, type EnableWhatsAppCallingLegacyData, type EnableWhatsAppCallingLegacyError, type EnableWhatsAppCallingLegacyResponse, type EnableWhatsAppCallingResponse, type EndVoiceCallData, type EndVoiceCallError, type EndVoiceCallResponse, type EnrollContactsData, type EnrollContactsError, type EnrollContactsResponse, type ErrorResponse, type EstimateAdReachData, type EstimateAdReachError, type EstimateAdReachResponse, type ExternalPostMediaItem, type ExternalPostSummary, type ExternalPostWebhookPost, type FacebookPlatformData, type FetchGoogleBusinessVerificationOptionsData, type FetchGoogleBusinessVerificationOptionsError, type FetchGoogleBusinessVerificationOptionsResponse, type FollowUserData, type FollowUserError, type FollowUserResponse, type FollowerStatsResponse, type FoodMenu, type FoodMenuItem, type FoodMenuItemAttributes, type FoodMenuLabel, type FoodMenuSection, type GeoRestriction, type GetAccountHealthData, type GetAccountHealthError, type GetAccountHealthResponse, type GetAdAnalyticsData, type GetAdAnalyticsError, type GetAdAnalyticsResponse, type GetAdAudienceData, type GetAdAudienceError, type GetAdAudienceResponse, type GetAdCommentsData, type GetAdCommentsError, type GetAdCommentsResponse, type GetAdData, type GetAdError, type GetAdResponse, type GetAdTrackingTagsData, type GetAdTrackingTagsError, type GetAdTrackingTagsResponse, type GetAdTreeData, type GetAdTreeError, type GetAdTreeResponse, type GetAdsTimelineData, type GetAdsTimelineError, type GetAdsTimelineResponse, type GetAllAccountsHealthData, type GetAllAccountsHealthError, type GetAllAccountsHealthResponse, type GetAnalyticsData, type GetAnalyticsError, type GetAnalyticsResponse, type GetBestTimeToPostData, type GetBestTimeToPostError, type GetBestTimeToPostResponse, type GetBroadcastData, type GetBroadcastError, type GetBroadcastResponse, type GetCallData, type GetCallError, type GetCallRecordingData, type GetCallRecordingError, type GetCallRecordingResponse, type GetCallResponse, type GetCallsUsageData, type GetCallsUsageError, type GetCallsUsageResponse, type GetCampaignAnalyticsData, type GetCampaignAnalyticsError, type GetCampaignAnalyticsResponse, type GetCommentAutomationData, type GetCommentAutomationError, type GetCommentAutomationResponse, type GetConnectUrlData, type GetConnectUrlError, type GetConnectUrlResponse, type GetContactChannelsData, type GetContactChannelsError, type GetContactChannelsResponse, type GetContactData, type GetContactError, type GetContactResponse, type GetContentDecayData, type GetContentDecayError, type GetContentDecayResponse, type GetConversionDestinationData, type GetConversionDestinationError, type GetConversionDestinationResponse, type GetConversionMetricsData, type GetConversionMetricsError, type GetConversionMetricsResponse, type GetConversionsQualityData, type GetConversionsQualityError, type GetConversionsQualityResponse, type GetDailyMetricsData, type GetDailyMetricsError, type GetDailyMetricsResponse, type GetDiscordChannelsData, type GetDiscordChannelsError, type GetDiscordChannelsResponse, type GetDiscordScheduledEventData, type GetDiscordScheduledEventError, type GetDiscordScheduledEventResponse, type GetDiscordSettingsData, type GetDiscordSettingsError, type GetDiscordSettingsResponse, type GetFacebookPageInsightsData, type GetFacebookPageInsightsError, type GetFacebookPageInsightsResponse, type GetFacebookPagesData, type GetFacebookPagesError, type GetFacebookPagesResponse, type GetFollowerStatsData, type GetFollowerStatsError, type GetFollowerStatsResponse, type GetGmbAttributeMetadataData, type GetGmbAttributeMetadataError, type GetGmbAttributeMetadataResponse, type GetGmbLocationsData, type GetGmbLocationsError, type GetGmbLocationsResponse, type GetGoogleBusinessAttributesData, type GetGoogleBusinessAttributesError, type GetGoogleBusinessAttributesResponse, type GetGoogleBusinessFoodMenusData, type GetGoogleBusinessFoodMenusError, type GetGoogleBusinessFoodMenusResponse, type GetGoogleBusinessLocationDetailsData, type GetGoogleBusinessLocationDetailsError, type GetGoogleBusinessLocationDetailsResponse, type GetGoogleBusinessPerformanceData, type GetGoogleBusinessPerformanceError, type GetGoogleBusinessPerformanceResponse, type GetGoogleBusinessReviewsData, type GetGoogleBusinessReviewsError, type GetGoogleBusinessReviewsResponse, type GetGoogleBusinessSearchKeywordsData, type GetGoogleBusinessSearchKeywordsError, type GetGoogleBusinessSearchKeywordsResponse, type GetGoogleBusinessServicesData, type GetGoogleBusinessServicesError, type GetGoogleBusinessServicesResponse, type GetGoogleBusinessVerificationsData, type GetGoogleBusinessVerificationsError, type GetGoogleBusinessVerificationsResponse, type GetInboxConversationAnalyticsData, type GetInboxConversationAnalyticsError, type GetInboxConversationAnalyticsResponse, type GetInboxConversationData, type GetInboxConversationError, type GetInboxConversationMessagesData, type GetInboxConversationMessagesError, type GetInboxConversationMessagesResponse, type GetInboxConversationResponse, type GetInboxHeatmapData, type GetInboxHeatmapError, type GetInboxHeatmapResponse, type GetInboxPostCommentsData, type GetInboxPostCommentsError, type GetInboxPostCommentsResponse, type GetInboxResponseTimeData, type GetInboxResponseTimeError, type GetInboxResponseTimeResponse, type GetInboxSourceBreakdownData, type GetInboxSourceBreakdownError, type GetInboxSourceBreakdownResponse, type GetInboxTopAccountsData, type GetInboxTopAccountsError, type GetInboxTopAccountsResponse, type GetInboxVolumeData, type GetInboxVolumeError, type GetInboxVolumeResponse, type GetInstagramAccountInsightsData, type GetInstagramAccountInsightsError, type GetInstagramAccountInsightsResponse, type GetInstagramDemographicsData, type GetInstagramDemographicsError, type GetInstagramDemographicsResponse, type GetInstagramFollowerHistoryData, type GetInstagramFollowerHistoryError, type GetInstagramFollowerHistoryResponse, type GetInstagramIceBreakersData, type GetInstagramIceBreakersError, type GetInstagramIceBreakersResponse, type GetInstagramStoryInsightsData, type GetInstagramStoryInsightsError, type GetInstagramStoryInsightsResponse, type GetLeadFormData, type GetLeadFormError, type GetLeadFormResponse, type GetLinkedInAggregateAnalyticsData, type GetLinkedInAggregateAnalyticsError, type GetLinkedInAggregateAnalyticsResponse, type GetLinkedInMentionsData, type GetLinkedInMentionsError, type GetLinkedInMentionsResponse, type GetLinkedInOrgAggregateAnalyticsData, type GetLinkedInOrgAggregateAnalyticsError, type GetLinkedInOrgAggregateAnalyticsResponse, type GetLinkedInOrganizationsData, type GetLinkedInOrganizationsError, type GetLinkedInOrganizationsResponse, type GetLinkedInPostAnalyticsData, type GetLinkedInPostAnalyticsError, type GetLinkedInPostAnalyticsResponse, type GetLinkedInPostReactionsData, type GetLinkedInPostReactionsError, type GetLinkedInPostReactionsResponse, type GetMediaPresignedUrlData, type GetMediaPresignedUrlError, type GetMediaPresignedUrlResponse, type GetMessengerMenuData, type GetMessengerMenuError, type GetMessengerMenuResponse, type GetNextQueueSlotData, type GetNextQueueSlotError, type GetNextQueueSlotResponse, type GetPendingOAuthDataData, type GetPendingOAuthDataError, type GetPendingOAuthDataResponse, type GetPhoneNumberData, type GetPhoneNumberError, type GetPhoneNumberKycFormData, type GetPhoneNumberKycFormError, type GetPhoneNumberKycFormResponse, type GetPhoneNumberRemediationData, type GetPhoneNumberRemediationError, type GetPhoneNumberRemediationResponse, type GetPhoneNumberResponse, type GetPinterestBoardsData, type GetPinterestBoardsError, type GetPinterestBoardsResponse, type GetPostData, type GetPostError, type GetPostResponse, type GetPostTimelineData, type GetPostTimelineError, type GetPostTimelineResponse, type GetPostingFrequencyData, type GetPostingFrequencyError, type GetPostingFrequencyResponse, type GetProfileData, type GetProfileError, type GetProfileResponse, type GetRedditFeedData, type GetRedditFeedError, type GetRedditFeedResponse, type GetRedditFlairsData, type GetRedditFlairsError, type GetRedditFlairsResponse, type GetRedditSubredditsData, type GetRedditSubredditsError, type GetRedditSubredditsResponse, type GetSequenceData, type GetSequenceError, type GetSequenceResponse, type GetSmsRegistrationData, type GetSmsRegistrationError, type GetSmsRegistrationResponse, type GetSmsUsageData, type GetSmsUsageError, type GetSmsUsageResponse, type GetTelegramCommandsData, type GetTelegramCommandsError, type GetTelegramCommandsResponse, type GetTelegramConnectStatusData, type GetTelegramConnectStatusError, type GetTelegramConnectStatusResponse, type GetTikTokAccountInsightsData, type GetTikTokAccountInsightsError, type GetTikTokAccountInsightsResponse, type GetTikTokCreatorInfoData, type GetTikTokCreatorInfoError, type GetTikTokCreatorInfoResponse, type GetTrackingTagData, type GetTrackingTagError, type GetTrackingTagResponse, type GetTrackingTagStatsData, type GetTrackingTagStatsError, type GetTrackingTagStatsResponse, type GetUsageData, type GetUsageError, type GetUsageResponse, type GetUsageStatsData, type GetUsageStatsError, type GetUsageStatsResponse, type GetUserData, type GetUserError, type GetUserResponse, type GetVoiceCallData, type GetVoiceCallError, type GetVoiceCallEstimateData, type GetVoiceCallEstimateError, type GetVoiceCallEstimateResponse, type GetVoiceCallRecordingData, type GetVoiceCallRecordingError, type GetVoiceCallRecordingResponse, type GetVoiceCallResponse, type GetWebhookLogsData, type GetWebhookLogsError, type GetWebhookLogsResponse, type GetWebhookSettingsError, type GetWebhookSettingsResponse, type GetWhatsAppBlockStatusData, type GetWhatsAppBlockStatusError, type GetWhatsAppBlockStatusResponse, type GetWhatsAppBlockedUsersData, type GetWhatsAppBlockedUsersError, type GetWhatsAppBlockedUsersResponse, type GetWhatsAppBusinessProfileData, type GetWhatsAppBusinessProfileError, type GetWhatsAppBusinessProfileResponse, type GetWhatsAppCallData, type GetWhatsAppCallError, type GetWhatsAppCallEstimateData, type GetWhatsAppCallEstimateError, type GetWhatsAppCallEstimateResponse, type GetWhatsAppCallPermissionsData, type GetWhatsAppCallPermissionsError, type GetWhatsAppCallPermissionsResponse, type GetWhatsAppCallRecordingData, type GetWhatsAppCallRecordingError, type GetWhatsAppCallRecordingResponse, type GetWhatsAppCallResponse, type GetWhatsAppCallingConfigData, type GetWhatsAppCallingConfigError, type GetWhatsAppCallingConfigResponse, type GetWhatsAppCallingData, type GetWhatsAppCallingError, type GetWhatsAppCallingResponse, type GetWhatsAppDatasetData, type GetWhatsAppDatasetError, type GetWhatsAppDatasetResponse, type GetWhatsAppDisplayNameData, type GetWhatsAppDisplayNameError, type GetWhatsAppDisplayNameResponse, type GetWhatsAppFlowData, type GetWhatsAppFlowError, type GetWhatsAppFlowJsonData, type GetWhatsAppFlowJsonError, type GetWhatsAppFlowJsonResponse, type GetWhatsAppFlowPreviewData, type GetWhatsAppFlowPreviewError, type GetWhatsAppFlowPreviewResponse, type GetWhatsAppFlowResponse, type GetWhatsAppGroupChatData, type GetWhatsAppGroupChatError, type GetWhatsAppGroupChatResponse, type GetWhatsAppLibraryTemplateData, type GetWhatsAppLibraryTemplateError, type GetWhatsAppLibraryTemplateResponse, type GetWhatsAppNumberInfoData, type GetWhatsAppNumberInfoError, type GetWhatsAppNumberInfoResponse, type GetWhatsAppNumberKycFormData, type GetWhatsAppNumberKycFormError, type GetWhatsAppNumberKycFormResponse, type GetWhatsAppNumberRemediationData, type GetWhatsAppNumberRemediationError, type GetWhatsAppNumberRemediationResponse, type GetWhatsAppPhoneNumberData, type GetWhatsAppPhoneNumberError, type GetWhatsAppPhoneNumberResponse, type GetWhatsAppPhoneNumbersData, type GetWhatsAppPhoneNumbersError, type GetWhatsAppPhoneNumbersResponse, type GetWhatsAppTemplateData, type GetWhatsAppTemplateError, type GetWhatsAppTemplateResponse, type GetWhatsAppTemplatesData, type GetWhatsAppTemplatesError, type GetWhatsAppTemplatesResponse, type GetWhatsappBusinessUsernameData, type GetWhatsappBusinessUsernameError, type GetWhatsappBusinessUsernameResponse, type GetWhatsappBusinessUsernameSuggestionsData, type GetWhatsappBusinessUsernameSuggestionsError, type GetWhatsappBusinessUsernameSuggestionsResponse, type GetWorkflowData, type GetWorkflowError, type GetWorkflowResponse, type GetWorkflowVersionData, type GetWorkflowVersionError, type GetWorkflowVersionResponse, type GetXApiPricingError, type GetXApiPricingResponse, type GetYouTubeChannelInsightsData, type GetYouTubeChannelInsightsError, type GetYouTubeChannelInsightsResponse, type GetYouTubeDailyViewsData, type GetYouTubeDailyViewsError, type GetYouTubeDailyViewsResponse, type GetYouTubeDemographicsData, type GetYouTubeDemographicsError, type GetYouTubeDemographicsResponse, type GetYouTubeVideoRetentionData, type GetYouTubeVideoRetentionError, type GetYouTubeVideoRetentionResponse, type GetYoutubePlaylistsData, type GetYoutubePlaylistsError, type GetYoutubePlaylistsResponse, type GoogleBusinessPlatformData, type HandleOAuthCallbackData, type HandleOAuthCallbackError, type HandleOAuthCallbackResponse, type HideInboxCommentData, type HideInboxCommentError, type HideInboxCommentResponse, type InboxWebhookAccount, type InboxWebhookConversation, type InboxWebhookMessage, type InitiateTelegramConnectData, type InitiateTelegramConnectError, type InitiateTelegramConnectResponse, type InitiateWhatsAppCallData, type InitiateWhatsAppCallError, type InitiateWhatsAppCallResponse, type InstagramAccountInsightsResponse, type InstagramDemographicsResponse, type InstagramPlatformData, Late, LateApiError, type LikeInboxCommentData, type LikeInboxCommentError, type LikeInboxCommentResponse, type LinkedInAggregateAnalyticsDailyResponse, type LinkedInAggregateAnalyticsTotalResponse, type LinkedInPlatformData, type ListAccountGroupsError, type ListAccountGroupsResponse, type ListAccountsData, type ListAccountsError, type ListAccountsResponse, type ListAdAccountsData, type ListAdAccountsError, type ListAdAccountsResponse, type ListAdAudiencesData, type ListAdAudiencesError, type ListAdAudiencesResponse, type ListAdCampaignsData, type ListAdCampaignsError, type ListAdCampaignsResponse, type ListAdCatalogProductSetsData, type ListAdCatalogProductSetsError, type ListAdCatalogProductSetsResponse, type ListAdCatalogsData, type ListAdCatalogsError, type ListAdCatalogsResponse, type ListAdsBusinessCentersData, type ListAdsBusinessCentersError, type ListAdsBusinessCentersResponse, type ListAdsData, type ListAdsError, type ListAdsResponse, type ListApiKeysError, type ListApiKeysResponse, type ListBroadcastRecipientsData, type ListBroadcastRecipientsError, type ListBroadcastRecipientsResponse, type ListBroadcastsData, type ListBroadcastsError, type ListBroadcastsResponse, type ListCallsData, type ListCallsError, type ListCallsResponse, type ListCommentAutomationLogsData, type ListCommentAutomationLogsError, type ListCommentAutomationLogsResponse, type ListCommentAutomationsData, type ListCommentAutomationsError, type ListCommentAutomationsResponse, type ListContactsData, type ListContactsError, type ListContactsResponse, type ListConversionAssociationsData, type ListConversionAssociationsError, type ListConversionAssociationsResponse, type ListConversionDestinationsData, type ListConversionDestinationsError, type ListConversionDestinationsResponse, type ListCustomFieldsData, type ListCustomFieldsError, type ListCustomFieldsResponse, type ListDiscordGuildMembersData, type ListDiscordGuildMembersError, type ListDiscordGuildMembersResponse, type ListDiscordGuildRolesData, type ListDiscordGuildRolesError, type ListDiscordGuildRolesResponse, type ListDiscordPinnedMessagesData, type ListDiscordPinnedMessagesError, type ListDiscordPinnedMessagesResponse, type ListDiscordScheduledEventsData, type ListDiscordScheduledEventsError, type ListDiscordScheduledEventsResponse, type ListFacebookPagesData, type ListFacebookPagesError, type ListFacebookPagesResponse, type ListFormLeadsData, type ListFormLeadsError, type ListFormLeadsResponse, type ListGoogleBusinessLocationsData, type ListGoogleBusinessLocationsError, type ListGoogleBusinessLocationsResponse, type ListGoogleBusinessMediaData, type ListGoogleBusinessMediaError, type ListGoogleBusinessMediaResponse, type ListGoogleBusinessPlaceActionsData, type ListGoogleBusinessPlaceActionsError, type ListGoogleBusinessPlaceActionsResponse, type ListInboxCommentsData, type ListInboxCommentsError, type ListInboxCommentsResponse, type ListInboxConversationAnalyticsData, type ListInboxConversationAnalyticsError, type ListInboxConversationAnalyticsResponse, type ListInboxConversationsData, type ListInboxConversationsError, type ListInboxConversationsResponse, type ListInboxMentionsData, type ListInboxMentionsError, type ListInboxMentionsResponse, type ListInboxReviewsData, type ListInboxReviewsError, type ListInboxReviewsResponse, type ListInstagramStoriesData, type ListInstagramStoriesError, type ListInstagramStoriesResponse, type ListLeadFormsData, type ListLeadFormsError, type ListLeadFormsResponse, type ListLeadsData, type ListLeadsError, type ListLeadsResponse, type ListLinkedInOrganizationsData, type ListLinkedInOrganizationsError, type ListLinkedInOrganizationsResponse, type ListLogsData, type ListLogsError, type ListLogsResponse, type ListPhoneNumberCountriesError, type ListPhoneNumberCountriesResponse, type ListPhoneNumberPortInsError, type ListPhoneNumberPortInsResponse, type ListPhoneNumbersData, type ListPhoneNumbersError, type ListPhoneNumbersResponse, type ListPinterestBoardsForSelectionData, type ListPinterestBoardsForSelectionError, type ListPinterestBoardsForSelectionResponse, type ListPostsData, type ListPostsError, type ListPostsResponse, type ListProfilesData, type ListProfilesError, type ListProfilesResponse, type ListQueueSlotsData, type ListQueueSlotsError, type ListQueueSlotsResponse, type ListSequenceEnrollmentsData, type ListSequenceEnrollmentsError, type ListSequenceEnrollmentsResponse, type ListSequencesData, type ListSequencesError, type ListSequencesResponse, type ListSmsOptOutsData, type ListSmsOptOutsError, type ListSmsOptOutsResponse, type ListSmsRegistrationsError, type ListSmsRegistrationsResponse, type ListSnapchatProfilesData, type ListSnapchatProfilesError, type ListSnapchatProfilesResponse, type ListTrackingTagSharedAccountsData, type ListTrackingTagSharedAccountsError, type ListTrackingTagSharedAccountsResponse, type ListTrackingTagsData, type ListTrackingTagsError, type ListTrackingTagsResponse, type ListUsersError, type ListUsersResponse, type ListVoiceCallsData, type ListVoiceCallsError, type ListVoiceCallsResponse, type ListWhatsAppCallsData, type ListWhatsAppCallsError, type ListWhatsAppCallsResponse, type ListWhatsAppConversionsData, type ListWhatsAppConversionsError, type ListWhatsAppConversionsResponse, type ListWhatsAppFlowResponsesData, type ListWhatsAppFlowResponsesError, type ListWhatsAppFlowResponsesResponse, type ListWhatsAppFlowVersionsData, type ListWhatsAppFlowVersionsError, type ListWhatsAppFlowVersionsResponse, type ListWhatsAppFlowsData, type ListWhatsAppFlowsError, type ListWhatsAppFlowsResponse, type ListWhatsAppGroupChatsData, type ListWhatsAppGroupChatsError, type ListWhatsAppGroupChatsResponse, type ListWhatsAppGroupJoinRequestsData, type ListWhatsAppGroupJoinRequestsError, type ListWhatsAppGroupJoinRequestsResponse, type ListWhatsAppNumberCountriesError, type ListWhatsAppNumberCountriesResponse, type ListWhatsAppPhoneNumbersData, type ListWhatsAppPhoneNumbersError, type ListWhatsAppPhoneNumbersResponse, type ListWhatsAppSandboxSessionsError, type ListWhatsAppSandboxSessionsResponse, type ListWorkflowExecutionEventsData, type ListWorkflowExecutionEventsError, type ListWorkflowExecutionEventsResponse, type ListWorkflowExecutionsData, type ListWorkflowExecutionsError, type ListWorkflowExecutionsResponse, type ListWorkflowVersionsData, type ListWorkflowVersionsError, type ListWorkflowVersionsResponse, type ListWorkflowsData, type ListWorkflowsError, type ListWorkflowsResponse, type LookupSmsNumberData, type LookupSmsNumberError, type LookupSmsNumberResponse, type MarkConversationReadData, type MarkConversationReadError, type MarkConversationReadResponse, type MediaItem, type MediaUploadResponse, type Money, type MoveAccountToProfileData, type MoveAccountToProfileError, type MoveAccountToProfileResponse, type Pagination, type ParameterLimitParam, type ParameterPageParam, type PauseSequenceData, type PauseSequenceError, type PauseSequenceResponse, type PauseWorkflowData, type PauseWorkflowError, type PauseWorkflowResponse, type PinDiscordMessageData, type PinDiscordMessageError, type PinDiscordMessageResponse, type PinterestPlatformData, type PlatformAnalytics, type PlatformTarget, type Post, type PostAnalytics, type PostCreateResponse, type PostDeleteResponse, type PostGetResponse, type PostRetryResponse, type PostUpdateResponse, type PostsListResponse, type PreviewQueueData, type PreviewQueueError, type PreviewQueueResponse, type Profile, type ProfileCreateResponse, type ProfileDeleteResponse, type ProfileGetResponse, type ProfileUpdateResponse, type ProfilesListResponse, type PublishWhatsAppFlowData, type PublishWhatsAppFlowError, type PublishWhatsAppFlowResponse, type PurchasePhoneNumberData, type PurchasePhoneNumberError, type PurchasePhoneNumberResponse, type PurchaseWhatsAppPhoneNumberData, type PurchaseWhatsAppPhoneNumberError, type PurchaseWhatsAppPhoneNumberResponse, type QueueDeleteResponse, type QueueNextSlotResponse, type QueuePreviewResponse, type QueueSchedule, type QueueSlot, type QueueSlotsResponse, type QueueUpdateResponse, RateLimitError, type RecyclingConfig, type RecyclingState, type RedditPlatformData, type RedditPost, type RejectWhatsAppGroupJoinRequestsData, type RejectWhatsAppGroupJoinRequestsError, type RejectWhatsAppGroupJoinRequestsResponse, type ReleasePhoneNumberData, type ReleasePhoneNumberError, type ReleasePhoneNumberResponse, type ReleaseWhatsAppPhoneNumberData, type ReleaseWhatsAppPhoneNumberError, type ReleaseWhatsAppPhoneNumberResponse, type RemediatePhoneNumberData, type RemediatePhoneNumberError, type RemediatePhoneNumberResponse, type RemediateWhatsAppNumberData, type RemediateWhatsAppNumberError, type RemediateWhatsAppNumberResponse, type RemoveBookmarkData, type RemoveBookmarkError, type RemoveBookmarkResponse, type RemoveConversionAssociationsData, type RemoveConversionAssociationsError, type RemoveConversionAssociationsResponse, type RemoveDiscordMemberRoleData, type RemoveDiscordMemberRoleError, type RemoveDiscordMemberRoleResponse, type RemoveMessageReactionData, type RemoveMessageReactionError, type RemoveMessageReactionResponse, type RemoveTrackingTagSharedAccountData, type RemoveTrackingTagSharedAccountError, type RemoveTrackingTagSharedAccountResponse, type RemoveWhatsAppGroupParticipantsData, type RemoveWhatsAppGroupParticipantsError, type RemoveWhatsAppGroupParticipantsResponse, type ReplyToGoogleBusinessReviewData, type ReplyToGoogleBusinessReviewError, type ReplyToGoogleBusinessReviewResponse, type ReplyToInboxPostData, type ReplyToInboxPostError, type ReplyToInboxPostResponse, type ReplyToInboxReviewData, type ReplyToInboxReviewError, type ReplyToInboxReviewResponse, type RestoreWorkflowVersionData, type RestoreWorkflowVersionError, type RestoreWorkflowVersionResponse, type RetryPostData, type RetryPostError, type RetryPostResponse, type RetweetPostData, type RetweetPostError, type RetweetPostResponse, type ReuseSmsRegistrationForNumberData, type ReuseSmsRegistrationForNumberError, type ReuseSmsRegistrationForNumberResponse, type ReviewPhoneNumberKycPacketData, type ReviewPhoneNumberKycPacketError, type ReviewPhoneNumberKycPacketResponse, type ReviewWebhookReview, type ScheduleBroadcastData, type ScheduleBroadcastError, type ScheduleBroadcastResponse, type SearchAdInterestsData, type SearchAdInterestsError, type SearchAdInterestsResponse, type SearchAdTargetingData, type SearchAdTargetingError, type SearchAdTargetingResponse, type SearchAvailablePhoneNumbersData, type SearchAvailablePhoneNumbersError, type SearchAvailablePhoneNumbersResponse, type SearchAvailableWhatsAppNumbersData, type SearchAvailableWhatsAppNumbersError, type SearchAvailableWhatsAppNumbersResponse, type SearchRedditData, type SearchRedditError, type SearchRedditResponse, type SelectFacebookPageData, type SelectFacebookPageError, type SelectFacebookPageResponse, type SelectGoogleBusinessLocationData, type SelectGoogleBusinessLocationError, type SelectGoogleBusinessLocationResponse, type SelectLinkedInOrganizationData, type SelectLinkedInOrganizationError, type SelectLinkedInOrganizationResponse, type SelectPinterestBoardData, type SelectPinterestBoardError, type SelectPinterestBoardResponse, type SelectSnapchatProfileData, type SelectSnapchatProfileError, type SelectSnapchatProfileResponse, type SendBroadcastData, type SendBroadcastError, type SendBroadcastResponse, type SendConversionsData, type SendConversionsError, type SendConversionsResponse, type SendDiscordDirectMessageData, type SendDiscordDirectMessageError, type SendDiscordDirectMessageResponse, type SendInboxMessageData, type SendInboxMessageError, type SendInboxMessageResponse, type SendPrivateReplyToCommentData, type SendPrivateReplyToCommentError, type SendPrivateReplyToCommentResponse, type SendSmsData, type SendSmsError, type SendSmsResponse, type SendTypingIndicatorData, type SendTypingIndicatorError, type SendTypingIndicatorResponse, type SendWhatsAppConversionData, type SendWhatsAppConversionError, type SendWhatsAppConversionResponse, type SendWhatsAppFlowMessageData, type SendWhatsAppFlowMessageError, type SendWhatsAppFlowMessageResponse, type SetContactFieldValueData, type SetContactFieldValueError, type SetContactFieldValueResponse, type SetInstagramIceBreakersData, type SetInstagramIceBreakersError, type SetInstagramIceBreakersResponse, type SetMessengerMenuData, type SetMessengerMenuError, type SetMessengerMenuResponse, type SetTelegramCommandsData, type SetTelegramCommandsError, type SetTelegramCommandsResponse, type SetWhatsappBusinessUsernameData, type SetWhatsappBusinessUsernameError, type SetWhatsappBusinessUsernameResponse, type ShareSmsRegistrationData, type ShareSmsRegistrationError, type ShareSmsRegistrationResponse, type SharedAdAccount, type SnapchatPlatformData, type SocialAccount, type StartGoogleBusinessVerificationData, type StartGoogleBusinessVerificationError, type StartGoogleBusinessVerificationResponse, type StartSmsRegistrationData, type StartSmsRegistrationError, type StartSmsRegistrationResponse, type SubmitPhoneNumberKycData, type SubmitPhoneNumberKycError, type SubmitPhoneNumberKycResponse, type SubmitWhatsAppNumberKycData, type SubmitWhatsAppNumberKycError, type SubmitWhatsAppNumberKycResponse, type SyncExternalPostsData, type SyncExternalPostsError, type SyncExternalPostsResponse, type TargetingSpec, type TelegramPlatformData, type TestWebhookData, type TestWebhookError, type TestWebhookResponse, type ThreadsPlatformData, type TikTokPlatformData, type TrackingTag, type TransferVoiceCallData, type TransferVoiceCallError, type TransferVoiceCallResponse, type TriggerWorkflowData, type TriggerWorkflowError, type TriggerWorkflowResponse, type TwitterPlatformData, type UnblockWhatsAppUsersData, type UnblockWhatsAppUsersError, type UnblockWhatsAppUsersResponse, type UndoRetweetData, type UndoRetweetError, type UndoRetweetResponse, type UnenrollContactData, type UnenrollContactError, type UnenrollContactResponse, type UnfollowUserData, type UnfollowUserError, type UnfollowUserResponse, type UnhideInboxCommentData, type UnhideInboxCommentError, type UnhideInboxCommentResponse, type UnlikeInboxCommentData, type UnlikeInboxCommentError, type UnlikeInboxCommentResponse, type UnpinDiscordMessageData, type UnpinDiscordMessageError, type UnpinDiscordMessageResponse, type UnpublishPostData, type UnpublishPostError, type UnpublishPostResponse, type UpdateAccountData, type UpdateAccountError, type UpdateAccountGroupData, type UpdateAccountGroupError, type UpdateAccountGroupResponse, type UpdateAccountResponse, type UpdateAdCampaignData, type UpdateAdCampaignError, type UpdateAdCampaignResponse, type UpdateAdCampaignStatusData, type UpdateAdCampaignStatusError, type UpdateAdCampaignStatusResponse, type UpdateAdData, type UpdateAdError, type UpdateAdResponse, type UpdateAdSetData, type UpdateAdSetError, type UpdateAdSetResponse, type UpdateAdSetStatusData, type UpdateAdSetStatusError, type UpdateAdSetStatusResponse, type UpdateAdTrackingTagsData, type UpdateAdTrackingTagsError, type UpdateAdTrackingTagsResponse, type UpdateBroadcastData, type UpdateBroadcastError, type UpdateBroadcastResponse, type UpdateCommentAutomationData, type UpdateCommentAutomationError, type UpdateCommentAutomationResponse, type UpdateContactData, type UpdateContactError, type UpdateContactResponse, type UpdateConversionDestinationData, type UpdateConversionDestinationError, type UpdateConversionDestinationResponse, type UpdateCustomFieldData, type UpdateCustomFieldError, type UpdateCustomFieldResponse, type UpdateDiscordScheduledEventData, type UpdateDiscordScheduledEventError, type UpdateDiscordScheduledEventResponse, type UpdateDiscordSettingsData, type UpdateDiscordSettingsError, type UpdateDiscordSettingsResponse, type UpdateFacebookPageData, type UpdateFacebookPageError, type UpdateFacebookPageResponse, type UpdateGmbLocationData, type UpdateGmbLocationError, type UpdateGmbLocationResponse, type UpdateGoogleBusinessAttributesData, type UpdateGoogleBusinessAttributesError, type UpdateGoogleBusinessAttributesResponse, type UpdateGoogleBusinessFoodMenusData, type UpdateGoogleBusinessFoodMenusError, type UpdateGoogleBusinessFoodMenusResponse, type UpdateGoogleBusinessLocationDetailsData, type UpdateGoogleBusinessLocationDetailsError, type UpdateGoogleBusinessLocationDetailsResponse, type UpdateGoogleBusinessPlaceActionData, type UpdateGoogleBusinessPlaceActionError, type UpdateGoogleBusinessPlaceActionResponse, type UpdateGoogleBusinessServicesData, type UpdateGoogleBusinessServicesError, type UpdateGoogleBusinessServicesResponse, type UpdateInboxConversationData, type UpdateInboxConversationError, type UpdateInboxConversationResponse, type UpdateLinkedInOrganizationData, type UpdateLinkedInOrganizationError, type UpdateLinkedInOrganizationResponse, type UpdatePinterestBoardsData, type UpdatePinterestBoardsError, type UpdatePinterestBoardsResponse, type UpdatePostData, type UpdatePostError, type UpdatePostMetadataData, type UpdatePostMetadataError, type UpdatePostMetadataResponse, type UpdatePostResponse, type UpdateProfileData, type UpdateProfileError, type UpdateProfileResponse, type UpdateQueueSlotData, type UpdateQueueSlotError, type UpdateQueueSlotResponse, type UpdateRedditSubredditsData, type UpdateRedditSubredditsError, type UpdateRedditSubredditsResponse, type UpdateSequenceData, type UpdateSequenceError, type UpdateSequenceResponse, type UpdateTrackingTagData, type UpdateTrackingTagError, type UpdateTrackingTagResponse, type UpdateWebhookSettingsData, type UpdateWebhookSettingsError, type UpdateWebhookSettingsResponse, type UpdateWhatsAppBusinessProfileData, type UpdateWhatsAppBusinessProfileError, type UpdateWhatsAppBusinessProfileResponse, type UpdateWhatsAppCallingData, type UpdateWhatsAppCallingError, type UpdateWhatsAppCallingLegacyData, type UpdateWhatsAppCallingLegacyError, type UpdateWhatsAppCallingLegacyResponse, type UpdateWhatsAppCallingResponse, type UpdateWhatsAppDisplayNameData, type UpdateWhatsAppDisplayNameError, type UpdateWhatsAppDisplayNameResponse, type UpdateWhatsAppFlowData, type UpdateWhatsAppFlowError, type UpdateWhatsAppFlowResponse, type UpdateWhatsAppGroupChatData, type UpdateWhatsAppGroupChatError, type UpdateWhatsAppGroupChatResponse, type UpdateWhatsAppTemplateData, type UpdateWhatsAppTemplateError, type UpdateWhatsAppTemplateResponse, type UpdateWorkflowData, type UpdateWorkflowError, type UpdateWorkflowResponse, type UpdateYoutubeDefaultPlaylistData, type UpdateYoutubeDefaultPlaylistError, type UpdateYoutubeDefaultPlaylistResponse, type UploadMediaDirectData, type UploadMediaDirectError, type UploadMediaDirectResponse, type UploadPhoneNumberKycDocumentData, type UploadPhoneNumberKycDocumentError, type UploadPhoneNumberKycDocumentResponse, type UploadPhoneNumberPortInDocumentData, type UploadPhoneNumberPortInDocumentError, type UploadPhoneNumberPortInDocumentResponse, type UploadTokenResponse, type UploadTokenStatusResponse, type UploadWhatsAppFlowJsonData, type UploadWhatsAppFlowJsonError, type UploadWhatsAppFlowJsonResponse, type UploadWhatsAppNumberKycDocumentData, type UploadWhatsAppNumberKycDocumentError, type UploadWhatsAppNumberKycDocumentResponse, type UploadWhatsAppProfilePhotoData, type UploadWhatsAppProfilePhotoError, type UploadWhatsAppProfilePhotoResponse, type UploadedFile, type UsageStats, type User, type UserGetResponse, type UsersListResponse, type ValidateMediaData, type ValidateMediaError, type ValidateMediaResponse, type ValidatePhoneNumberKycAddressData, type ValidatePhoneNumberKycAddressError, type ValidatePhoneNumberKycAddressResponse, type ValidatePostData, type ValidatePostError, type ValidatePostLengthData, type ValidatePostLengthError, type ValidatePostLengthResponse, type ValidatePostResponse, type ValidateSubredditData, type ValidateSubredditError, type ValidateSubredditResponse, type ValidateWhatsAppNumberKycAddressData, type ValidateWhatsAppNumberKycAddressError, type ValidateWhatsAppNumberKycAddressResponse, ValidationError, type VerifySmsRegistrationOtpData, type VerifySmsRegistrationOtpError, type VerifySmsRegistrationOtpResponse, type Webhook, type WebhookLog, type WebhookPayloadAccountAdsInitialSyncCompleted, type WebhookPayloadAccountConnected, type WebhookPayloadAccountDisconnected, type WebhookPayloadAdStatusChanged, type WebhookPayloadCallEnded, type WebhookPayloadCallFailed, type WebhookPayloadCallPermissionRequest, type WebhookPayloadCallReceived, type WebhookPayloadComment, type WebhookPayloadConversationStarted, type WebhookPayloadExternalPost, type WebhookPayloadLead, type WebhookPayloadMessage, type WebhookPayloadMessageDeleted, type WebhookPayloadMessageDeliveryStatus, type WebhookPayloadMessageEdited, type WebhookPayloadMessageSent, type WebhookPayloadPost, type WebhookPayloadPostPlatform, type WebhookPayloadReaction, type WebhookPayloadReviewNew, type WebhookPayloadReviewUpdated, type WebhookPayloadTest, type WebhookPayloadWhatsAppTemplateStatusUpdated, type WhatsAppBodyComponent, type WhatsAppButtonsComponent, type WhatsAppFooterComponent, type WhatsAppHeaderComponent, type WhatsAppSandboxSession, type WhatsAppTemplateButton, type WhatsAppTemplateComponent, type WorkflowEdge, type WorkflowExecutionEvent, type WorkflowNode, type XApiOperation, type XApiPricing, type YouTubeDailyViewsResponse, type YouTubeDemographicsResponse, type YouTubePlatformData, type YouTubeScopeMissingResponse, type YouTubeVideoRetentionResponse, Zernio, ZernioApiError, type action, type action2, type actionSource, type adType, type adType2, type adType3, type aggregation, type aggregation2, type autoArchiveDuration, type billingPeriod, type billingSystem, type budgetLevel, type channel, type commercialContentType, type contentType, type contentType2, type contentType3, Zernio as default, type direction, type direction2, type disconnectionType, type endReason, type entity_type, type errorCategory, type errorCategory2, type errorSource, type event, type event10, type event11, type event12, type event13, type event14, type event15, type event16, type event17, type event18, type event19, type event2, type event20, type event21, type event22, type event23, type event24, type event3, type event4, type event5, type event6, type event7, type event8, type event9, type format, type forwardCallerId, type gapFreq, type gender, type goal, type graduationStrategy, type incomeTier, type interactiveType, type kind, type level, type mediaType, type mediaType2, type metric, type metricType, type offerType, type otp_type, parseApiError, type parseMode, type permission, type platform, type platform10, type platform2, type platform3, type platform4, type platform5, type platform6, type platform7, type platform8, type platform9, type privacy_level, type replySettings, type response, type reviewStatus, type scope, type source, type status, type status10, type status11, type status12, type status13, type status2, type status3, type status4, type status5, type status6, type status7, type status8, type status9, type syncStatus, type syncStatus2, type timeframe, type topicType, type transcriptionLanguage, type trialGraduationStrategy, type type, type type2, type type3, type type4, type type5, type type6, type type7, type type8, type type9, type visibility };
|