@zernio/node 0.2.310 → 0.2.312
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 +2498 -463
- package/dist/index.d.ts +2498 -463
- 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 +2612 -488
package/dist/index.d.mts
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
|
*/
|
|
@@ -2578,6 +2787,10 @@ type InboxWebhookAccount = {
|
|
|
2578
2787
|
* Social account ID (same value as id). Canonical field so consumers can filter every webhook event on one field (e.g. route staging vs production by account). id is kept for backward compatibility.
|
|
2579
2788
|
*/
|
|
2580
2789
|
accountId?: string;
|
|
2790
|
+
/**
|
|
2791
|
+
* Zernio profile (workspace) ID this account belongs to. Use it to route or filter inbox webhooks by workspace. This is the profile ID only, not its name (resolve the name via the API with this ID). Optional; omitted on the shared WhatsApp sandbox account and when the account has no resolvable profile.
|
|
2792
|
+
*/
|
|
2793
|
+
profileId?: string;
|
|
2581
2794
|
platform: string;
|
|
2582
2795
|
username: string;
|
|
2583
2796
|
displayName?: string;
|
|
@@ -2604,7 +2817,7 @@ type InboxWebhookConversation = {
|
|
|
2604
2817
|
*/
|
|
2605
2818
|
contactId?: string;
|
|
2606
2819
|
};
|
|
2607
|
-
type
|
|
2820
|
+
type status5 = 'active' | 'archived';
|
|
2608
2821
|
/**
|
|
2609
2822
|
* The message object included in inbox webhook payloads.
|
|
2610
2823
|
*/
|
|
@@ -2710,7 +2923,7 @@ type InboxWebhookMessage = {
|
|
|
2710
2923
|
isRead: boolean;
|
|
2711
2924
|
};
|
|
2712
2925
|
type platform2 = 'instagram' | 'facebook' | 'telegram' | 'whatsapp';
|
|
2713
|
-
type
|
|
2926
|
+
type direction2 = 'incoming' | 'outgoing';
|
|
2714
2927
|
/**
|
|
2715
2928
|
* Shared account-insights response envelope used by every platform-level
|
|
2716
2929
|
* analytics endpoint (/v1/analytics/{facebook|instagram|youtube|linkedin|tiktok}*).
|
|
@@ -3129,7 +3342,7 @@ type PlatformAnalytics = {
|
|
|
3129
3342
|
*/
|
|
3130
3343
|
errorMessage?: (string) | null;
|
|
3131
3344
|
};
|
|
3132
|
-
type
|
|
3345
|
+
type status6 = 'published' | 'failed';
|
|
3133
3346
|
/**
|
|
3134
3347
|
* Sync state of analytics for this platform
|
|
3135
3348
|
*/
|
|
@@ -3245,7 +3458,7 @@ type Post = {
|
|
|
3245
3458
|
createdAt?: string;
|
|
3246
3459
|
updatedAt?: string;
|
|
3247
3460
|
};
|
|
3248
|
-
type
|
|
3461
|
+
type status7 = 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
|
|
3249
3462
|
type visibility = 'public' | 'private' | 'unlisted';
|
|
3250
3463
|
type PostAnalytics = {
|
|
3251
3464
|
impressions?: number;
|
|
@@ -4237,7 +4450,7 @@ type UploadTokenResponse = {
|
|
|
4237
4450
|
expiresAt?: string;
|
|
4238
4451
|
status?: 'pending' | 'completed' | 'expired';
|
|
4239
4452
|
};
|
|
4240
|
-
type
|
|
4453
|
+
type status8 = 'pending' | 'completed' | 'expired';
|
|
4241
4454
|
type UploadTokenStatusResponse = {
|
|
4242
4455
|
token?: string;
|
|
4243
4456
|
status?: 'pending' | 'completed' | 'expired';
|
|
@@ -4506,7 +4719,7 @@ type WebhookLog = {
|
|
|
4506
4719
|
/**
|
|
4507
4720
|
* Delivery outcome
|
|
4508
4721
|
*/
|
|
4509
|
-
type
|
|
4722
|
+
type status9 = 'success' | 'failed';
|
|
4510
4723
|
/**
|
|
4511
4724
|
* Webhook payload for `account.ads.initial_sync_completed` events.
|
|
4512
4725
|
* Fired once per ads-enabled account when the initial discovery + 90-day
|
|
@@ -4612,7 +4825,7 @@ type event = 'account.ads.initial_sync_completed';
|
|
|
4612
4825
|
/**
|
|
4613
4826
|
* Overall outcome of the initial sync.
|
|
4614
4827
|
*/
|
|
4615
|
-
type
|
|
4828
|
+
type status10 = 'success' | 'failure';
|
|
4616
4829
|
/**
|
|
4617
4830
|
* Stable category for UX branching. New values may be added; existing ones are
|
|
4618
4831
|
* stable. Mapping:
|
|
@@ -4851,8 +5064,6 @@ type WebhookPayloadCallEnded = {
|
|
|
4851
5064
|
timestamp: string;
|
|
4852
5065
|
};
|
|
4853
5066
|
type event5 = 'call.ended';
|
|
4854
|
-
type direction2 = 'inbound' | 'outbound';
|
|
4855
|
-
type endReason = 'hangup' | 'no_answer' | 'rejected' | 'error';
|
|
4856
5067
|
/**
|
|
4857
5068
|
* Webhook payload for the `call.failed` event. Fired when a call
|
|
4858
5069
|
* setup or in-progress call fails.
|
|
@@ -5941,7 +6152,7 @@ type platform10 = 'whatsapp';
|
|
|
5941
6152
|
* request before the template is actually removed.
|
|
5942
6153
|
*
|
|
5943
6154
|
*/
|
|
5944
|
-
type
|
|
6155
|
+
type status11 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
5945
6156
|
type WhatsAppBodyComponent = {
|
|
5946
6157
|
type: 'body';
|
|
5947
6158
|
/**
|
|
@@ -6035,7 +6246,7 @@ type WhatsAppSandboxSession = {
|
|
|
6035
6246
|
* list responses.
|
|
6036
6247
|
*
|
|
6037
6248
|
*/
|
|
6038
|
-
type
|
|
6249
|
+
type status12 = 'pending' | 'active';
|
|
6039
6250
|
type WhatsAppTemplateButton = {
|
|
6040
6251
|
type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
6041
6252
|
/**
|
|
@@ -6146,7 +6357,7 @@ type WorkflowExecutionEvent = {
|
|
|
6146
6357
|
at?: string;
|
|
6147
6358
|
};
|
|
6148
6359
|
type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
6149
|
-
type
|
|
6360
|
+
type status13 = 'success' | 'failed' | 'pending';
|
|
6150
6361
|
/**
|
|
6151
6362
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
6152
6363
|
*/
|
|
@@ -7953,6 +8164,23 @@ type GetXApiPricingResponse = (XApiPricing);
|
|
|
7953
8164
|
type GetXApiPricingError = ({
|
|
7954
8165
|
error?: string;
|
|
7955
8166
|
});
|
|
8167
|
+
type GetUsageData = {
|
|
8168
|
+
query?: {
|
|
8169
|
+
/**
|
|
8170
|
+
* For Stripe subscription users, `true` forces a subscription
|
|
8171
|
+
* reconciliation pass even when cached plan data looks complete.
|
|
8172
|
+
* Omit the parameter, or pass `false`, to use the default
|
|
8173
|
+
* first-time-only reconciliation behavior. Invalid boolean values are
|
|
8174
|
+
* rejected.
|
|
8175
|
+
*
|
|
8176
|
+
*/
|
|
8177
|
+
reconcile?: boolean;
|
|
8178
|
+
};
|
|
8179
|
+
};
|
|
8180
|
+
type GetUsageResponse = (UsageStats);
|
|
8181
|
+
type GetUsageError = (unknown | {
|
|
8182
|
+
error?: string;
|
|
8183
|
+
});
|
|
7956
8184
|
type GetUsageStatsData = {
|
|
7957
8185
|
query?: {
|
|
7958
8186
|
/**
|
|
@@ -7970,6 +8198,101 @@ type GetUsageStatsResponse = (UsageStats);
|
|
|
7970
8198
|
type GetUsageStatsError = (unknown | {
|
|
7971
8199
|
error?: string;
|
|
7972
8200
|
});
|
|
8201
|
+
type GetCallsUsageData = {
|
|
8202
|
+
query?: {
|
|
8203
|
+
channel?: 'whatsapp' | 'pstn';
|
|
8204
|
+
groupBy?: 'day' | 'number' | 'channel';
|
|
8205
|
+
/**
|
|
8206
|
+
* Scope to calls involving this number (typically one of YOUR numbers). E.164, leading + optional.
|
|
8207
|
+
*/
|
|
8208
|
+
number?: string;
|
|
8209
|
+
/**
|
|
8210
|
+
* Start of the window (inclusive). Default 30 days before `until`.
|
|
8211
|
+
*/
|
|
8212
|
+
since?: string;
|
|
8213
|
+
/**
|
|
8214
|
+
* End of the window (exclusive). Default now.
|
|
8215
|
+
*/
|
|
8216
|
+
until?: string;
|
|
8217
|
+
};
|
|
8218
|
+
};
|
|
8219
|
+
type GetCallsUsageResponse = ({
|
|
8220
|
+
since?: string;
|
|
8221
|
+
until?: string;
|
|
8222
|
+
groupBy?: ('day' | 'number' | 'channel') | null;
|
|
8223
|
+
totals?: {
|
|
8224
|
+
calls?: number;
|
|
8225
|
+
answered?: number;
|
|
8226
|
+
minutes?: number;
|
|
8227
|
+
/**
|
|
8228
|
+
* What Zernio bills for these calls.
|
|
8229
|
+
*/
|
|
8230
|
+
billableUSD?: number;
|
|
8231
|
+
/**
|
|
8232
|
+
* WhatsApp only: Meta's per-minute charge, billed by Meta directly to your WABA. Display only.
|
|
8233
|
+
*/
|
|
8234
|
+
metaUSD?: number;
|
|
8235
|
+
};
|
|
8236
|
+
/**
|
|
8237
|
+
* Present (possibly empty) when `groupBy` is set.
|
|
8238
|
+
*/
|
|
8239
|
+
groups?: Array<{
|
|
8240
|
+
/**
|
|
8241
|
+
* The group key: a `YYYY-MM-DD` UTC day, one of your numbers, or a channel.
|
|
8242
|
+
*/
|
|
8243
|
+
key?: string;
|
|
8244
|
+
calls?: number;
|
|
8245
|
+
answered?: number;
|
|
8246
|
+
minutes?: number;
|
|
8247
|
+
billableUSD?: number;
|
|
8248
|
+
metaUSD?: number;
|
|
8249
|
+
}>;
|
|
8250
|
+
});
|
|
8251
|
+
type GetCallsUsageError = (unknown | {
|
|
8252
|
+
error?: string;
|
|
8253
|
+
});
|
|
8254
|
+
type GetSmsUsageData = {
|
|
8255
|
+
query?: {
|
|
8256
|
+
groupBy?: 'day' | 'number';
|
|
8257
|
+
/**
|
|
8258
|
+
* Scope to one of YOUR SMS-enabled numbers (E.164, leading + optional).
|
|
8259
|
+
*/
|
|
8260
|
+
number?: string;
|
|
8261
|
+
/**
|
|
8262
|
+
* Start of the window (inclusive). Default 30 days before `until`.
|
|
8263
|
+
*/
|
|
8264
|
+
since?: string;
|
|
8265
|
+
/**
|
|
8266
|
+
* End of the window (exclusive). Default now.
|
|
8267
|
+
*/
|
|
8268
|
+
until?: string;
|
|
8269
|
+
};
|
|
8270
|
+
};
|
|
8271
|
+
type GetSmsUsageResponse = ({
|
|
8272
|
+
since?: string;
|
|
8273
|
+
until?: string;
|
|
8274
|
+
groupBy?: ('day' | 'number') | null;
|
|
8275
|
+
totals?: {
|
|
8276
|
+
sent?: number;
|
|
8277
|
+
received?: number;
|
|
8278
|
+
total?: number;
|
|
8279
|
+
};
|
|
8280
|
+
/**
|
|
8281
|
+
* Present (possibly empty) when `groupBy` is set.
|
|
8282
|
+
*/
|
|
8283
|
+
groups?: Array<{
|
|
8284
|
+
/**
|
|
8285
|
+
* A `YYYY-MM-DD` UTC day or one of your numbers.
|
|
8286
|
+
*/
|
|
8287
|
+
key?: string;
|
|
8288
|
+
sent?: number;
|
|
8289
|
+
received?: number;
|
|
8290
|
+
total?: number;
|
|
8291
|
+
}>;
|
|
8292
|
+
});
|
|
8293
|
+
type GetSmsUsageError = (unknown | {
|
|
8294
|
+
error?: string;
|
|
8295
|
+
});
|
|
7973
8296
|
type ListPostsData = {
|
|
7974
8297
|
query?: {
|
|
7975
8298
|
/**
|
|
@@ -14883,7 +15206,7 @@ type GetWhatsAppCallingConfigData = {
|
|
|
14883
15206
|
};
|
|
14884
15207
|
type GetWhatsAppCallingConfigResponse = ({
|
|
14885
15208
|
/**
|
|
14886
|
-
*
|
|
15209
|
+
* Phone number record ID (use on /v1/phone-numbers/{id}/whatsapp/calling)
|
|
14887
15210
|
*/
|
|
14888
15211
|
phoneNumberDocId?: string;
|
|
14889
15212
|
phoneNumber?: string;
|
|
@@ -14907,7 +15230,7 @@ type GetWhatsAppCallingConfigResponse = ({
|
|
|
14907
15230
|
type GetWhatsAppCallingConfigError = ({
|
|
14908
15231
|
error?: string;
|
|
14909
15232
|
} | unknown);
|
|
14910
|
-
type
|
|
15233
|
+
type EnableWhatsAppCallingLegacyData = {
|
|
14911
15234
|
body: {
|
|
14912
15235
|
accountId: string;
|
|
14913
15236
|
/**
|
|
@@ -14929,16 +15252,16 @@ type EnableWhatsAppCallingData = {
|
|
|
14929
15252
|
id: string;
|
|
14930
15253
|
};
|
|
14931
15254
|
};
|
|
14932
|
-
type
|
|
15255
|
+
type EnableWhatsAppCallingLegacyResponse = ({
|
|
14933
15256
|
success?: boolean;
|
|
14934
15257
|
callingEnabled?: boolean;
|
|
14935
15258
|
sipHostname?: string;
|
|
14936
15259
|
forwardTo?: string;
|
|
14937
15260
|
});
|
|
14938
|
-
type
|
|
15261
|
+
type EnableWhatsAppCallingLegacyError = ({
|
|
14939
15262
|
error?: string;
|
|
14940
15263
|
} | unknown);
|
|
14941
|
-
type
|
|
15264
|
+
type UpdateWhatsAppCallingLegacyData = {
|
|
14942
15265
|
body: {
|
|
14943
15266
|
accountId: string;
|
|
14944
15267
|
forwardTo?: string;
|
|
@@ -14951,11 +15274,11 @@ type UpdateWhatsAppCallingData = {
|
|
|
14951
15274
|
id: string;
|
|
14952
15275
|
};
|
|
14953
15276
|
};
|
|
14954
|
-
type
|
|
14955
|
-
type
|
|
15277
|
+
type UpdateWhatsAppCallingLegacyResponse = (unknown);
|
|
15278
|
+
type UpdateWhatsAppCallingLegacyError = ({
|
|
14956
15279
|
error?: string;
|
|
14957
15280
|
} | unknown);
|
|
14958
|
-
type
|
|
15281
|
+
type DisableWhatsAppCallingLegacyData = {
|
|
14959
15282
|
path: {
|
|
14960
15283
|
id: string;
|
|
14961
15284
|
};
|
|
@@ -14963,8 +15286,8 @@ type DisableWhatsAppCallingData = {
|
|
|
14963
15286
|
accountId: string;
|
|
14964
15287
|
};
|
|
14965
15288
|
};
|
|
14966
|
-
type
|
|
14967
|
-
type
|
|
15289
|
+
type DisableWhatsAppCallingLegacyResponse = (unknown);
|
|
15290
|
+
type DisableWhatsAppCallingLegacyError = ({
|
|
14968
15291
|
error?: string;
|
|
14969
15292
|
} | unknown);
|
|
14970
15293
|
type GetWhatsAppCallPermissionsData = {
|
|
@@ -15022,6 +15345,12 @@ type InitiateWhatsAppCallData = {
|
|
|
15022
15345
|
*/
|
|
15023
15346
|
biz_opaque_callback_data?: string;
|
|
15024
15347
|
};
|
|
15348
|
+
headers?: {
|
|
15349
|
+
/**
|
|
15350
|
+
* 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.
|
|
15351
|
+
*/
|
|
15352
|
+
'Idempotency-Key'?: string;
|
|
15353
|
+
};
|
|
15025
15354
|
};
|
|
15026
15355
|
type InitiateWhatsAppCallResponse = ({
|
|
15027
15356
|
success?: boolean;
|
|
@@ -15045,6 +15374,10 @@ type InitiateWhatsAppCallError = ({
|
|
|
15045
15374
|
type ListWhatsAppCallsData = {
|
|
15046
15375
|
query: {
|
|
15047
15376
|
accountId: string;
|
|
15377
|
+
/**
|
|
15378
|
+
* Return calls with startedAt strictly before this instant (use the previous page's nextCursor).
|
|
15379
|
+
*/
|
|
15380
|
+
before?: string;
|
|
15048
15381
|
direction?: 'inbound' | 'outbound';
|
|
15049
15382
|
limit?: number;
|
|
15050
15383
|
since?: string;
|
|
@@ -15082,6 +15415,10 @@ type ListWhatsAppCallsResponse = ({
|
|
|
15082
15415
|
currency?: string;
|
|
15083
15416
|
};
|
|
15084
15417
|
}>;
|
|
15418
|
+
/**
|
|
15419
|
+
* Pass as `before` for the next page; null on the last page.
|
|
15420
|
+
*/
|
|
15421
|
+
nextCursor?: (string) | null;
|
|
15085
15422
|
});
|
|
15086
15423
|
type ListWhatsAppCallsError = ({
|
|
15087
15424
|
error?: string;
|
|
@@ -15102,6 +15439,24 @@ type GetWhatsAppCallResponse = ({
|
|
|
15102
15439
|
type GetWhatsAppCallError = ({
|
|
15103
15440
|
error?: string;
|
|
15104
15441
|
} | unknown);
|
|
15442
|
+
type GetWhatsAppCallRecordingData = {
|
|
15443
|
+
path: {
|
|
15444
|
+
callId: string;
|
|
15445
|
+
};
|
|
15446
|
+
query: {
|
|
15447
|
+
accountId: string;
|
|
15448
|
+
/**
|
|
15449
|
+
* `json` returns `{ url }` instead of a 302 redirect.
|
|
15450
|
+
*/
|
|
15451
|
+
as?: 'json';
|
|
15452
|
+
};
|
|
15453
|
+
};
|
|
15454
|
+
type GetWhatsAppCallRecordingResponse = ({
|
|
15455
|
+
url?: string;
|
|
15456
|
+
});
|
|
15457
|
+
type GetWhatsAppCallRecordingError = (unknown | {
|
|
15458
|
+
error?: string;
|
|
15459
|
+
});
|
|
15105
15460
|
type GetWhatsAppCallEstimateData = {
|
|
15106
15461
|
query: {
|
|
15107
15462
|
accountId: string;
|
|
@@ -15134,696 +15489,2097 @@ type GetWhatsAppCallEstimateResponse = ({
|
|
|
15134
15489
|
type GetWhatsAppCallEstimateError = ({
|
|
15135
15490
|
error?: string;
|
|
15136
15491
|
});
|
|
15137
|
-
type
|
|
15138
|
-
query
|
|
15492
|
+
type ListCallsData = {
|
|
15493
|
+
query?: {
|
|
15139
15494
|
/**
|
|
15140
|
-
*
|
|
15495
|
+
* Return calls with startedAt strictly before this instant (use the previous page's nextCursor).
|
|
15141
15496
|
*/
|
|
15142
|
-
|
|
15497
|
+
before?: string;
|
|
15498
|
+
channel?: 'whatsapp' | 'pstn';
|
|
15499
|
+
direction?: 'inbound' | 'outbound';
|
|
15500
|
+
limit?: number;
|
|
15143
15501
|
/**
|
|
15144
|
-
* Exact
|
|
15502
|
+
* Exact filter: calls involving this number (typically one of YOUR numbers, to scope history to a single line). E.164, leading + optional.
|
|
15145
15503
|
*/
|
|
15146
|
-
|
|
15504
|
+
number?: string;
|
|
15505
|
+
/**
|
|
15506
|
+
* Free-text match on the from/to numbers. Non-digits are stripped, so partial queries like `302` or `+1 302` work.
|
|
15507
|
+
*/
|
|
15508
|
+
search?: string;
|
|
15509
|
+
status?: 'ringing' | 'answered' | 'ended' | 'failed';
|
|
15147
15510
|
};
|
|
15148
15511
|
};
|
|
15149
|
-
type
|
|
15150
|
-
|
|
15151
|
-
name?: string;
|
|
15152
|
-
language?: string;
|
|
15153
|
-
category?: string;
|
|
15154
|
-
body?: string;
|
|
15155
|
-
body_params?: Array<(string)>;
|
|
15156
|
-
buttons?: Array<{
|
|
15157
|
-
/**
|
|
15158
|
-
* QUICK_REPLY, URL, PHONE_NUMBER, OTP, FLOW, ...
|
|
15159
|
-
*/
|
|
15160
|
-
type?: string;
|
|
15161
|
-
text?: string;
|
|
15162
|
-
}>;
|
|
15163
|
-
} | null;
|
|
15164
|
-
});
|
|
15165
|
-
type GetWhatsAppLibraryTemplateError = (unknown | {
|
|
15166
|
-
error?: string;
|
|
15167
|
-
});
|
|
15168
|
-
type GetWhatsAppBusinessProfileData = {
|
|
15169
|
-
query: {
|
|
15512
|
+
type ListCallsResponse = ({
|
|
15513
|
+
calls?: Array<(CallRecord & {
|
|
15170
15514
|
/**
|
|
15171
|
-
*
|
|
15515
|
+
* CRM contact name for the counterparty, when resolved.
|
|
15172
15516
|
*/
|
|
15173
|
-
|
|
15517
|
+
contactName?: string;
|
|
15518
|
+
})>;
|
|
15519
|
+
/**
|
|
15520
|
+
* Pass as `before` for the next page; null on the last page.
|
|
15521
|
+
*/
|
|
15522
|
+
nextCursor?: (string) | null;
|
|
15523
|
+
});
|
|
15524
|
+
type ListCallsError = ({
|
|
15525
|
+
error?: string;
|
|
15526
|
+
} | unknown);
|
|
15527
|
+
type GetCallData = {
|
|
15528
|
+
path: {
|
|
15529
|
+
id: string;
|
|
15174
15530
|
};
|
|
15175
15531
|
};
|
|
15176
|
-
type
|
|
15177
|
-
|
|
15178
|
-
businessProfile?: {
|
|
15532
|
+
type GetCallResponse = ({
|
|
15533
|
+
call?: (CallRecord & {
|
|
15179
15534
|
/**
|
|
15180
|
-
*
|
|
15535
|
+
* CRM contact name for the counterparty, when resolved.
|
|
15181
15536
|
*/
|
|
15182
|
-
|
|
15183
|
-
|
|
15537
|
+
contactName?: string;
|
|
15538
|
+
});
|
|
15539
|
+
});
|
|
15540
|
+
type GetCallError = ({
|
|
15541
|
+
error?: string;
|
|
15542
|
+
} | unknown);
|
|
15543
|
+
type GetCallRecordingData = {
|
|
15544
|
+
path: {
|
|
15545
|
+
id: string;
|
|
15546
|
+
};
|
|
15547
|
+
query?: {
|
|
15184
15548
|
/**
|
|
15185
|
-
*
|
|
15549
|
+
* `json` returns `{ url }` instead of a 302 redirect.
|
|
15186
15550
|
*/
|
|
15187
|
-
|
|
15188
|
-
email?: string;
|
|
15189
|
-
profilePictureUrl?: string;
|
|
15190
|
-
websites?: Array<(string)>;
|
|
15191
|
-
/**
|
|
15192
|
-
* Business category
|
|
15193
|
-
*/
|
|
15194
|
-
vertical?: string;
|
|
15551
|
+
as?: 'json';
|
|
15195
15552
|
};
|
|
15553
|
+
};
|
|
15554
|
+
type GetCallRecordingResponse = ({
|
|
15555
|
+
url?: string;
|
|
15196
15556
|
});
|
|
15197
|
-
type
|
|
15557
|
+
type GetCallRecordingError = (unknown | {
|
|
15198
15558
|
error?: string;
|
|
15199
15559
|
});
|
|
15200
|
-
type
|
|
15560
|
+
type CreateVoiceCallData = {
|
|
15201
15561
|
body: {
|
|
15202
15562
|
/**
|
|
15203
|
-
*
|
|
15563
|
+
* Destination to dial, E.164 with leading +.
|
|
15204
15564
|
*/
|
|
15205
|
-
|
|
15565
|
+
to: string;
|
|
15206
15566
|
/**
|
|
15207
|
-
*
|
|
15567
|
+
* Which of your voice-enabled numbers to dial from. Optional when you have exactly one.
|
|
15208
15568
|
*/
|
|
15209
|
-
|
|
15569
|
+
fromNumber?: string;
|
|
15210
15570
|
/**
|
|
15211
|
-
*
|
|
15571
|
+
* Per-call agent override (tel:+E164, sip:..., or wss://...); defaults to the number's stored forward destination.
|
|
15212
15572
|
*/
|
|
15213
|
-
|
|
15573
|
+
forwardTo?: string;
|
|
15214
15574
|
/**
|
|
15215
|
-
*
|
|
15575
|
+
* Spoken to the callee when they answer, before the bridge.
|
|
15216
15576
|
*/
|
|
15217
|
-
|
|
15577
|
+
greeting?: string;
|
|
15218
15578
|
/**
|
|
15219
|
-
*
|
|
15579
|
+
* Per-call recording toggle; defaults to the number's setting.
|
|
15220
15580
|
*/
|
|
15221
|
-
|
|
15581
|
+
recordOverride?: boolean;
|
|
15222
15582
|
/**
|
|
15223
|
-
*
|
|
15583
|
+
* Per-call transcription toggle; defaults to the number's setting.
|
|
15224
15584
|
*/
|
|
15225
|
-
|
|
15585
|
+
transcribeOverride?: boolean;
|
|
15226
15586
|
/**
|
|
15227
|
-
*
|
|
15587
|
+
* 'auto' derives from the callee's country; 'en'/'es' force it.
|
|
15228
15588
|
*/
|
|
15229
|
-
|
|
15589
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
15230
15590
|
/**
|
|
15231
|
-
*
|
|
15591
|
+
* A retry with the same key returns the original call instead of dialing again.
|
|
15232
15592
|
*/
|
|
15233
|
-
|
|
15593
|
+
idempotencyKey?: string;
|
|
15594
|
+
/**
|
|
15595
|
+
* Answering-machine detection; defers the bridge until human vs machine is known.
|
|
15596
|
+
*/
|
|
15597
|
+
amd?: boolean;
|
|
15598
|
+
/**
|
|
15599
|
+
* Spoken to a detected machine, then hang up (implies `amd`). For outbound voicemail drops.
|
|
15600
|
+
*/
|
|
15601
|
+
voicemailDropMessage?: string;
|
|
15602
|
+
};
|
|
15603
|
+
headers?: {
|
|
15604
|
+
/**
|
|
15605
|
+
* 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.
|
|
15606
|
+
*/
|
|
15607
|
+
'Idempotency-Key'?: string;
|
|
15234
15608
|
};
|
|
15235
15609
|
};
|
|
15236
|
-
type
|
|
15610
|
+
type CreateVoiceCallResponse = ({
|
|
15237
15611
|
success?: boolean;
|
|
15238
|
-
|
|
15612
|
+
/**
|
|
15613
|
+
* Internal Call doc ID
|
|
15614
|
+
*/
|
|
15615
|
+
callId?: string;
|
|
15616
|
+
telnyxCallControlId?: string;
|
|
15617
|
+
status?: 'dialing';
|
|
15618
|
+
direction?: 'outbound';
|
|
15619
|
+
from?: string;
|
|
15620
|
+
to?: string;
|
|
15621
|
+
forwardTo?: string;
|
|
15622
|
+
greeting?: (string) | null;
|
|
15623
|
+
recordingEnabled?: boolean;
|
|
15624
|
+
transcriptionEnabled?: boolean;
|
|
15625
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
15239
15626
|
});
|
|
15240
|
-
type
|
|
15627
|
+
type CreateVoiceCallError = ({
|
|
15241
15628
|
error?: string;
|
|
15242
|
-
});
|
|
15243
|
-
type
|
|
15244
|
-
|
|
15245
|
-
|
|
15246
|
-
|
|
15247
|
-
|
|
15248
|
-
accountId: string;
|
|
15629
|
+
} | unknown);
|
|
15630
|
+
type ListVoiceCallsData = {
|
|
15631
|
+
query?: {
|
|
15632
|
+
before?: string;
|
|
15633
|
+
direction?: 'inbound' | 'outbound';
|
|
15634
|
+
limit?: number;
|
|
15249
15635
|
/**
|
|
15250
|
-
*
|
|
15636
|
+
* Exact filter: calls involving this number (typically one of your DIDs). E.164, leading + optional.
|
|
15251
15637
|
*/
|
|
15252
|
-
|
|
15638
|
+
number?: string;
|
|
15639
|
+
status?: 'ringing' | 'answered' | 'ended' | 'failed';
|
|
15253
15640
|
};
|
|
15254
15641
|
};
|
|
15255
|
-
type
|
|
15256
|
-
|
|
15257
|
-
|
|
15642
|
+
type ListVoiceCallsResponse = ({
|
|
15643
|
+
calls?: Array<CallRecord>;
|
|
15644
|
+
nextCursor?: (string) | null;
|
|
15258
15645
|
});
|
|
15259
|
-
type
|
|
15646
|
+
type ListVoiceCallsError = ({
|
|
15260
15647
|
error?: string;
|
|
15261
15648
|
});
|
|
15262
|
-
type
|
|
15263
|
-
|
|
15264
|
-
|
|
15265
|
-
* WhatsApp social account ID
|
|
15266
|
-
*/
|
|
15267
|
-
accountId: string;
|
|
15649
|
+
type GetVoiceCallData = {
|
|
15650
|
+
path: {
|
|
15651
|
+
id: string;
|
|
15268
15652
|
};
|
|
15269
15653
|
};
|
|
15270
|
-
type
|
|
15654
|
+
type GetVoiceCallResponse = ({
|
|
15655
|
+
call?: CallRecord;
|
|
15656
|
+
});
|
|
15657
|
+
type GetVoiceCallError = ({
|
|
15658
|
+
error?: string;
|
|
15659
|
+
} | unknown);
|
|
15660
|
+
type EndVoiceCallData = {
|
|
15661
|
+
path: {
|
|
15662
|
+
id: string;
|
|
15663
|
+
};
|
|
15664
|
+
};
|
|
15665
|
+
type EndVoiceCallResponse = ({
|
|
15271
15666
|
success?: boolean;
|
|
15272
|
-
|
|
15273
|
-
|
|
15274
|
-
|
|
15275
|
-
|
|
15276
|
-
|
|
15277
|
-
|
|
15278
|
-
|
|
15279
|
-
|
|
15280
|
-
|
|
15667
|
+
callId?: string;
|
|
15668
|
+
/**
|
|
15669
|
+
* `ending` when a hangup was issued; otherwise the call's current status.
|
|
15670
|
+
*/
|
|
15671
|
+
status?: string;
|
|
15672
|
+
});
|
|
15673
|
+
type EndVoiceCallError = ({
|
|
15674
|
+
error?: string;
|
|
15675
|
+
} | unknown);
|
|
15676
|
+
type GetVoiceCallRecordingData = {
|
|
15677
|
+
path: {
|
|
15678
|
+
id: string;
|
|
15679
|
+
};
|
|
15680
|
+
query?: {
|
|
15281
15681
|
/**
|
|
15282
|
-
*
|
|
15682
|
+
* `json` returns `{ url }` instead of a 302 redirect.
|
|
15283
15683
|
*/
|
|
15284
|
-
|
|
15684
|
+
as?: 'json';
|
|
15285
15685
|
};
|
|
15686
|
+
};
|
|
15687
|
+
type GetVoiceCallRecordingResponse = ({
|
|
15688
|
+
url?: string;
|
|
15286
15689
|
});
|
|
15287
|
-
type
|
|
15690
|
+
type GetVoiceCallRecordingError = (unknown | {
|
|
15288
15691
|
error?: string;
|
|
15289
|
-
}
|
|
15290
|
-
type
|
|
15692
|
+
});
|
|
15693
|
+
type TransferVoiceCallData = {
|
|
15291
15694
|
body: {
|
|
15292
15695
|
/**
|
|
15293
|
-
*
|
|
15294
|
-
*/
|
|
15295
|
-
accountId: string;
|
|
15296
|
-
/**
|
|
15297
|
-
* New display name (must follow WhatsApp naming guidelines)
|
|
15696
|
+
* +E164 phone number (tel: prefix optional) or a sip: URI. wss:// is not a valid transfer target.
|
|
15298
15697
|
*/
|
|
15299
|
-
|
|
15698
|
+
to: string;
|
|
15699
|
+
};
|
|
15700
|
+
path: {
|
|
15701
|
+
id: string;
|
|
15300
15702
|
};
|
|
15301
15703
|
};
|
|
15302
|
-
type
|
|
15704
|
+
type TransferVoiceCallResponse = ({
|
|
15303
15705
|
success?: boolean;
|
|
15304
|
-
|
|
15305
|
-
|
|
15306
|
-
name?: string;
|
|
15307
|
-
status?: 'PENDING_REVIEW';
|
|
15308
|
-
};
|
|
15706
|
+
callId?: string;
|
|
15707
|
+
transferredTo?: string;
|
|
15309
15708
|
});
|
|
15310
|
-
type
|
|
15709
|
+
type TransferVoiceCallError = ({
|
|
15311
15710
|
error?: string;
|
|
15312
|
-
});
|
|
15313
|
-
type
|
|
15711
|
+
} | unknown);
|
|
15712
|
+
type GetVoiceCallEstimateData = {
|
|
15314
15713
|
query: {
|
|
15714
|
+
minutes?: number;
|
|
15715
|
+
recording?: boolean;
|
|
15315
15716
|
/**
|
|
15316
|
-
*
|
|
15717
|
+
* Destination number, E.164 (leading + optional).
|
|
15317
15718
|
*/
|
|
15318
|
-
|
|
15719
|
+
to: string;
|
|
15720
|
+
transcription?: boolean;
|
|
15319
15721
|
};
|
|
15320
15722
|
};
|
|
15321
|
-
type
|
|
15723
|
+
type GetVoiceCallEstimateResponse = ({
|
|
15724
|
+
destinationCountry?: (string) | null;
|
|
15725
|
+
minutes?: number;
|
|
15726
|
+
/**
|
|
15727
|
+
* Billable cost per minute for the requested options.
|
|
15728
|
+
*/
|
|
15729
|
+
perMinuteUsd?: number;
|
|
15730
|
+
breakdown?: {
|
|
15731
|
+
telnyxCostUSD?: number;
|
|
15732
|
+
recordingCostUSD?: number;
|
|
15733
|
+
transcriptionCostUSD?: number;
|
|
15734
|
+
/**
|
|
15735
|
+
* What Zernio bills for the call.
|
|
15736
|
+
*/
|
|
15737
|
+
billableCostUSD?: number;
|
|
15738
|
+
/**
|
|
15739
|
+
* Equals billableCostUSD (no separate Meta bill on PSTN); kept for shape parity with the WhatsApp estimate.
|
|
15740
|
+
*/
|
|
15741
|
+
totalCostUSD?: number;
|
|
15742
|
+
};
|
|
15743
|
+
});
|
|
15744
|
+
type GetVoiceCallEstimateError = ({
|
|
15745
|
+
error?: string;
|
|
15746
|
+
});
|
|
15747
|
+
type CreateVoiceWebSessionResponse = ({
|
|
15322
15748
|
success?: boolean;
|
|
15323
15749
|
/**
|
|
15324
|
-
*
|
|
15750
|
+
* Login token for the browser WebRTC SDK.
|
|
15325
15751
|
*/
|
|
15326
|
-
|
|
15752
|
+
token?: string;
|
|
15327
15753
|
/**
|
|
15328
|
-
*
|
|
15754
|
+
* Pass to POST /v1/voice/calls/web/dial once the browser is registered.
|
|
15329
15755
|
*/
|
|
15330
|
-
|
|
15756
|
+
credentialId?: string;
|
|
15757
|
+
expiresAt?: string;
|
|
15758
|
+
sdk?: string;
|
|
15331
15759
|
});
|
|
15332
|
-
type
|
|
15760
|
+
type CreateVoiceWebSessionError = ({
|
|
15333
15761
|
error?: string;
|
|
15334
15762
|
} | unknown);
|
|
15335
|
-
type
|
|
15763
|
+
type DialVoiceWebCallData = {
|
|
15336
15764
|
body: {
|
|
15337
15765
|
/**
|
|
15338
|
-
*
|
|
15766
|
+
* The number to call, E.164 with leading +.
|
|
15339
15767
|
*/
|
|
15340
|
-
|
|
15768
|
+
to: string;
|
|
15341
15769
|
/**
|
|
15342
|
-
*
|
|
15343
|
-
*
|
|
15770
|
+
* The WebRTC credential id returned by POST /v1/voice/calls/web (the registered browser).
|
|
15344
15771
|
*/
|
|
15345
|
-
|
|
15772
|
+
credentialId: string;
|
|
15346
15773
|
/**
|
|
15347
|
-
*
|
|
15774
|
+
* Which of your voice-enabled numbers to call from (optional when you have one).
|
|
15348
15775
|
*/
|
|
15349
|
-
|
|
15776
|
+
fromNumber?: string;
|
|
15777
|
+
recordOverride?: boolean;
|
|
15350
15778
|
};
|
|
15351
15779
|
};
|
|
15352
|
-
type
|
|
15780
|
+
type DialVoiceWebCallResponse = ({
|
|
15353
15781
|
success?: boolean;
|
|
15354
|
-
|
|
15355
|
-
|
|
15782
|
+
callId?: string;
|
|
15783
|
+
telnyxCallControlId?: string;
|
|
15784
|
+
status?: 'dialing';
|
|
15785
|
+
direction?: 'outbound';
|
|
15786
|
+
from?: string;
|
|
15787
|
+
to?: string;
|
|
15788
|
+
recordingEnabled?: boolean;
|
|
15356
15789
|
});
|
|
15357
|
-
type
|
|
15790
|
+
type DialVoiceWebCallError = ({
|
|
15358
15791
|
error?: string;
|
|
15359
|
-
});
|
|
15360
|
-
type
|
|
15792
|
+
} | unknown);
|
|
15793
|
+
type SendSmsData = {
|
|
15361
15794
|
body: {
|
|
15362
15795
|
/**
|
|
15363
|
-
*
|
|
15796
|
+
* One of your SMS-enabled numbers (E.164; formatting is normalized).
|
|
15364
15797
|
*/
|
|
15365
|
-
|
|
15798
|
+
from: string;
|
|
15799
|
+
/**
|
|
15800
|
+
* Recipient number (E.164).
|
|
15801
|
+
*/
|
|
15802
|
+
to: string;
|
|
15803
|
+
/**
|
|
15804
|
+
* Message body. Required unless `mediaUrls` is set. Max 10 SMS segments (1530 GSM-7 or 670 unicode characters).
|
|
15805
|
+
*/
|
|
15806
|
+
text?: string;
|
|
15807
|
+
/**
|
|
15808
|
+
* Public media URLs to attach (sends as MMS). Max 10.
|
|
15809
|
+
*/
|
|
15810
|
+
mediaUrls?: Array<(string)>;
|
|
15811
|
+
};
|
|
15812
|
+
headers?: {
|
|
15813
|
+
/**
|
|
15814
|
+
* 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.
|
|
15815
|
+
*/
|
|
15816
|
+
'Idempotency-Key'?: string;
|
|
15366
15817
|
};
|
|
15367
15818
|
};
|
|
15368
|
-
type
|
|
15369
|
-
|
|
15819
|
+
type SendSmsResponse = ({
|
|
15820
|
+
/**
|
|
15821
|
+
* Message ID
|
|
15822
|
+
*/
|
|
15823
|
+
id?: string;
|
|
15824
|
+
/**
|
|
15825
|
+
* Inbox conversation the message was threaded into.
|
|
15826
|
+
*/
|
|
15827
|
+
conversationId?: string;
|
|
15828
|
+
status?: 'sent';
|
|
15370
15829
|
});
|
|
15371
|
-
type
|
|
15830
|
+
type SendSmsError = ({
|
|
15372
15831
|
error?: string;
|
|
15373
15832
|
} | unknown);
|
|
15374
|
-
type
|
|
15833
|
+
type LookupSmsNumberData = {
|
|
15375
15834
|
query: {
|
|
15376
15835
|
/**
|
|
15377
|
-
*
|
|
15836
|
+
* Number to look up (E.164; formatting is normalized).
|
|
15378
15837
|
*/
|
|
15379
|
-
|
|
15838
|
+
number: string;
|
|
15380
15839
|
};
|
|
15381
15840
|
};
|
|
15382
|
-
type
|
|
15383
|
-
|
|
15841
|
+
type LookupSmsNumberResponse = ({
|
|
15842
|
+
phoneNumber?: string;
|
|
15843
|
+
carrierName?: (string) | null;
|
|
15844
|
+
lineType?: 'mobile' | 'landline' | 'voip' | 'toll-free' | 'unknown';
|
|
15384
15845
|
/**
|
|
15385
|
-
*
|
|
15846
|
+
* True when the line type can receive SMS (not a landline).
|
|
15386
15847
|
*/
|
|
15387
|
-
|
|
15848
|
+
smsReachable?: boolean;
|
|
15388
15849
|
});
|
|
15389
|
-
type
|
|
15850
|
+
type LookupSmsNumberError = ({
|
|
15390
15851
|
error?: string;
|
|
15391
15852
|
} | unknown);
|
|
15392
|
-
type
|
|
15393
|
-
query
|
|
15394
|
-
|
|
15395
|
-
|
|
15396
|
-
*/
|
|
15397
|
-
accountId: string;
|
|
15853
|
+
type ListSmsOptOutsData = {
|
|
15854
|
+
query?: {
|
|
15855
|
+
format?: 'json' | 'csv';
|
|
15856
|
+
limit?: number;
|
|
15398
15857
|
};
|
|
15399
15858
|
};
|
|
15400
|
-
type
|
|
15401
|
-
|
|
15402
|
-
|
|
15403
|
-
|
|
15859
|
+
type ListSmsOptOutsResponse = ({
|
|
15860
|
+
optOuts?: Array<{
|
|
15861
|
+
phoneNumber?: string;
|
|
15862
|
+
optedOutAt?: (string) | null;
|
|
15404
15863
|
/**
|
|
15405
|
-
*
|
|
15864
|
+
* The keyword they sent (e.g. STOP), when the carrier recorded one.
|
|
15406
15865
|
*/
|
|
15407
|
-
|
|
15866
|
+
keyword?: (string) | null;
|
|
15408
15867
|
/**
|
|
15409
|
-
*
|
|
15868
|
+
* Which of your numbers the recipient opted out from.
|
|
15410
15869
|
*/
|
|
15411
|
-
|
|
15870
|
+
from?: (string) | null;
|
|
15871
|
+
}>;
|
|
15872
|
+
count?: number;
|
|
15873
|
+
});
|
|
15874
|
+
type ListSmsOptOutsError = ({
|
|
15875
|
+
error?: string;
|
|
15876
|
+
});
|
|
15877
|
+
type StartSmsRegistrationData = {
|
|
15878
|
+
body: {
|
|
15879
|
+
registrationType: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
|
|
15412
15880
|
/**
|
|
15413
|
-
*
|
|
15881
|
+
* Your numbers this registration covers.
|
|
15414
15882
|
*/
|
|
15415
|
-
|
|
15416
|
-
throughput?: {
|
|
15417
|
-
/**
|
|
15418
|
-
* STANDARD or HIGH
|
|
15419
|
-
*/
|
|
15420
|
-
level?: string;
|
|
15421
|
-
};
|
|
15883
|
+
phoneNumbers: Array<(string)>;
|
|
15422
15884
|
/**
|
|
15423
|
-
*
|
|
15885
|
+
* Required for 10DLC. The legal entity behind the traffic (TCR brand).
|
|
15424
15886
|
*/
|
|
15425
|
-
|
|
15426
|
-
|
|
15887
|
+
brand?: {
|
|
15888
|
+
entityType: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR';
|
|
15889
|
+
displayName: string;
|
|
15890
|
+
/**
|
|
15891
|
+
* Legal company name. Required for every entityType except SOLE_PROPRIETOR.
|
|
15892
|
+
*/
|
|
15893
|
+
companyName?: string;
|
|
15894
|
+
/**
|
|
15895
|
+
* Required for every entityType except SOLE_PROPRIETOR.
|
|
15896
|
+
*/
|
|
15897
|
+
ein?: string;
|
|
15898
|
+
phone?: string;
|
|
15899
|
+
/**
|
|
15900
|
+
* Required for SOLE_PROPRIETOR; the verification OTP is texted there (US/CA mobile).
|
|
15901
|
+
*/
|
|
15902
|
+
mobilePhone?: string;
|
|
15903
|
+
street?: string;
|
|
15904
|
+
city?: string;
|
|
15905
|
+
state?: string;
|
|
15906
|
+
postalCode?: string;
|
|
15907
|
+
country: 'US' | 'CA';
|
|
15908
|
+
/**
|
|
15909
|
+
* Brand contact email; defaults to your account email when omitted.
|
|
15910
|
+
*/
|
|
15911
|
+
email?: string;
|
|
15912
|
+
website?: string;
|
|
15913
|
+
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';
|
|
15914
|
+
stockSymbol?: string;
|
|
15915
|
+
};
|
|
15427
15916
|
/**
|
|
15428
|
-
*
|
|
15917
|
+
* Required for 10DLC. What you'll send and how recipients opt in/out.
|
|
15429
15918
|
*/
|
|
15430
|
-
|
|
15919
|
+
campaign?: {
|
|
15920
|
+
usecase: string;
|
|
15921
|
+
description: string;
|
|
15922
|
+
/**
|
|
15923
|
+
* How a recipient ends up receiving your messages (the opt-in flow).
|
|
15924
|
+
*/
|
|
15925
|
+
messageFlow: string;
|
|
15926
|
+
sample1: string;
|
|
15927
|
+
sample2?: string;
|
|
15928
|
+
helpMessage: string;
|
|
15929
|
+
optinKeywords: string;
|
|
15930
|
+
optinMessage: string;
|
|
15931
|
+
optoutKeywords: string;
|
|
15932
|
+
optoutMessage: string;
|
|
15933
|
+
helpKeywords: string;
|
|
15934
|
+
embeddedLink?: boolean;
|
|
15935
|
+
embeddedPhone?: boolean;
|
|
15936
|
+
numberPool?: boolean;
|
|
15937
|
+
ageGated?: boolean;
|
|
15938
|
+
directLending?: boolean;
|
|
15939
|
+
};
|
|
15431
15940
|
/**
|
|
15432
|
-
*
|
|
15941
|
+
* Required for toll_free.
|
|
15433
15942
|
*/
|
|
15434
|
-
|
|
15435
|
-
|
|
15943
|
+
tollFree?: {
|
|
15944
|
+
businessName: string;
|
|
15945
|
+
corporateWebsite: string;
|
|
15946
|
+
phoneNumbers: Array<(string)>;
|
|
15947
|
+
useCase: string;
|
|
15948
|
+
useCaseSummary: string;
|
|
15949
|
+
productionMessageContent: string;
|
|
15950
|
+
/**
|
|
15951
|
+
* How recipients opt in to your messages.
|
|
15952
|
+
*/
|
|
15953
|
+
optInWorkflow: string;
|
|
15954
|
+
/**
|
|
15955
|
+
* Screenshot URL(s) showing the opt-in flow (at least one).
|
|
15956
|
+
*/
|
|
15957
|
+
optInWorkflowImageUrls: Array<(string)>;
|
|
15958
|
+
/**
|
|
15959
|
+
* Expected monthly message volume tier.
|
|
15960
|
+
*/
|
|
15961
|
+
messageVolume: '10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+';
|
|
15962
|
+
additionalInformation: string;
|
|
15963
|
+
businessAddr1: string;
|
|
15964
|
+
businessAddr2?: string;
|
|
15965
|
+
businessCity: string;
|
|
15966
|
+
businessState: string;
|
|
15967
|
+
businessZip: string;
|
|
15968
|
+
businessContactFirstName: string;
|
|
15969
|
+
businessContactLastName: string;
|
|
15970
|
+
businessContactEmail: string;
|
|
15971
|
+
businessContactPhone: string;
|
|
15972
|
+
businessRegistrationNumber: string;
|
|
15973
|
+
/**
|
|
15974
|
+
* e.g. EIN (US), Companies House (UK), ABN (AU).
|
|
15975
|
+
*/
|
|
15976
|
+
businessRegistrationType: string;
|
|
15977
|
+
/**
|
|
15978
|
+
* ISO 3166-1 alpha-2.
|
|
15979
|
+
*/
|
|
15980
|
+
businessRegistrationCountry: string;
|
|
15436
15981
|
};
|
|
15437
15982
|
};
|
|
15438
|
-
|
|
15439
|
-
|
|
15983
|
+
};
|
|
15984
|
+
type StartSmsRegistrationResponse = ({
|
|
15985
|
+
registrationId?: string;
|
|
15986
|
+
status?: 'pending';
|
|
15987
|
+
/**
|
|
15988
|
+
* True for sole-prop 10DLC: an OTP was texted to the brand's mobile; submit it via /verify-otp.
|
|
15989
|
+
*/
|
|
15990
|
+
awaitingOtp?: boolean;
|
|
15991
|
+
});
|
|
15992
|
+
type StartSmsRegistrationError = ({
|
|
15993
|
+
error?: string;
|
|
15994
|
+
} | unknown);
|
|
15995
|
+
type ListSmsRegistrationsResponse = ({
|
|
15996
|
+
registrations?: Array<{
|
|
15997
|
+
id?: string;
|
|
15998
|
+
registrationType?: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
|
|
15999
|
+
displayName?: (string) | null;
|
|
16000
|
+
status?: 'pending' | 'approved' | 'rejected';
|
|
15440
16001
|
/**
|
|
15441
|
-
*
|
|
16002
|
+
* Carrier-registry brand status (e.g. VERIFIED).
|
|
15442
16003
|
*/
|
|
15443
|
-
|
|
16004
|
+
brandStatus?: string;
|
|
16005
|
+
campaignStatus?: string;
|
|
15444
16006
|
/**
|
|
15445
|
-
*
|
|
16007
|
+
* TCR brand id, useful when referencing the brand in carrier support threads.
|
|
15446
16008
|
*/
|
|
15447
|
-
|
|
15448
|
-
|
|
15449
|
-
|
|
16009
|
+
brandId?: (string) | null;
|
|
16010
|
+
/**
|
|
16011
|
+
* TCR campaign id.
|
|
16012
|
+
*/
|
|
16013
|
+
campaignId?: (string) | null;
|
|
16014
|
+
declineReason?: (string) | null;
|
|
16015
|
+
phoneNumbers?: Array<(string)>;
|
|
16016
|
+
/**
|
|
16017
|
+
* Sole-prop 10DLC only; the OTP step is still pending.
|
|
16018
|
+
*/
|
|
16019
|
+
awaitingOtp?: boolean;
|
|
16020
|
+
/**
|
|
16021
|
+
* Carrier-assigned brand trust score; drives throughput.
|
|
16022
|
+
*/
|
|
16023
|
+
trustScore?: (number) | null;
|
|
16024
|
+
/**
|
|
16025
|
+
* Carrier throughput tier derived from the trust score.
|
|
16026
|
+
*/
|
|
16027
|
+
throughput?: {
|
|
16028
|
+
label?: string;
|
|
16029
|
+
smsPerMinute?: number;
|
|
16030
|
+
smsPerDay?: number;
|
|
15450
16031
|
};
|
|
15451
|
-
}
|
|
16032
|
+
}>;
|
|
15452
16033
|
});
|
|
15453
|
-
type
|
|
16034
|
+
type ListSmsRegistrationsError = ({
|
|
15454
16035
|
error?: string;
|
|
15455
16036
|
});
|
|
15456
|
-
type
|
|
15457
|
-
|
|
15458
|
-
|
|
16037
|
+
type GetSmsRegistrationData = {
|
|
16038
|
+
path: {
|
|
16039
|
+
id: string;
|
|
16040
|
+
};
|
|
16041
|
+
};
|
|
16042
|
+
type GetSmsRegistrationResponse = ({
|
|
16043
|
+
id?: string;
|
|
16044
|
+
registrationType?: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
|
|
16045
|
+
status?: 'pending' | 'approved' | 'rejected';
|
|
16046
|
+
brandStatus?: string;
|
|
16047
|
+
campaignStatus?: string;
|
|
16048
|
+
declineReason?: (string) | null;
|
|
16049
|
+
phoneNumbers?: Array<(string)>;
|
|
16050
|
+
awaitingOtp?: boolean;
|
|
16051
|
+
});
|
|
16052
|
+
type GetSmsRegistrationError = ({
|
|
16053
|
+
error?: string;
|
|
16054
|
+
} | unknown);
|
|
16055
|
+
type VerifySmsRegistrationOtpData = {
|
|
16056
|
+
body: {
|
|
16057
|
+
otpPin: string;
|
|
16058
|
+
};
|
|
16059
|
+
path: {
|
|
16060
|
+
id: string;
|
|
16061
|
+
};
|
|
16062
|
+
};
|
|
16063
|
+
type VerifySmsRegistrationOtpResponse = ({
|
|
16064
|
+
verified?: boolean;
|
|
16065
|
+
});
|
|
16066
|
+
type VerifySmsRegistrationOtpError = ({
|
|
16067
|
+
error?: string;
|
|
16068
|
+
} | unknown);
|
|
16069
|
+
type AppealSmsRegistrationData = {
|
|
16070
|
+
body: {
|
|
16071
|
+
appealReason: string;
|
|
16072
|
+
};
|
|
16073
|
+
path: {
|
|
16074
|
+
id: string;
|
|
16075
|
+
};
|
|
16076
|
+
};
|
|
16077
|
+
type AppealSmsRegistrationResponse = ({
|
|
16078
|
+
status?: 'pending';
|
|
16079
|
+
});
|
|
16080
|
+
type AppealSmsRegistrationError = (unknown | {
|
|
16081
|
+
error?: string;
|
|
16082
|
+
});
|
|
16083
|
+
type ShareSmsRegistrationData = {
|
|
16084
|
+
body: {
|
|
15459
16085
|
/**
|
|
15460
|
-
*
|
|
16086
|
+
* Your phone number's ID (from GET /v1/phone-numbers).
|
|
15461
16087
|
*/
|
|
15462
|
-
|
|
16088
|
+
numberId: string;
|
|
15463
16089
|
};
|
|
15464
16090
|
};
|
|
15465
|
-
type
|
|
15466
|
-
|
|
16091
|
+
type ShareSmsRegistrationResponse = ({
|
|
16092
|
+
url?: string;
|
|
16093
|
+
expiresAt?: string;
|
|
15467
16094
|
});
|
|
15468
|
-
type
|
|
16095
|
+
type ShareSmsRegistrationError = ({
|
|
15469
16096
|
error?: string;
|
|
15470
16097
|
} | unknown);
|
|
15471
|
-
type
|
|
16098
|
+
type GetWhatsAppLibraryTemplateData = {
|
|
15472
16099
|
query: {
|
|
15473
16100
|
/**
|
|
15474
16101
|
* WhatsApp social account ID
|
|
15475
16102
|
*/
|
|
15476
16103
|
accountId: string;
|
|
15477
16104
|
/**
|
|
15478
|
-
*
|
|
15479
|
-
*/
|
|
15480
|
-
after?: string;
|
|
15481
|
-
/**
|
|
15482
|
-
* Page size.
|
|
16105
|
+
* Exact library template name
|
|
15483
16106
|
*/
|
|
15484
|
-
|
|
16107
|
+
name: string;
|
|
15485
16108
|
};
|
|
15486
16109
|
};
|
|
15487
|
-
type
|
|
15488
|
-
|
|
15489
|
-
|
|
15490
|
-
|
|
15491
|
-
|
|
15492
|
-
|
|
15493
|
-
|
|
15494
|
-
|
|
15495
|
-
|
|
15496
|
-
|
|
15497
|
-
|
|
16110
|
+
type GetWhatsAppLibraryTemplateResponse = ({
|
|
16111
|
+
template?: {
|
|
16112
|
+
name?: string;
|
|
16113
|
+
language?: string;
|
|
16114
|
+
category?: string;
|
|
16115
|
+
body?: string;
|
|
16116
|
+
body_params?: Array<(string)>;
|
|
16117
|
+
buttons?: Array<{
|
|
16118
|
+
/**
|
|
16119
|
+
* QUICK_REPLY, URL, PHONE_NUMBER, OTP, FLOW, ...
|
|
16120
|
+
*/
|
|
16121
|
+
type?: string;
|
|
16122
|
+
text?: string;
|
|
16123
|
+
}>;
|
|
16124
|
+
} | null;
|
|
15498
16125
|
});
|
|
15499
|
-
type
|
|
16126
|
+
type GetWhatsAppLibraryTemplateError = (unknown | {
|
|
15500
16127
|
error?: string;
|
|
15501
|
-
}
|
|
15502
|
-
type
|
|
15503
|
-
|
|
16128
|
+
});
|
|
16129
|
+
type GetWhatsAppBusinessProfileData = {
|
|
16130
|
+
query: {
|
|
15504
16131
|
/**
|
|
15505
16132
|
* WhatsApp social account ID
|
|
15506
16133
|
*/
|
|
15507
16134
|
accountId: string;
|
|
15508
|
-
/**
|
|
15509
|
-
* Phone numbers (E.164, e.g. "+16505551234") or WhatsApp user IDs to block.
|
|
15510
|
-
*/
|
|
15511
|
-
users: Array<(string)>;
|
|
15512
16135
|
};
|
|
15513
16136
|
};
|
|
15514
|
-
type
|
|
15515
|
-
|
|
15516
|
-
|
|
15517
|
-
*/
|
|
15518
|
-
blocked?: Array<{
|
|
16137
|
+
type GetWhatsAppBusinessProfileResponse = ({
|
|
16138
|
+
success?: boolean;
|
|
16139
|
+
businessProfile?: {
|
|
15519
16140
|
/**
|
|
15520
|
-
*
|
|
16141
|
+
* Short description (max 139 chars)
|
|
15521
16142
|
*/
|
|
15522
|
-
|
|
16143
|
+
about?: string;
|
|
16144
|
+
address?: string;
|
|
15523
16145
|
/**
|
|
15524
|
-
*
|
|
16146
|
+
* Full description (max 512 chars)
|
|
15525
16147
|
*/
|
|
15526
|
-
|
|
15527
|
-
|
|
15528
|
-
|
|
15529
|
-
|
|
15530
|
-
|
|
15531
|
-
|
|
15532
|
-
|
|
15533
|
-
|
|
15534
|
-
}
|
|
16148
|
+
description?: string;
|
|
16149
|
+
email?: string;
|
|
16150
|
+
profilePictureUrl?: string;
|
|
16151
|
+
websites?: Array<(string)>;
|
|
16152
|
+
/**
|
|
16153
|
+
* Business category
|
|
16154
|
+
*/
|
|
16155
|
+
vertical?: string;
|
|
16156
|
+
};
|
|
15535
16157
|
});
|
|
15536
|
-
type
|
|
16158
|
+
type GetWhatsAppBusinessProfileError = (unknown | {
|
|
15537
16159
|
error?: string;
|
|
15538
|
-
}
|
|
15539
|
-
type
|
|
16160
|
+
});
|
|
16161
|
+
type UpdateWhatsAppBusinessProfileData = {
|
|
15540
16162
|
body: {
|
|
15541
16163
|
/**
|
|
15542
16164
|
* WhatsApp social account ID
|
|
15543
16165
|
*/
|
|
15544
16166
|
accountId: string;
|
|
15545
16167
|
/**
|
|
15546
|
-
*
|
|
16168
|
+
* Short business description (max 139 characters)
|
|
15547
16169
|
*/
|
|
15548
|
-
|
|
15549
|
-
};
|
|
15550
|
-
};
|
|
15551
|
-
type UnblockWhatsAppUsersResponse = ({
|
|
15552
|
-
/**
|
|
15553
|
-
* Users successfully unblocked.
|
|
15554
|
-
*/
|
|
15555
|
-
unblocked?: Array<{
|
|
16170
|
+
about?: string;
|
|
15556
16171
|
/**
|
|
15557
|
-
*
|
|
16172
|
+
* Business address
|
|
15558
16173
|
*/
|
|
15559
|
-
|
|
16174
|
+
address?: string;
|
|
15560
16175
|
/**
|
|
15561
|
-
*
|
|
16176
|
+
* Full business description (max 512 characters)
|
|
15562
16177
|
*/
|
|
15563
|
-
|
|
15564
|
-
|
|
15565
|
-
|
|
15566
|
-
|
|
15567
|
-
|
|
15568
|
-
|
|
15569
|
-
|
|
15570
|
-
|
|
15571
|
-
|
|
16178
|
+
description?: string;
|
|
16179
|
+
/**
|
|
16180
|
+
* Business email
|
|
16181
|
+
*/
|
|
16182
|
+
email?: string;
|
|
16183
|
+
/**
|
|
16184
|
+
* Business websites (max 2)
|
|
16185
|
+
*/
|
|
16186
|
+
websites?: Array<(string)>;
|
|
16187
|
+
/**
|
|
16188
|
+
* Business category (e.g., RETAIL, ENTERTAINMENT, etc.)
|
|
16189
|
+
*/
|
|
16190
|
+
vertical?: string;
|
|
16191
|
+
/**
|
|
16192
|
+
* Handle from resumable upload for profile picture
|
|
16193
|
+
*/
|
|
16194
|
+
profilePictureHandle?: string;
|
|
16195
|
+
};
|
|
16196
|
+
};
|
|
16197
|
+
type UpdateWhatsAppBusinessProfileResponse = ({
|
|
16198
|
+
success?: boolean;
|
|
16199
|
+
message?: string;
|
|
15572
16200
|
});
|
|
15573
|
-
type
|
|
16201
|
+
type UpdateWhatsAppBusinessProfileError = (unknown | {
|
|
15574
16202
|
error?: string;
|
|
15575
|
-
}
|
|
15576
|
-
type
|
|
15577
|
-
|
|
16203
|
+
});
|
|
16204
|
+
type UploadWhatsAppProfilePhotoData = {
|
|
16205
|
+
body: {
|
|
15578
16206
|
/**
|
|
15579
16207
|
* WhatsApp social account ID
|
|
15580
16208
|
*/
|
|
15581
16209
|
accountId: string;
|
|
16210
|
+
/**
|
|
16211
|
+
* Image file (JPEG or PNG, max 5MB, recommended 640x640)
|
|
16212
|
+
*/
|
|
16213
|
+
file: (Blob | File);
|
|
15582
16214
|
};
|
|
15583
16215
|
};
|
|
15584
|
-
type
|
|
16216
|
+
type UploadWhatsAppProfilePhotoResponse = ({
|
|
16217
|
+
success?: boolean;
|
|
16218
|
+
message?: string;
|
|
16219
|
+
});
|
|
16220
|
+
type UploadWhatsAppProfilePhotoError = (unknown | {
|
|
16221
|
+
error?: string;
|
|
16222
|
+
});
|
|
16223
|
+
type GetWhatsAppDisplayNameData = {
|
|
16224
|
+
query: {
|
|
16225
|
+
/**
|
|
16226
|
+
* WhatsApp social account ID
|
|
16227
|
+
*/
|
|
16228
|
+
accountId: string;
|
|
16229
|
+
};
|
|
16230
|
+
};
|
|
16231
|
+
type GetWhatsAppDisplayNameResponse = ({
|
|
16232
|
+
success?: boolean;
|
|
16233
|
+
displayName?: {
|
|
16234
|
+
/**
|
|
16235
|
+
* Current verified display name
|
|
16236
|
+
*/
|
|
16237
|
+
name?: string;
|
|
16238
|
+
/**
|
|
16239
|
+
* Meta review status for the display name
|
|
16240
|
+
*/
|
|
16241
|
+
status?: 'APPROVED' | 'PENDING_REVIEW' | 'DECLINED' | 'NONE';
|
|
16242
|
+
/**
|
|
16243
|
+
* Display phone number
|
|
16244
|
+
*/
|
|
16245
|
+
phoneNumber?: string;
|
|
16246
|
+
};
|
|
16247
|
+
});
|
|
16248
|
+
type GetWhatsAppDisplayNameError = ({
|
|
16249
|
+
error?: string;
|
|
16250
|
+
} | unknown);
|
|
16251
|
+
type UpdateWhatsAppDisplayNameData = {
|
|
16252
|
+
body: {
|
|
16253
|
+
/**
|
|
16254
|
+
* WhatsApp social account ID
|
|
16255
|
+
*/
|
|
16256
|
+
accountId: string;
|
|
16257
|
+
/**
|
|
16258
|
+
* New display name (must follow WhatsApp naming guidelines)
|
|
16259
|
+
*/
|
|
16260
|
+
displayName: string;
|
|
16261
|
+
};
|
|
16262
|
+
};
|
|
16263
|
+
type UpdateWhatsAppDisplayNameResponse = ({
|
|
16264
|
+
success?: boolean;
|
|
16265
|
+
message?: string;
|
|
16266
|
+
displayName?: {
|
|
16267
|
+
name?: string;
|
|
16268
|
+
status?: 'PENDING_REVIEW';
|
|
16269
|
+
};
|
|
16270
|
+
});
|
|
16271
|
+
type UpdateWhatsAppDisplayNameError = (unknown | {
|
|
16272
|
+
error?: string;
|
|
16273
|
+
});
|
|
16274
|
+
type GetWhatsappBusinessUsernameData = {
|
|
16275
|
+
query: {
|
|
16276
|
+
/**
|
|
16277
|
+
* WhatsApp social account ID
|
|
16278
|
+
*/
|
|
16279
|
+
accountId: string;
|
|
16280
|
+
};
|
|
16281
|
+
};
|
|
16282
|
+
type GetWhatsappBusinessUsernameResponse = ({
|
|
16283
|
+
success?: boolean;
|
|
16284
|
+
/**
|
|
16285
|
+
* The current username, or null if none is set
|
|
16286
|
+
*/
|
|
16287
|
+
username?: (string) | null;
|
|
16288
|
+
/**
|
|
16289
|
+
* Approval state of the username
|
|
16290
|
+
*/
|
|
16291
|
+
status?: 'approved' | 'reserved' | 'none';
|
|
16292
|
+
});
|
|
16293
|
+
type GetWhatsappBusinessUsernameError = ({
|
|
16294
|
+
error?: string;
|
|
16295
|
+
} | unknown);
|
|
16296
|
+
type SetWhatsappBusinessUsernameData = {
|
|
16297
|
+
body: {
|
|
16298
|
+
/**
|
|
16299
|
+
* WhatsApp social account ID
|
|
16300
|
+
*/
|
|
16301
|
+
accountId: string;
|
|
16302
|
+
/**
|
|
16303
|
+
* 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.
|
|
16304
|
+
*
|
|
16305
|
+
*/
|
|
16306
|
+
username: string;
|
|
16307
|
+
/**
|
|
16308
|
+
* Pass `force_transfer` to request a transfer if the username is held by another account
|
|
16309
|
+
*/
|
|
16310
|
+
transferAction?: 'none' | 'force_transfer';
|
|
16311
|
+
};
|
|
16312
|
+
};
|
|
16313
|
+
type SetWhatsappBusinessUsernameResponse = ({
|
|
16314
|
+
success?: boolean;
|
|
16315
|
+
username?: string;
|
|
16316
|
+
status?: 'approved' | 'reserved' | 'none';
|
|
16317
|
+
});
|
|
16318
|
+
type SetWhatsappBusinessUsernameError = (unknown | {
|
|
16319
|
+
error?: string;
|
|
16320
|
+
});
|
|
16321
|
+
type DeleteWhatsappBusinessUsernameData = {
|
|
16322
|
+
body: {
|
|
16323
|
+
/**
|
|
16324
|
+
* WhatsApp social account ID
|
|
16325
|
+
*/
|
|
16326
|
+
accountId: string;
|
|
16327
|
+
};
|
|
16328
|
+
};
|
|
16329
|
+
type DeleteWhatsappBusinessUsernameResponse = ({
|
|
16330
|
+
success?: boolean;
|
|
16331
|
+
});
|
|
16332
|
+
type DeleteWhatsappBusinessUsernameError = ({
|
|
16333
|
+
error?: string;
|
|
16334
|
+
} | unknown);
|
|
16335
|
+
type GetWhatsappBusinessUsernameSuggestionsData = {
|
|
16336
|
+
query: {
|
|
16337
|
+
/**
|
|
16338
|
+
* WhatsApp social account ID
|
|
16339
|
+
*/
|
|
16340
|
+
accountId: string;
|
|
16341
|
+
};
|
|
16342
|
+
};
|
|
16343
|
+
type GetWhatsappBusinessUsernameSuggestionsResponse = ({
|
|
16344
|
+
success?: boolean;
|
|
16345
|
+
/**
|
|
16346
|
+
* List of available username suggestions
|
|
16347
|
+
*/
|
|
16348
|
+
suggestions?: Array<(string)>;
|
|
16349
|
+
});
|
|
16350
|
+
type GetWhatsappBusinessUsernameSuggestionsError = ({
|
|
16351
|
+
error?: string;
|
|
16352
|
+
} | unknown);
|
|
16353
|
+
type GetWhatsAppNumberInfoData = {
|
|
16354
|
+
query: {
|
|
16355
|
+
/**
|
|
16356
|
+
* WhatsApp social account ID
|
|
16357
|
+
*/
|
|
16358
|
+
accountId: string;
|
|
16359
|
+
};
|
|
16360
|
+
};
|
|
16361
|
+
type GetWhatsAppNumberInfoResponse = ({
|
|
16362
|
+
phone?: {
|
|
16363
|
+
display_phone_number?: string;
|
|
16364
|
+
verified_name?: string;
|
|
16365
|
+
/**
|
|
16366
|
+
* APPROVED, AVAILABLE_WITHOUT_REVIEW, PENDING_REVIEW, DECLINED, EXPIRED, NONE
|
|
16367
|
+
*/
|
|
16368
|
+
name_status?: string;
|
|
16369
|
+
/**
|
|
16370
|
+
* GREEN, YELLOW, RED, UNKNOWN
|
|
16371
|
+
*/
|
|
16372
|
+
quality_rating?: string;
|
|
16373
|
+
/**
|
|
16374
|
+
* e.g. TIER_250, TIER_1K, TIER_UNLIMITED
|
|
16375
|
+
*/
|
|
16376
|
+
messaging_limit_tier?: string;
|
|
16377
|
+
throughput?: {
|
|
16378
|
+
/**
|
|
16379
|
+
* STANDARD or HIGH
|
|
16380
|
+
*/
|
|
16381
|
+
level?: string;
|
|
16382
|
+
};
|
|
16383
|
+
/**
|
|
16384
|
+
* e.g. CONNECTED
|
|
16385
|
+
*/
|
|
16386
|
+
status?: string;
|
|
16387
|
+
is_official_business_account?: boolean;
|
|
16388
|
+
/**
|
|
16389
|
+
* e.g. CLOUD_API
|
|
16390
|
+
*/
|
|
16391
|
+
platform_type?: string;
|
|
16392
|
+
/**
|
|
16393
|
+
* Meta's can_send_message health object (messaging + calling signals)
|
|
16394
|
+
*/
|
|
16395
|
+
health_status?: {
|
|
16396
|
+
[key: string]: unknown;
|
|
16397
|
+
};
|
|
16398
|
+
};
|
|
16399
|
+
waba?: {
|
|
16400
|
+
name?: string;
|
|
16401
|
+
/**
|
|
16402
|
+
* verified, not_verified, pending, ...
|
|
16403
|
+
*/
|
|
16404
|
+
business_verification_status?: string;
|
|
16405
|
+
/**
|
|
16406
|
+
* Meta integer timezone-enum id
|
|
16407
|
+
*/
|
|
16408
|
+
timezone_id?: string;
|
|
16409
|
+
health_status?: {
|
|
16410
|
+
[key: string]: unknown;
|
|
16411
|
+
};
|
|
16412
|
+
} | null;
|
|
16413
|
+
});
|
|
16414
|
+
type GetWhatsAppNumberInfoError = (unknown | {
|
|
16415
|
+
error?: string;
|
|
16416
|
+
});
|
|
16417
|
+
type GetWhatsAppBlockStatusData = {
|
|
16418
|
+
query: {
|
|
16419
|
+
accountId: string;
|
|
16420
|
+
/**
|
|
16421
|
+
* Consumer wa_id or E.164 phone (leading + optional)
|
|
16422
|
+
*/
|
|
16423
|
+
user: string;
|
|
16424
|
+
};
|
|
16425
|
+
};
|
|
16426
|
+
type GetWhatsAppBlockStatusResponse = ({
|
|
16427
|
+
blocked?: boolean;
|
|
16428
|
+
});
|
|
16429
|
+
type GetWhatsAppBlockStatusError = ({
|
|
16430
|
+
error?: string;
|
|
16431
|
+
} | unknown);
|
|
16432
|
+
type GetWhatsAppBlockedUsersData = {
|
|
16433
|
+
query: {
|
|
16434
|
+
/**
|
|
16435
|
+
* WhatsApp social account ID
|
|
16436
|
+
*/
|
|
16437
|
+
accountId: string;
|
|
16438
|
+
/**
|
|
16439
|
+
* Cursor from a previous response's `nextCursor`.
|
|
16440
|
+
*/
|
|
16441
|
+
after?: string;
|
|
16442
|
+
/**
|
|
16443
|
+
* Page size.
|
|
16444
|
+
*/
|
|
16445
|
+
limit?: number;
|
|
16446
|
+
};
|
|
16447
|
+
};
|
|
16448
|
+
type GetWhatsAppBlockedUsersResponse = ({
|
|
16449
|
+
blockedUsers?: Array<{
|
|
16450
|
+
/**
|
|
16451
|
+
* WhatsApp user ID (usually the phone number without `+`).
|
|
16452
|
+
*/
|
|
16453
|
+
waId?: string;
|
|
16454
|
+
}>;
|
|
16455
|
+
/**
|
|
16456
|
+
* Pass as `after` to fetch the next page. Null when there are no more pages.
|
|
16457
|
+
*/
|
|
16458
|
+
nextCursor?: (string) | null;
|
|
16459
|
+
});
|
|
16460
|
+
type GetWhatsAppBlockedUsersError = ({
|
|
16461
|
+
error?: string;
|
|
16462
|
+
} | unknown);
|
|
16463
|
+
type BlockWhatsAppUsersData = {
|
|
16464
|
+
body: {
|
|
16465
|
+
/**
|
|
16466
|
+
* WhatsApp social account ID
|
|
16467
|
+
*/
|
|
16468
|
+
accountId: string;
|
|
16469
|
+
/**
|
|
16470
|
+
* Phone numbers (E.164, e.g. "+16505551234") or WhatsApp user IDs to block.
|
|
16471
|
+
*/
|
|
16472
|
+
users: Array<(string)>;
|
|
16473
|
+
};
|
|
16474
|
+
};
|
|
16475
|
+
type BlockWhatsAppUsersResponse = ({
|
|
16476
|
+
/**
|
|
16477
|
+
* Users successfully blocked.
|
|
16478
|
+
*/
|
|
16479
|
+
blocked?: Array<{
|
|
16480
|
+
/**
|
|
16481
|
+
* The value you sent.
|
|
16482
|
+
*/
|
|
16483
|
+
input?: string;
|
|
16484
|
+
/**
|
|
16485
|
+
* Resolved WhatsApp user ID.
|
|
16486
|
+
*/
|
|
16487
|
+
waId?: string;
|
|
16488
|
+
}>;
|
|
16489
|
+
/**
|
|
16490
|
+
* Users that could not be blocked, with reasons.
|
|
16491
|
+
*/
|
|
16492
|
+
failed?: Array<{
|
|
16493
|
+
input?: string;
|
|
16494
|
+
errors?: Array<(string)>;
|
|
16495
|
+
}>;
|
|
16496
|
+
});
|
|
16497
|
+
type BlockWhatsAppUsersError = ({
|
|
16498
|
+
error?: string;
|
|
16499
|
+
} | unknown);
|
|
16500
|
+
type UnblockWhatsAppUsersData = {
|
|
16501
|
+
body: {
|
|
16502
|
+
/**
|
|
16503
|
+
* WhatsApp social account ID
|
|
16504
|
+
*/
|
|
16505
|
+
accountId: string;
|
|
16506
|
+
/**
|
|
16507
|
+
* Phone numbers (E.164) or WhatsApp user IDs to unblock.
|
|
16508
|
+
*/
|
|
16509
|
+
users: Array<(string)>;
|
|
16510
|
+
};
|
|
16511
|
+
};
|
|
16512
|
+
type UnblockWhatsAppUsersResponse = ({
|
|
16513
|
+
/**
|
|
16514
|
+
* Users successfully unblocked.
|
|
16515
|
+
*/
|
|
16516
|
+
unblocked?: Array<{
|
|
16517
|
+
/**
|
|
16518
|
+
* The value you sent.
|
|
16519
|
+
*/
|
|
16520
|
+
input?: string;
|
|
16521
|
+
/**
|
|
16522
|
+
* Resolved WhatsApp user ID.
|
|
16523
|
+
*/
|
|
16524
|
+
waId?: string;
|
|
16525
|
+
}>;
|
|
16526
|
+
/**
|
|
16527
|
+
* Users that could not be unblocked, with reasons.
|
|
16528
|
+
*/
|
|
16529
|
+
failed?: Array<{
|
|
16530
|
+
input?: string;
|
|
16531
|
+
errors?: Array<(string)>;
|
|
16532
|
+
}>;
|
|
16533
|
+
});
|
|
16534
|
+
type UnblockWhatsAppUsersError = ({
|
|
16535
|
+
error?: string;
|
|
16536
|
+
} | unknown);
|
|
16537
|
+
type GetWhatsAppDatasetData = {
|
|
16538
|
+
query: {
|
|
16539
|
+
/**
|
|
16540
|
+
* WhatsApp social account ID
|
|
16541
|
+
*/
|
|
16542
|
+
accountId: string;
|
|
16543
|
+
};
|
|
16544
|
+
};
|
|
16545
|
+
type GetWhatsAppDatasetResponse = ({
|
|
16546
|
+
/**
|
|
16547
|
+
* Meta dataset ID linked to the WABA, or null if not provisioned yet
|
|
16548
|
+
*/
|
|
16549
|
+
datasetId?: (string) | null;
|
|
16550
|
+
});
|
|
16551
|
+
type GetWhatsAppDatasetError = ({
|
|
16552
|
+
error?: string;
|
|
16553
|
+
} | unknown);
|
|
16554
|
+
type CreateWhatsAppDatasetData = {
|
|
16555
|
+
body: {
|
|
16556
|
+
/**
|
|
16557
|
+
* WhatsApp social account ID
|
|
16558
|
+
*/
|
|
16559
|
+
accountId: string;
|
|
16560
|
+
};
|
|
16561
|
+
};
|
|
16562
|
+
type CreateWhatsAppDatasetResponse = ({
|
|
16563
|
+
/**
|
|
16564
|
+
* Meta dataset ID linked to the WABA
|
|
16565
|
+
*/
|
|
16566
|
+
datasetId?: string;
|
|
16567
|
+
/**
|
|
16568
|
+
* True if Meta created a new dataset on this call; false if one already existed
|
|
16569
|
+
*/
|
|
16570
|
+
created?: boolean;
|
|
16571
|
+
});
|
|
16572
|
+
type CreateWhatsAppDatasetError = ({
|
|
16573
|
+
error?: string;
|
|
16574
|
+
} | unknown);
|
|
16575
|
+
type ListPhoneNumbersData = {
|
|
16576
|
+
query?: {
|
|
16577
|
+
/**
|
|
16578
|
+
* Filter by profile
|
|
16579
|
+
*/
|
|
16580
|
+
profileId?: string;
|
|
16581
|
+
/**
|
|
16582
|
+
* Filter by status (by default excludes released numbers). NOTE:
|
|
16583
|
+
* `status=pending_regulatory` returns the "provisioning" view — numbers
|
|
16584
|
+
* still in review PLUS recently-declined (last 30 days) ones, so a
|
|
16585
|
+
* failed registration surfaces (with `regulatoryDeclineReason`) instead
|
|
16586
|
+
* of silently disappearing. Declined numbers can be re-submitted via
|
|
16587
|
+
* POST /v1/phone-numbers/{id}/remediate. `verifying` is the
|
|
16588
|
+
* short-lived state after the number is provisioned on our side while
|
|
16589
|
+
* WhatsApp confirms the activation code; the number is not billed until
|
|
16590
|
+
* it reaches `active`.
|
|
16591
|
+
*
|
|
16592
|
+
*/
|
|
16593
|
+
status?: 'provisioning' | 'verifying' | 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16594
|
+
};
|
|
16595
|
+
};
|
|
16596
|
+
type ListPhoneNumbersResponse = ({
|
|
16597
|
+
numbers?: Array<{
|
|
16598
|
+
_id?: string;
|
|
16599
|
+
phoneNumber?: string;
|
|
16600
|
+
country?: string;
|
|
16601
|
+
status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16602
|
+
/**
|
|
16603
|
+
* For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
|
|
16604
|
+
*/
|
|
16605
|
+
registrantName?: (string) | null;
|
|
16606
|
+
/**
|
|
16607
|
+
* Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review.
|
|
16608
|
+
*/
|
|
16609
|
+
telnyxOrderId?: (string) | null;
|
|
16610
|
+
/**
|
|
16611
|
+
* Per-country monthly price in cents ($2..$25).
|
|
16612
|
+
*/
|
|
16613
|
+
monthlyCents?: number;
|
|
16614
|
+
/**
|
|
16615
|
+
* 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.
|
|
16616
|
+
*/
|
|
16617
|
+
hostedByZernio?: boolean;
|
|
16618
|
+
profileId?: {
|
|
16619
|
+
[key: string]: unknown;
|
|
16620
|
+
};
|
|
16621
|
+
provisionedAt?: string;
|
|
16622
|
+
metaPreverifiedId?: string;
|
|
16623
|
+
metaVerificationStatus?: string;
|
|
16624
|
+
/**
|
|
16625
|
+
* 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.
|
|
16626
|
+
*/
|
|
16627
|
+
onfidoVerificationUrl?: (string) | null;
|
|
16628
|
+
endUserFirstName?: (string) | null;
|
|
16629
|
+
endUserLastName?: (string) | null;
|
|
16630
|
+
/**
|
|
16631
|
+
* Reviewer rejection reason when status is regulatory_declined.
|
|
16632
|
+
*/
|
|
16633
|
+
regulatoryDeclineReason?: (string) | null;
|
|
16634
|
+
createdAt?: string;
|
|
16635
|
+
}>;
|
|
16636
|
+
/**
|
|
16637
|
+
* Connected (bring-your-own) WhatsApp numbers — your own WABA
|
|
16638
|
+
* numbers linked via Embedded Signup. Not provisioned or billed
|
|
16639
|
+
* by Zernio, so they are not in `numbers`; `accountId` is the
|
|
16640
|
+
* social-account id used by the messaging and inbox endpoints.
|
|
16641
|
+
* Included only on the default and `status=active` views.
|
|
16642
|
+
*
|
|
16643
|
+
*/
|
|
16644
|
+
connected?: Array<{
|
|
16645
|
+
accountId?: string;
|
|
16646
|
+
phoneNumber?: (string) | null;
|
|
16647
|
+
displayName?: (string) | null;
|
|
16648
|
+
profileId?: (string) | null;
|
|
16649
|
+
connectedAt?: (string) | null;
|
|
16650
|
+
}>;
|
|
16651
|
+
/**
|
|
16652
|
+
* The shared WhatsApp sandbox (one Zernio-owned number, all users test
|
|
16653
|
+
* against it). Present when the sandbox is configured; null otherwise.
|
|
16654
|
+
* The `accountId` lets you address the sandbox in compose endpoints.
|
|
16655
|
+
* `template` is the only template a sandbox send is allowed to use.
|
|
16656
|
+
*
|
|
16657
|
+
*/
|
|
16658
|
+
sandbox?: {
|
|
16659
|
+
phoneNumber?: string;
|
|
16660
|
+
accountId?: (string) | null;
|
|
16661
|
+
template?: {
|
|
16662
|
+
name?: string;
|
|
16663
|
+
language?: string;
|
|
16664
|
+
};
|
|
16665
|
+
isSandbox?: boolean;
|
|
16666
|
+
} | null;
|
|
16667
|
+
});
|
|
16668
|
+
type ListPhoneNumbersError = ({
|
|
16669
|
+
error?: string;
|
|
16670
|
+
});
|
|
16671
|
+
type GetPhoneNumberData = {
|
|
16672
|
+
path: {
|
|
16673
|
+
/**
|
|
16674
|
+
* Phone number record ID
|
|
16675
|
+
*/
|
|
16676
|
+
id: string;
|
|
16677
|
+
};
|
|
16678
|
+
};
|
|
16679
|
+
type GetPhoneNumberResponse = ({
|
|
16680
|
+
phoneNumber?: {
|
|
16681
|
+
id?: string;
|
|
16682
|
+
phoneNumber?: string;
|
|
16683
|
+
status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16684
|
+
country?: string;
|
|
16685
|
+
metaPreverifiedId?: string;
|
|
16686
|
+
metaVerificationStatus?: string;
|
|
16687
|
+
/**
|
|
16688
|
+
* 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.
|
|
16689
|
+
*/
|
|
16690
|
+
onfidoVerificationUrl?: (string) | null;
|
|
16691
|
+
endUserFirstName?: (string) | null;
|
|
16692
|
+
endUserLastName?: (string) | null;
|
|
16693
|
+
/**
|
|
16694
|
+
* Reviewer rejection reason when status is regulatory_declined.
|
|
16695
|
+
*/
|
|
16696
|
+
regulatoryDeclineReason?: (string) | null;
|
|
16697
|
+
provisionedAt?: string;
|
|
16698
|
+
};
|
|
16699
|
+
});
|
|
16700
|
+
type GetPhoneNumberError = ({
|
|
16701
|
+
error?: string;
|
|
16702
|
+
});
|
|
16703
|
+
type ReleasePhoneNumberData = {
|
|
16704
|
+
path: {
|
|
16705
|
+
/**
|
|
16706
|
+
* Phone number record ID
|
|
16707
|
+
*/
|
|
16708
|
+
id: string;
|
|
16709
|
+
};
|
|
16710
|
+
};
|
|
16711
|
+
type ReleasePhoneNumberResponse = ({
|
|
16712
|
+
message?: string;
|
|
16713
|
+
phoneNumber?: {
|
|
16714
|
+
id?: string;
|
|
16715
|
+
phoneNumber?: string;
|
|
16716
|
+
/**
|
|
16717
|
+
* "released"
|
|
16718
|
+
*/
|
|
16719
|
+
status?: string;
|
|
16720
|
+
releasedAt?: string;
|
|
16721
|
+
};
|
|
16722
|
+
});
|
|
16723
|
+
type ReleasePhoneNumberError = (unknown | {
|
|
16724
|
+
error?: string;
|
|
16725
|
+
});
|
|
16726
|
+
type PurchasePhoneNumberData = {
|
|
16727
|
+
body: {
|
|
16728
|
+
/**
|
|
16729
|
+
* Profile to associate the number with
|
|
16730
|
+
*/
|
|
16731
|
+
profileId: string;
|
|
16732
|
+
/**
|
|
16733
|
+
* 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.
|
|
16734
|
+
*
|
|
16735
|
+
*/
|
|
16736
|
+
country?: string;
|
|
16737
|
+
/**
|
|
16738
|
+
* 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.
|
|
16739
|
+
*
|
|
16740
|
+
*/
|
|
16741
|
+
connectWhatsapp?: boolean;
|
|
16742
|
+
/**
|
|
16743
|
+
* 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).
|
|
16744
|
+
*
|
|
16745
|
+
*/
|
|
16746
|
+
wantsSms?: boolean;
|
|
16747
|
+
/**
|
|
16748
|
+
* 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.
|
|
16749
|
+
*
|
|
16750
|
+
*/
|
|
16751
|
+
purchaseIntentId?: string;
|
|
16752
|
+
/**
|
|
16753
|
+
* 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).
|
|
16754
|
+
*
|
|
16755
|
+
*/
|
|
16756
|
+
allowMultiple?: boolean;
|
|
16757
|
+
};
|
|
16758
|
+
};
|
|
16759
|
+
type PurchasePhoneNumberResponse = (({
|
|
16760
|
+
message?: string;
|
|
16761
|
+
checkoutUrl?: string;
|
|
16762
|
+
} | {
|
|
16763
|
+
message?: string;
|
|
16764
|
+
phoneNumber?: {
|
|
16765
|
+
id?: string;
|
|
16766
|
+
phoneNumber?: string;
|
|
16767
|
+
status?: string;
|
|
16768
|
+
country?: string;
|
|
16769
|
+
provisionedAt?: string;
|
|
16770
|
+
metaPreverifiedId?: string;
|
|
16771
|
+
metaVerificationStatus?: string;
|
|
16772
|
+
};
|
|
16773
|
+
} | {
|
|
16774
|
+
status?: 'already_purchased';
|
|
16775
|
+
numberId?: string;
|
|
16776
|
+
phoneNumber?: string;
|
|
16777
|
+
}) | {
|
|
16778
|
+
status?: 'kyc_required';
|
|
16779
|
+
country?: string;
|
|
16780
|
+
kycUrl?: string;
|
|
16781
|
+
});
|
|
16782
|
+
type PurchasePhoneNumberError = (unknown | {
|
|
16783
|
+
error?: string;
|
|
16784
|
+
} | {
|
|
16785
|
+
error?: string;
|
|
16786
|
+
code?: 'PURCHASE_VELOCITY';
|
|
16787
|
+
});
|
|
16788
|
+
type ListPhoneNumberCountriesResponse = ({
|
|
16789
|
+
countries?: Array<{
|
|
16790
|
+
/**
|
|
16791
|
+
* ISO 3166-1 alpha-2
|
|
16792
|
+
*/
|
|
16793
|
+
code?: string;
|
|
16794
|
+
tier?: 1 | 2 | 3 | 4;
|
|
16795
|
+
monthlyCents?: number;
|
|
16796
|
+
needsKyc?: boolean;
|
|
16797
|
+
/**
|
|
16798
|
+
* Regular phone (PSTN) calling on the number, inbound + outbound. Available on every offerable country.
|
|
16799
|
+
*/
|
|
16800
|
+
callsAvailable?: boolean;
|
|
16801
|
+
/**
|
|
16802
|
+
* WhatsApp can be enabled on numbers from this country.
|
|
16803
|
+
*/
|
|
16804
|
+
whatsappAvailable?: boolean;
|
|
16805
|
+
/**
|
|
16806
|
+
* 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).
|
|
16807
|
+
*/
|
|
16808
|
+
smsAvailable?: boolean;
|
|
16809
|
+
/**
|
|
16810
|
+
* WhatsApp Business Calling (BIC) outbound availability, a Meta feature blocked in some countries. NOT the PSTN Calls feature (`callsAvailable`).
|
|
16811
|
+
*/
|
|
16812
|
+
outboundCallingAvailable?: boolean;
|
|
16813
|
+
}>;
|
|
16814
|
+
});
|
|
16815
|
+
type ListPhoneNumberCountriesError = ({
|
|
16816
|
+
error?: string;
|
|
16817
|
+
});
|
|
16818
|
+
type SearchAvailablePhoneNumbersData = {
|
|
16819
|
+
query?: {
|
|
16820
|
+
/**
|
|
16821
|
+
* Pattern to match within the number
|
|
16822
|
+
*/
|
|
16823
|
+
contains?: string;
|
|
16824
|
+
country?: string;
|
|
16825
|
+
limit?: number;
|
|
16826
|
+
/**
|
|
16827
|
+
* City
|
|
16828
|
+
*/
|
|
16829
|
+
locality?: string;
|
|
16830
|
+
/**
|
|
16831
|
+
* Area code
|
|
16832
|
+
*/
|
|
16833
|
+
prefix?: string;
|
|
16834
|
+
/**
|
|
16835
|
+
* true narrows the pool to SMS-capable numbers. Each result still carries its full `features` list for per-number capability badging.
|
|
16836
|
+
*/
|
|
16837
|
+
sms?: boolean;
|
|
16838
|
+
/**
|
|
16839
|
+
* Number type; defaults to the country's WhatsApp-safe type
|
|
16840
|
+
*/
|
|
16841
|
+
type?: string;
|
|
16842
|
+
};
|
|
16843
|
+
};
|
|
16844
|
+
type SearchAvailablePhoneNumbersResponse = ({
|
|
16845
|
+
country?: string;
|
|
16846
|
+
numberType?: string;
|
|
16847
|
+
/**
|
|
16848
|
+
* Echo of the `sms` filter applied to this search.
|
|
16849
|
+
*/
|
|
16850
|
+
requireSms?: boolean;
|
|
16851
|
+
numbers?: Array<{
|
|
16852
|
+
phoneNumber?: string;
|
|
16853
|
+
/**
|
|
16854
|
+
* Provider capability list for this number (e.g. voice, sms, mms).
|
|
16855
|
+
*/
|
|
16856
|
+
features?: Array<(string)>;
|
|
16857
|
+
}>;
|
|
16858
|
+
});
|
|
16859
|
+
type SearchAvailablePhoneNumbersError = (unknown | {
|
|
16860
|
+
error?: string;
|
|
16861
|
+
});
|
|
16862
|
+
type CheckPhoneNumberAvailabilityData = {
|
|
16863
|
+
query: {
|
|
16864
|
+
/**
|
|
16865
|
+
* ISO-2 country code.
|
|
16866
|
+
*/
|
|
16867
|
+
country: string;
|
|
16868
|
+
};
|
|
16869
|
+
};
|
|
16870
|
+
type CheckPhoneNumberAvailabilityResponse = ({
|
|
16871
|
+
country?: string;
|
|
16872
|
+
numberType?: string;
|
|
16873
|
+
/**
|
|
16874
|
+
* Whether deliverable voice inventory exists right now.
|
|
16875
|
+
*/
|
|
16876
|
+
available?: boolean;
|
|
16877
|
+
addressConstraint?: 'geo' | 'country' | 'none';
|
|
16878
|
+
/**
|
|
16879
|
+
* For `geo` only — the area(s) the registered address must be in.
|
|
16880
|
+
*/
|
|
16881
|
+
areas?: Array<(string)>;
|
|
16882
|
+
});
|
|
16883
|
+
type CheckPhoneNumberAvailabilityError = (unknown | {
|
|
16884
|
+
error?: string;
|
|
16885
|
+
});
|
|
16886
|
+
type GetWhatsAppPhoneNumbersData = {
|
|
16887
|
+
query?: {
|
|
16888
|
+
/**
|
|
16889
|
+
* Filter by profile
|
|
16890
|
+
*/
|
|
16891
|
+
profileId?: string;
|
|
16892
|
+
/**
|
|
16893
|
+
* Filter by status (by default excludes released numbers). NOTE:
|
|
16894
|
+
* `status=pending_regulatory` returns the "provisioning" view — numbers
|
|
16895
|
+
* still in review PLUS recently-declined (last 30 days) ones, so a
|
|
16896
|
+
* failed registration surfaces (with `regulatoryDeclineReason`) instead
|
|
16897
|
+
* of silently disappearing. Declined numbers can be re-submitted via
|
|
16898
|
+
* POST /v1/whatsapp/phone-numbers/{id}/remediate. `verifying` is the
|
|
16899
|
+
* short-lived state after the number is provisioned on our side while
|
|
16900
|
+
* WhatsApp confirms the activation code; the number is not billed until
|
|
16901
|
+
* it reaches `active`.
|
|
16902
|
+
*
|
|
16903
|
+
*/
|
|
16904
|
+
status?: 'provisioning' | 'verifying' | 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16905
|
+
};
|
|
16906
|
+
};
|
|
16907
|
+
type GetWhatsAppPhoneNumbersResponse = ({
|
|
16908
|
+
numbers?: Array<{
|
|
16909
|
+
_id?: string;
|
|
16910
|
+
phoneNumber?: string;
|
|
16911
|
+
country?: string;
|
|
16912
|
+
status?: 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
16913
|
+
/**
|
|
16914
|
+
* For regulated numbers, who it's registered for (company or person) — set from the submitted KYC.
|
|
16915
|
+
*/
|
|
16916
|
+
registrantName?: (string) | null;
|
|
16917
|
+
/**
|
|
16918
|
+
* Present once the number order has been placed (i.e. the requirement group was approved). Absent while still in identity review.
|
|
16919
|
+
*/
|
|
16920
|
+
telnyxOrderId?: (string) | null;
|
|
16921
|
+
/**
|
|
16922
|
+
* Per-country monthly price in cents ($2..$25).
|
|
16923
|
+
*/
|
|
16924
|
+
monthlyCents?: number;
|
|
16925
|
+
/**
|
|
16926
|
+
* 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.
|
|
16927
|
+
*/
|
|
16928
|
+
hostedByZernio?: boolean;
|
|
16929
|
+
profileId?: {
|
|
16930
|
+
[key: string]: unknown;
|
|
16931
|
+
};
|
|
16932
|
+
provisionedAt?: string;
|
|
16933
|
+
metaPreverifiedId?: string;
|
|
16934
|
+
metaVerificationStatus?: string;
|
|
16935
|
+
/**
|
|
16936
|
+
* 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.
|
|
16937
|
+
*/
|
|
16938
|
+
onfidoVerificationUrl?: (string) | null;
|
|
16939
|
+
endUserFirstName?: (string) | null;
|
|
16940
|
+
endUserLastName?: (string) | null;
|
|
16941
|
+
/**
|
|
16942
|
+
* Reviewer rejection reason when status is regulatory_declined.
|
|
16943
|
+
*/
|
|
16944
|
+
regulatoryDeclineReason?: (string) | null;
|
|
16945
|
+
createdAt?: string;
|
|
16946
|
+
}>;
|
|
16947
|
+
/**
|
|
16948
|
+
* Connected (bring-your-own) WhatsApp numbers — your own WABA
|
|
16949
|
+
* numbers linked via Embedded Signup. Not provisioned or billed
|
|
16950
|
+
* by Zernio, so they are not in `numbers`; `accountId` is the
|
|
16951
|
+
* social-account id used by the messaging and inbox endpoints.
|
|
16952
|
+
* Included only on the default and `status=active` views.
|
|
16953
|
+
*
|
|
16954
|
+
*/
|
|
16955
|
+
connected?: Array<{
|
|
16956
|
+
accountId?: string;
|
|
16957
|
+
phoneNumber?: (string) | null;
|
|
16958
|
+
displayName?: (string) | null;
|
|
16959
|
+
profileId?: (string) | null;
|
|
16960
|
+
connectedAt?: (string) | null;
|
|
16961
|
+
}>;
|
|
16962
|
+
/**
|
|
16963
|
+
* The shared WhatsApp sandbox (one Zernio-owned number, all users test
|
|
16964
|
+
* against it). Present when the sandbox is configured; null otherwise.
|
|
16965
|
+
* The `accountId` lets you address the sandbox in compose endpoints.
|
|
16966
|
+
* `template` is the only template a sandbox send is allowed to use.
|
|
16967
|
+
*
|
|
16968
|
+
*/
|
|
16969
|
+
sandbox?: {
|
|
16970
|
+
phoneNumber?: string;
|
|
16971
|
+
accountId?: (string) | null;
|
|
16972
|
+
template?: {
|
|
16973
|
+
name?: string;
|
|
16974
|
+
language?: string;
|
|
16975
|
+
};
|
|
16976
|
+
isSandbox?: boolean;
|
|
16977
|
+
} | null;
|
|
16978
|
+
});
|
|
16979
|
+
type GetWhatsAppPhoneNumbersError = ({
|
|
16980
|
+
error?: string;
|
|
16981
|
+
});
|
|
16982
|
+
type PurchaseWhatsAppPhoneNumberData = {
|
|
16983
|
+
body: {
|
|
16984
|
+
/**
|
|
16985
|
+
* Profile to associate the number with
|
|
16986
|
+
*/
|
|
16987
|
+
profileId: string;
|
|
16988
|
+
/**
|
|
16989
|
+
* 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.
|
|
16990
|
+
*
|
|
16991
|
+
*/
|
|
16992
|
+
country?: string;
|
|
16993
|
+
/**
|
|
16994
|
+
* 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.
|
|
16995
|
+
*
|
|
16996
|
+
*/
|
|
16997
|
+
purchaseIntentId?: string;
|
|
16998
|
+
/**
|
|
16999
|
+
* 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).
|
|
17000
|
+
*
|
|
17001
|
+
*/
|
|
17002
|
+
allowMultiple?: boolean;
|
|
17003
|
+
};
|
|
17004
|
+
};
|
|
17005
|
+
type PurchaseWhatsAppPhoneNumberResponse = (({
|
|
17006
|
+
message?: string;
|
|
17007
|
+
checkoutUrl?: string;
|
|
17008
|
+
} | {
|
|
17009
|
+
message?: string;
|
|
17010
|
+
phoneNumber?: {
|
|
17011
|
+
id?: string;
|
|
17012
|
+
phoneNumber?: string;
|
|
17013
|
+
status?: string;
|
|
17014
|
+
country?: string;
|
|
17015
|
+
provisionedAt?: string;
|
|
17016
|
+
metaPreverifiedId?: string;
|
|
17017
|
+
metaVerificationStatus?: string;
|
|
17018
|
+
};
|
|
17019
|
+
} | {
|
|
17020
|
+
status?: 'already_purchased';
|
|
17021
|
+
numberId?: string;
|
|
17022
|
+
phoneNumber?: string;
|
|
17023
|
+
}) | {
|
|
17024
|
+
status?: 'kyc_required';
|
|
17025
|
+
country?: string;
|
|
17026
|
+
kycUrl?: string;
|
|
17027
|
+
});
|
|
17028
|
+
type PurchaseWhatsAppPhoneNumberError = (unknown | {
|
|
17029
|
+
error?: string;
|
|
17030
|
+
} | {
|
|
17031
|
+
error?: string;
|
|
17032
|
+
code?: 'PURCHASE_VELOCITY';
|
|
17033
|
+
});
|
|
17034
|
+
type ListWhatsAppNumberCountriesResponse = ({
|
|
17035
|
+
countries?: Array<{
|
|
17036
|
+
/**
|
|
17037
|
+
* ISO 3166-1 alpha-2
|
|
17038
|
+
*/
|
|
17039
|
+
code?: string;
|
|
17040
|
+
tier?: 1 | 2 | 3 | 4;
|
|
17041
|
+
monthlyCents?: number;
|
|
17042
|
+
needsKyc?: boolean;
|
|
17043
|
+
outboundCallingAvailable?: boolean;
|
|
17044
|
+
}>;
|
|
17045
|
+
});
|
|
17046
|
+
type ListWhatsAppNumberCountriesError = ({
|
|
17047
|
+
error?: string;
|
|
17048
|
+
});
|
|
17049
|
+
type SearchAvailableWhatsAppNumbersData = {
|
|
17050
|
+
query?: {
|
|
17051
|
+
/**
|
|
17052
|
+
* Pattern to match within the number
|
|
17053
|
+
*/
|
|
17054
|
+
contains?: string;
|
|
17055
|
+
country?: string;
|
|
17056
|
+
limit?: number;
|
|
17057
|
+
/**
|
|
17058
|
+
* City
|
|
17059
|
+
*/
|
|
17060
|
+
locality?: string;
|
|
17061
|
+
/**
|
|
17062
|
+
* Area code
|
|
17063
|
+
*/
|
|
17064
|
+
prefix?: string;
|
|
17065
|
+
/**
|
|
17066
|
+
* Number type; defaults to the country's WhatsApp-safe type
|
|
17067
|
+
*/
|
|
17068
|
+
type?: string;
|
|
17069
|
+
};
|
|
17070
|
+
};
|
|
17071
|
+
type SearchAvailableWhatsAppNumbersResponse = ({
|
|
17072
|
+
country?: string;
|
|
17073
|
+
numberType?: string;
|
|
17074
|
+
numbers?: Array<{
|
|
17075
|
+
phoneNumber?: string;
|
|
17076
|
+
}>;
|
|
17077
|
+
});
|
|
17078
|
+
type SearchAvailableWhatsAppNumbersError = (unknown | {
|
|
17079
|
+
error?: string;
|
|
17080
|
+
});
|
|
17081
|
+
type CheckWhatsAppNumberAvailabilityData = {
|
|
17082
|
+
query: {
|
|
17083
|
+
/**
|
|
17084
|
+
* ISO-2 country code.
|
|
17085
|
+
*/
|
|
17086
|
+
country: string;
|
|
17087
|
+
};
|
|
17088
|
+
};
|
|
17089
|
+
type CheckWhatsAppNumberAvailabilityResponse = ({
|
|
17090
|
+
country?: string;
|
|
17091
|
+
numberType?: string;
|
|
15585
17092
|
/**
|
|
15586
|
-
*
|
|
17093
|
+
* Whether deliverable voice inventory exists right now.
|
|
17094
|
+
*/
|
|
17095
|
+
available?: boolean;
|
|
17096
|
+
addressConstraint?: 'geo' | 'country' | 'none';
|
|
17097
|
+
/**
|
|
17098
|
+
* For `geo` only — the area(s) the registered address must be in.
|
|
17099
|
+
*/
|
|
17100
|
+
areas?: Array<(string)>;
|
|
17101
|
+
});
|
|
17102
|
+
type CheckWhatsAppNumberAvailabilityError = (unknown | {
|
|
17103
|
+
error?: string;
|
|
17104
|
+
});
|
|
17105
|
+
type GetPhoneNumberKycFormData = {
|
|
17106
|
+
query: {
|
|
17107
|
+
country: string;
|
|
17108
|
+
};
|
|
17109
|
+
};
|
|
17110
|
+
type GetPhoneNumberKycFormResponse = ({
|
|
17111
|
+
country?: string;
|
|
17112
|
+
numberType?: string;
|
|
17113
|
+
fields?: Array<{
|
|
17114
|
+
requirementId?: string;
|
|
17115
|
+
label?: string;
|
|
17116
|
+
/**
|
|
17117
|
+
* "action" = an out-of-band verification (e.g. Onfido); not filled here, fulfilled after the order via a link.
|
|
17118
|
+
*/
|
|
17119
|
+
kind?: 'text' | 'date' | 'address' | 'file' | 'action';
|
|
17120
|
+
/**
|
|
17121
|
+
* Plain-English explanation of what to provide.
|
|
17122
|
+
*/
|
|
17123
|
+
description?: (string) | null;
|
|
17124
|
+
/**
|
|
17125
|
+
* Concrete example value.
|
|
17126
|
+
*/
|
|
17127
|
+
example?: (string) | null;
|
|
17128
|
+
/**
|
|
17129
|
+
* ISO country the value must be local to
|
|
17130
|
+
*/
|
|
17131
|
+
localTo?: (string) | null;
|
|
17132
|
+
}>;
|
|
17133
|
+
/**
|
|
17134
|
+
* 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.
|
|
17135
|
+
*/
|
|
17136
|
+
reusable?: {
|
|
17137
|
+
available?: boolean;
|
|
17138
|
+
fromPhoneNumber?: string;
|
|
17139
|
+
/**
|
|
17140
|
+
* 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.
|
|
17141
|
+
*/
|
|
17142
|
+
details?: Array<{
|
|
17143
|
+
label?: string;
|
|
17144
|
+
value?: string;
|
|
17145
|
+
}>;
|
|
17146
|
+
/**
|
|
17147
|
+
* One entry per distinct approved verification, newest first.
|
|
17148
|
+
*/
|
|
17149
|
+
options?: Array<{
|
|
17150
|
+
fromPhoneNumber?: string;
|
|
17151
|
+
details?: Array<{
|
|
17152
|
+
label?: string;
|
|
17153
|
+
value?: string;
|
|
17154
|
+
}>;
|
|
17155
|
+
}>;
|
|
17156
|
+
} | null;
|
|
17157
|
+
});
|
|
17158
|
+
type GetPhoneNumberKycFormError = (unknown | {
|
|
17159
|
+
error?: string;
|
|
17160
|
+
});
|
|
17161
|
+
type SubmitPhoneNumberKycData = {
|
|
17162
|
+
body: {
|
|
17163
|
+
profileId: string;
|
|
17164
|
+
country: string;
|
|
17165
|
+
/**
|
|
17166
|
+
* 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.
|
|
17167
|
+
*/
|
|
17168
|
+
submissionId?: string;
|
|
17169
|
+
/**
|
|
17170
|
+
* 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).
|
|
17171
|
+
*/
|
|
17172
|
+
quantity?: number;
|
|
17173
|
+
/**
|
|
17174
|
+
* Reuse a prior approved verification for this country (skips document/field collection; places the order immediately).
|
|
17175
|
+
*/
|
|
17176
|
+
reuse?: boolean;
|
|
17177
|
+
/**
|
|
17178
|
+
* 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.
|
|
17179
|
+
*/
|
|
17180
|
+
reuseFrom?: string;
|
|
17181
|
+
/**
|
|
17182
|
+
* End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
|
|
17183
|
+
*/
|
|
17184
|
+
endUserFirstName?: string;
|
|
17185
|
+
/**
|
|
17186
|
+
* End user's legal last name. Same condition as endUserFirstName.
|
|
17187
|
+
*/
|
|
17188
|
+
endUserLastName?: string;
|
|
17189
|
+
/**
|
|
17190
|
+
* requirementId → textual value
|
|
17191
|
+
*/
|
|
17192
|
+
values?: {
|
|
17193
|
+
[key: string]: (string);
|
|
17194
|
+
};
|
|
17195
|
+
/**
|
|
17196
|
+
* 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).
|
|
17197
|
+
*/
|
|
17198
|
+
documents?: Array<({
|
|
17199
|
+
requirementId: string;
|
|
17200
|
+
filename: string;
|
|
17201
|
+
base64: string;
|
|
17202
|
+
} | {
|
|
17203
|
+
requirementId: string;
|
|
17204
|
+
/**
|
|
17205
|
+
* Id from POST /v1/phone-numbers/kyc/upload-document.
|
|
17206
|
+
*/
|
|
17207
|
+
documentId: string;
|
|
17208
|
+
})>;
|
|
17209
|
+
address?: {
|
|
17210
|
+
requirementId?: string;
|
|
17211
|
+
country_code?: string;
|
|
17212
|
+
business_name?: string;
|
|
17213
|
+
first_name?: string;
|
|
17214
|
+
last_name?: string;
|
|
17215
|
+
street_address?: string;
|
|
17216
|
+
locality?: string;
|
|
17217
|
+
administrative_area?: string;
|
|
17218
|
+
postal_code?: string;
|
|
17219
|
+
};
|
|
17220
|
+
};
|
|
17221
|
+
};
|
|
17222
|
+
type SubmitPhoneNumberKycResponse = ({
|
|
17223
|
+
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
17224
|
+
/**
|
|
17225
|
+
* The first/primary number, kept at the top level for backward compatibility. See `numbers` for the full set when `quantity` > 1.
|
|
17226
|
+
*/
|
|
17227
|
+
phoneNumber?: {
|
|
17228
|
+
id?: string;
|
|
17229
|
+
status?: string;
|
|
17230
|
+
country?: string;
|
|
17231
|
+
};
|
|
17232
|
+
/**
|
|
17233
|
+
* 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`.
|
|
17234
|
+
*/
|
|
17235
|
+
numbers?: Array<{
|
|
17236
|
+
id?: string;
|
|
17237
|
+
status?: string;
|
|
17238
|
+
phoneNumber?: string;
|
|
17239
|
+
country?: string;
|
|
17240
|
+
}>;
|
|
17241
|
+
});
|
|
17242
|
+
type SubmitPhoneNumberKycError = (unknown | {
|
|
17243
|
+
error?: string;
|
|
17244
|
+
});
|
|
17245
|
+
type UploadPhoneNumberKycDocumentData = {
|
|
17246
|
+
body: (Blob | File);
|
|
17247
|
+
headers: {
|
|
17248
|
+
/**
|
|
17249
|
+
* URL-encoded original filename.
|
|
17250
|
+
*/
|
|
17251
|
+
'X-Filename': string;
|
|
17252
|
+
};
|
|
17253
|
+
};
|
|
17254
|
+
type UploadPhoneNumberKycDocumentResponse = ({
|
|
17255
|
+
/**
|
|
17256
|
+
* Reference this id in the KYC submit's documents[].documentId.
|
|
15587
17257
|
*/
|
|
15588
|
-
|
|
17258
|
+
documentId?: string;
|
|
15589
17259
|
});
|
|
15590
|
-
type
|
|
17260
|
+
type UploadPhoneNumberKycDocumentError = (unknown | {
|
|
15591
17261
|
error?: string;
|
|
15592
|
-
}
|
|
15593
|
-
type
|
|
17262
|
+
});
|
|
17263
|
+
type ValidatePhoneNumberKycAddressData = {
|
|
15594
17264
|
body: {
|
|
15595
17265
|
/**
|
|
15596
|
-
*
|
|
17266
|
+
* ISO 3166-1 alpha-2 country code.
|
|
15597
17267
|
*/
|
|
15598
|
-
|
|
17268
|
+
country: string;
|
|
17269
|
+
street_address: string;
|
|
17270
|
+
/**
|
|
17271
|
+
* City / town.
|
|
17272
|
+
*/
|
|
17273
|
+
locality: string;
|
|
17274
|
+
/**
|
|
17275
|
+
* State / province / region. When omitted, the pre-check is skipped (the final submit still validates).
|
|
17276
|
+
*/
|
|
17277
|
+
administrative_area?: string;
|
|
17278
|
+
postal_code: string;
|
|
15599
17279
|
};
|
|
15600
17280
|
};
|
|
15601
|
-
type
|
|
17281
|
+
type ValidatePhoneNumberKycAddressResponse = ({
|
|
17282
|
+
ok?: boolean;
|
|
15602
17283
|
/**
|
|
15603
|
-
*
|
|
17284
|
+
* true when no `administrative_area` was supplied, so no pre-check ran.
|
|
15604
17285
|
*/
|
|
15605
|
-
|
|
17286
|
+
skipped?: boolean;
|
|
17287
|
+
});
|
|
17288
|
+
type ValidatePhoneNumberKycAddressError = ({
|
|
15606
17289
|
/**
|
|
15607
|
-
*
|
|
17290
|
+
* Human-readable message.
|
|
15608
17291
|
*/
|
|
15609
|
-
created?: boolean;
|
|
15610
|
-
});
|
|
15611
|
-
type CreateWhatsAppDatasetError = ({
|
|
15612
17292
|
error?: string;
|
|
15613
|
-
|
|
15614
|
-
|
|
15615
|
-
|
|
17293
|
+
type?: string;
|
|
17294
|
+
code?: string;
|
|
17295
|
+
param?: string;
|
|
17296
|
+
details?: {
|
|
17297
|
+
addressSuggestions?: Array<{
|
|
17298
|
+
field?: string;
|
|
17299
|
+
label?: string;
|
|
17300
|
+
value?: string;
|
|
17301
|
+
}>;
|
|
17302
|
+
};
|
|
17303
|
+
} | {
|
|
17304
|
+
error?: string;
|
|
17305
|
+
});
|
|
17306
|
+
type CreatePhoneNumberKycLinkData = {
|
|
17307
|
+
body: {
|
|
17308
|
+
profileId: string;
|
|
15616
17309
|
/**
|
|
15617
|
-
*
|
|
17310
|
+
* ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).
|
|
15618
17311
|
*/
|
|
15619
|
-
|
|
17312
|
+
country: string;
|
|
15620
17313
|
/**
|
|
15621
|
-
*
|
|
15622
|
-
|
|
15623
|
-
|
|
15624
|
-
|
|
15625
|
-
|
|
15626
|
-
|
|
15627
|
-
|
|
15628
|
-
|
|
15629
|
-
|
|
17314
|
+
* Optional white-label of the hosted page the end customer sees.
|
|
17315
|
+
*/
|
|
17316
|
+
branding?: {
|
|
17317
|
+
/**
|
|
17318
|
+
* Your company name, shown on the hosted page.
|
|
17319
|
+
*/
|
|
17320
|
+
companyName?: string;
|
|
17321
|
+
/**
|
|
17322
|
+
* Logo shown above the form.
|
|
17323
|
+
*/
|
|
17324
|
+
logoUrl?: string;
|
|
17325
|
+
/**
|
|
17326
|
+
* Hex color (e.g. #1a73e8) used as a brand accent on the page.
|
|
17327
|
+
*/
|
|
17328
|
+
brandColor?: string;
|
|
17329
|
+
};
|
|
17330
|
+
/**
|
|
17331
|
+
* Where to send the end customer's browser after a successful
|
|
17332
|
+
* submit. On completion Zernio appends `kyc=submitted` and
|
|
17333
|
+
* `country=<ISO-2>` as query params. When omitted, the hosted
|
|
17334
|
+
* page shows a built-in confirmation screen instead.
|
|
15630
17335
|
*
|
|
15631
17336
|
*/
|
|
15632
|
-
|
|
17337
|
+
redirect_url?: string;
|
|
15633
17338
|
};
|
|
15634
17339
|
};
|
|
15635
|
-
type
|
|
15636
|
-
|
|
15637
|
-
|
|
15638
|
-
|
|
15639
|
-
|
|
15640
|
-
|
|
17340
|
+
type CreatePhoneNumberKycLinkResponse = ({
|
|
17341
|
+
/**
|
|
17342
|
+
* The hosted link to send your end customer.
|
|
17343
|
+
*/
|
|
17344
|
+
url?: string;
|
|
17345
|
+
token?: string;
|
|
17346
|
+
expiresAt?: string;
|
|
17347
|
+
});
|
|
17348
|
+
type CreatePhoneNumberKycLinkError = (unknown | {
|
|
17349
|
+
error?: string;
|
|
17350
|
+
});
|
|
17351
|
+
type CreatePhoneNumberPortInData = {
|
|
17352
|
+
body: {
|
|
15641
17353
|
/**
|
|
15642
|
-
*
|
|
17354
|
+
* E.164 numbers to port in.
|
|
15643
17355
|
*/
|
|
15644
|
-
|
|
17356
|
+
phoneNumbers: Array<(string)>;
|
|
15645
17357
|
/**
|
|
15646
|
-
*
|
|
17358
|
+
* End-user / current-carrier account info that authorizes the port.
|
|
15647
17359
|
*/
|
|
15648
|
-
|
|
17360
|
+
endUser: {
|
|
17361
|
+
entityName: string;
|
|
17362
|
+
authPersonName: string;
|
|
17363
|
+
billingPhoneNumber?: string;
|
|
17364
|
+
accountNumber?: string;
|
|
17365
|
+
/**
|
|
17366
|
+
* Transfer PIN. Forwarded to the carrier, never stored.
|
|
17367
|
+
*/
|
|
17368
|
+
pinPasscode?: string;
|
|
17369
|
+
streetAddress: string;
|
|
17370
|
+
extendedAddress?: string;
|
|
17371
|
+
locality: string;
|
|
17372
|
+
administrativeArea: string;
|
|
17373
|
+
postalCode: string;
|
|
17374
|
+
countryCode: string;
|
|
17375
|
+
};
|
|
15649
17376
|
/**
|
|
15650
|
-
*
|
|
17377
|
+
* Document id from POST /v1/phone-numbers/port-in/documents (kind=loa).
|
|
15651
17378
|
*/
|
|
15652
|
-
|
|
15653
|
-
profileId?: {
|
|
15654
|
-
[key: string]: unknown;
|
|
15655
|
-
};
|
|
15656
|
-
provisionedAt?: string;
|
|
15657
|
-
metaPreverifiedId?: string;
|
|
15658
|
-
metaVerificationStatus?: string;
|
|
17379
|
+
loaDocumentId: string;
|
|
15659
17380
|
/**
|
|
15660
|
-
*
|
|
17381
|
+
* Document id from POST /v1/phone-numbers/port-in/documents (kind=invoice).
|
|
15661
17382
|
*/
|
|
15662
|
-
|
|
15663
|
-
endUserFirstName?: (string) | null;
|
|
15664
|
-
endUserLastName?: (string) | null;
|
|
17383
|
+
invoiceDocumentId: string;
|
|
15665
17384
|
/**
|
|
15666
|
-
*
|
|
17385
|
+
* Requested port date; the carrier confirms the actual FOC later.
|
|
15667
17386
|
*/
|
|
15668
|
-
|
|
15669
|
-
|
|
15670
|
-
}
|
|
17387
|
+
focDatetimeRequested?: string;
|
|
17388
|
+
customerReference?: string;
|
|
17389
|
+
};
|
|
17390
|
+
};
|
|
17391
|
+
type CreatePhoneNumberPortInResponse = ({
|
|
15671
17392
|
/**
|
|
15672
|
-
*
|
|
15673
|
-
* numbers linked via Embedded Signup. Not provisioned or billed
|
|
15674
|
-
* by Zernio, so they are not in `numbers`; `accountId` is the
|
|
15675
|
-
* social-account id used by the messaging and inbox endpoints.
|
|
15676
|
-
* Included only on the default and `status=active` views.
|
|
15677
|
-
*
|
|
17393
|
+
* Porting order ID.
|
|
15678
17394
|
*/
|
|
15679
|
-
|
|
15680
|
-
|
|
15681
|
-
|
|
15682
|
-
|
|
15683
|
-
|
|
15684
|
-
|
|
17395
|
+
id?: string;
|
|
17396
|
+
telnyxPortingOrderId?: string;
|
|
17397
|
+
status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
|
|
17398
|
+
phoneNumbers?: Array<(string)>;
|
|
17399
|
+
orders?: Array<{
|
|
17400
|
+
id?: string;
|
|
17401
|
+
telnyxPortingOrderId?: string;
|
|
17402
|
+
status?: string;
|
|
17403
|
+
phoneNumbers?: Array<(string)>;
|
|
17404
|
+
/**
|
|
17405
|
+
* Present when this split order failed to submit (it stays as a cancellable draft).
|
|
17406
|
+
*/
|
|
17407
|
+
error?: string;
|
|
15685
17408
|
}>;
|
|
15686
|
-
/**
|
|
15687
|
-
* The shared WhatsApp sandbox (one Zernio-owned number, all users test
|
|
15688
|
-
* against it). Present when the sandbox is configured; null otherwise.
|
|
15689
|
-
* The `accountId` lets you address the sandbox in compose endpoints.
|
|
15690
|
-
* `template` is the only template a sandbox send is allowed to use.
|
|
15691
|
-
*
|
|
15692
|
-
*/
|
|
15693
|
-
sandbox?: {
|
|
15694
|
-
phoneNumber?: string;
|
|
15695
|
-
accountId?: (string) | null;
|
|
15696
|
-
template?: {
|
|
15697
|
-
name?: string;
|
|
15698
|
-
language?: string;
|
|
15699
|
-
};
|
|
15700
|
-
isSandbox?: boolean;
|
|
15701
|
-
} | null;
|
|
15702
17409
|
});
|
|
15703
|
-
type
|
|
17410
|
+
type CreatePhoneNumberPortInError = ({
|
|
15704
17411
|
error?: string;
|
|
17412
|
+
} | unknown);
|
|
17413
|
+
type ListPhoneNumberPortInsResponse = ({
|
|
17414
|
+
orders?: Array<{
|
|
17415
|
+
id?: string;
|
|
17416
|
+
status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
|
|
17417
|
+
/**
|
|
17418
|
+
* Raw carrier status string.
|
|
17419
|
+
*/
|
|
17420
|
+
telnyxStatusValue?: (string) | null;
|
|
17421
|
+
phoneNumbers?: Array<(string)>;
|
|
17422
|
+
fastPortEligible?: (boolean) | null;
|
|
17423
|
+
focDatetimeRequested?: (string) | null;
|
|
17424
|
+
focDatetimeActual?: (string) | null;
|
|
17425
|
+
declineReason?: (string) | null;
|
|
17426
|
+
submittedAt?: (string) | null;
|
|
17427
|
+
portedAt?: (string) | null;
|
|
17428
|
+
createdAt?: string;
|
|
17429
|
+
}>;
|
|
15705
17430
|
});
|
|
15706
|
-
type
|
|
17431
|
+
type ListPhoneNumberPortInsError = ({
|
|
17432
|
+
error?: string;
|
|
17433
|
+
});
|
|
17434
|
+
type CheckPhoneNumberPortabilityData = {
|
|
15707
17435
|
body: {
|
|
15708
17436
|
/**
|
|
15709
|
-
*
|
|
17437
|
+
* E.164 numbers to check, e.g. +13035550000.
|
|
15710
17438
|
*/
|
|
15711
|
-
|
|
17439
|
+
phoneNumbers: Array<(string)>;
|
|
17440
|
+
};
|
|
17441
|
+
};
|
|
17442
|
+
type CheckPhoneNumberPortabilityResponse = ({
|
|
17443
|
+
results?: Array<{
|
|
17444
|
+
phoneNumber?: string;
|
|
17445
|
+
portable?: boolean;
|
|
15712
17446
|
/**
|
|
15713
|
-
*
|
|
15714
|
-
*
|
|
17447
|
+
* Qualifies for the carrier's accelerated FastPort lane.
|
|
15715
17448
|
*/
|
|
15716
|
-
|
|
17449
|
+
fastPortable?: boolean;
|
|
15717
17450
|
/**
|
|
15718
|
-
*
|
|
15719
|
-
*
|
|
17451
|
+
* Carrier reason when not portable; null when portable.
|
|
15720
17452
|
*/
|
|
15721
|
-
|
|
17453
|
+
notPortableReason?: (string) | null;
|
|
17454
|
+
}>;
|
|
17455
|
+
});
|
|
17456
|
+
type CheckPhoneNumberPortabilityError = ({
|
|
17457
|
+
error?: string;
|
|
17458
|
+
});
|
|
17459
|
+
type UploadPhoneNumberPortInDocumentData = {
|
|
17460
|
+
body: {
|
|
15722
17461
|
/**
|
|
15723
|
-
*
|
|
15724
|
-
*
|
|
17462
|
+
* The document (PDF/JPEG/PNG, 10MB max).
|
|
15725
17463
|
*/
|
|
15726
|
-
|
|
17464
|
+
file: (Blob | File);
|
|
17465
|
+
/**
|
|
17466
|
+
* Informational; used for the stored filename.
|
|
17467
|
+
*/
|
|
17468
|
+
kind?: 'loa' | 'invoice';
|
|
15727
17469
|
};
|
|
15728
17470
|
};
|
|
15729
|
-
type
|
|
15730
|
-
|
|
15731
|
-
checkoutUrl?: string;
|
|
15732
|
-
} | {
|
|
15733
|
-
message?: string;
|
|
15734
|
-
phoneNumber?: {
|
|
15735
|
-
id?: string;
|
|
15736
|
-
phoneNumber?: string;
|
|
15737
|
-
status?: string;
|
|
15738
|
-
country?: string;
|
|
15739
|
-
provisionedAt?: string;
|
|
15740
|
-
metaPreverifiedId?: string;
|
|
15741
|
-
metaVerificationStatus?: string;
|
|
15742
|
-
};
|
|
15743
|
-
} | {
|
|
15744
|
-
status?: 'already_purchased';
|
|
15745
|
-
numberId?: string;
|
|
15746
|
-
phoneNumber?: string;
|
|
15747
|
-
}) | {
|
|
15748
|
-
status?: 'kyc_required';
|
|
15749
|
-
country?: string;
|
|
15750
|
-
kycUrl?: string;
|
|
17471
|
+
type UploadPhoneNumberPortInDocumentResponse = ({
|
|
17472
|
+
documentId?: string;
|
|
15751
17473
|
});
|
|
15752
|
-
type
|
|
15753
|
-
error?: string;
|
|
15754
|
-
} | {
|
|
17474
|
+
type UploadPhoneNumberPortInDocumentError = (unknown | {
|
|
15755
17475
|
error?: string;
|
|
15756
|
-
code?: 'PURCHASE_VELOCITY';
|
|
15757
17476
|
});
|
|
15758
|
-
type
|
|
15759
|
-
|
|
17477
|
+
type CancelPhoneNumberPortInData = {
|
|
17478
|
+
path: {
|
|
15760
17479
|
/**
|
|
15761
|
-
*
|
|
17480
|
+
* Porting order ID (from the port-in list).
|
|
15762
17481
|
*/
|
|
15763
|
-
|
|
15764
|
-
|
|
15765
|
-
|
|
15766
|
-
|
|
15767
|
-
|
|
15768
|
-
|
|
17482
|
+
id: string;
|
|
17483
|
+
};
|
|
17484
|
+
};
|
|
17485
|
+
type CancelPhoneNumberPortInResponse = ({
|
|
17486
|
+
id?: string;
|
|
17487
|
+
status?: 'draft' | 'pending' | 'foc_confirmed' | 'ported' | 'exception' | 'cancelled';
|
|
15769
17488
|
});
|
|
15770
|
-
type
|
|
17489
|
+
type CancelPhoneNumberPortInError = ({
|
|
15771
17490
|
error?: string;
|
|
15772
|
-
});
|
|
15773
|
-
type
|
|
15774
|
-
|
|
17491
|
+
} | unknown);
|
|
17492
|
+
type ReviewPhoneNumberKycPacketData = {
|
|
17493
|
+
body: {
|
|
17494
|
+
country: string;
|
|
17495
|
+
numberType: string;
|
|
15775
17496
|
/**
|
|
15776
|
-
*
|
|
17497
|
+
* requirementId to declared textual value.
|
|
15777
17498
|
*/
|
|
15778
|
-
|
|
15779
|
-
|
|
15780
|
-
|
|
17499
|
+
values?: {
|
|
17500
|
+
[key: string]: (string);
|
|
17501
|
+
};
|
|
15781
17502
|
/**
|
|
15782
|
-
*
|
|
17503
|
+
* Declared address (street_address, locality, ...), so a mismatched proof-of-address can be flagged.
|
|
15783
17504
|
*/
|
|
15784
|
-
|
|
17505
|
+
address?: {
|
|
17506
|
+
[key: string]: (string);
|
|
17507
|
+
};
|
|
17508
|
+
docs: Array<{
|
|
17509
|
+
requirementId: string;
|
|
17510
|
+
/**
|
|
17511
|
+
* Id from POST /v1/phone-numbers/kyc/upload-document.
|
|
17512
|
+
*/
|
|
17513
|
+
documentId: string;
|
|
17514
|
+
}>;
|
|
17515
|
+
};
|
|
17516
|
+
};
|
|
17517
|
+
type ReviewPhoneNumberKycPacketResponse = ({
|
|
17518
|
+
advisories?: Array<{
|
|
17519
|
+
requirementId?: string;
|
|
15785
17520
|
/**
|
|
15786
|
-
*
|
|
17521
|
+
* One short plain-language concern about that requirement's document.
|
|
15787
17522
|
*/
|
|
15788
|
-
|
|
17523
|
+
concern?: string;
|
|
17524
|
+
}>;
|
|
17525
|
+
});
|
|
17526
|
+
type ReviewPhoneNumberKycPacketError = ({
|
|
17527
|
+
error?: string;
|
|
17528
|
+
});
|
|
17529
|
+
type GetPhoneNumberRemediationData = {
|
|
17530
|
+
path: {
|
|
15789
17531
|
/**
|
|
15790
|
-
*
|
|
17532
|
+
* Phone number record ID.
|
|
15791
17533
|
*/
|
|
15792
|
-
|
|
17534
|
+
id: string;
|
|
15793
17535
|
};
|
|
15794
17536
|
};
|
|
15795
|
-
type
|
|
17537
|
+
type GetPhoneNumberRemediationResponse = ({
|
|
15796
17538
|
country?: string;
|
|
15797
17539
|
numberType?: string;
|
|
15798
|
-
|
|
15799
|
-
|
|
17540
|
+
declineReason?: (string) | null;
|
|
17541
|
+
/**
|
|
17542
|
+
* Same field shape as GET /v1/phone-numbers/kyc.
|
|
17543
|
+
*/
|
|
17544
|
+
fields?: Array<{
|
|
17545
|
+
[key: string]: unknown;
|
|
15800
17546
|
}>;
|
|
15801
17547
|
});
|
|
15802
|
-
type
|
|
17548
|
+
type GetPhoneNumberRemediationError = (unknown | {
|
|
15803
17549
|
error?: string;
|
|
15804
17550
|
});
|
|
15805
|
-
type
|
|
15806
|
-
|
|
17551
|
+
type RemediatePhoneNumberData = {
|
|
17552
|
+
body: {
|
|
17553
|
+
values?: {
|
|
17554
|
+
[key: string]: (string);
|
|
17555
|
+
};
|
|
17556
|
+
documents?: Array<({
|
|
17557
|
+
requirementId: string;
|
|
17558
|
+
filename: string;
|
|
17559
|
+
base64: string;
|
|
17560
|
+
} | {
|
|
17561
|
+
requirementId: string;
|
|
17562
|
+
documentId: string;
|
|
17563
|
+
})>;
|
|
15807
17564
|
/**
|
|
15808
|
-
*
|
|
17565
|
+
* Same shape as the KYC submit address.
|
|
15809
17566
|
*/
|
|
15810
|
-
|
|
17567
|
+
address?: {
|
|
17568
|
+
[key: string]: unknown;
|
|
17569
|
+
};
|
|
17570
|
+
};
|
|
17571
|
+
path: {
|
|
17572
|
+
id: string;
|
|
15811
17573
|
};
|
|
15812
17574
|
};
|
|
15813
|
-
type
|
|
15814
|
-
|
|
15815
|
-
|
|
15816
|
-
|
|
15817
|
-
|
|
15818
|
-
|
|
15819
|
-
available?: boolean;
|
|
15820
|
-
addressConstraint?: 'geo' | 'country' | 'none';
|
|
15821
|
-
/**
|
|
15822
|
-
* For `geo` only — the area(s) the registered address must be in.
|
|
15823
|
-
*/
|
|
15824
|
-
areas?: Array<(string)>;
|
|
17575
|
+
type RemediatePhoneNumberResponse = ({
|
|
17576
|
+
status?: string;
|
|
17577
|
+
phoneNumber?: {
|
|
17578
|
+
id?: string;
|
|
17579
|
+
status?: string;
|
|
17580
|
+
};
|
|
15825
17581
|
});
|
|
15826
|
-
type
|
|
17582
|
+
type RemediatePhoneNumberError = (unknown | {
|
|
15827
17583
|
error?: string;
|
|
15828
17584
|
});
|
|
15829
17585
|
type GetWhatsAppNumberKycFormData = {
|
|
@@ -16133,6 +17889,285 @@ type RemediateWhatsAppNumberResponse = ({
|
|
|
16133
17889
|
type RemediateWhatsAppNumberError = (unknown | {
|
|
16134
17890
|
error?: string;
|
|
16135
17891
|
});
|
|
17892
|
+
type EnableVoiceOnNumberData = {
|
|
17893
|
+
body?: {
|
|
17894
|
+
/**
|
|
17895
|
+
* tel:+E164, sip:..., or wss://... destination for inbound calls. Empty string clears the forward (outbound-only); omitted preserves the current one.
|
|
17896
|
+
*/
|
|
17897
|
+
forwardTo?: string;
|
|
17898
|
+
recordingEnabled?: boolean;
|
|
17899
|
+
transcriptionEnabled?: boolean;
|
|
17900
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
17901
|
+
/**
|
|
17902
|
+
* Voicemail is taken when there's no live destination. Default on.
|
|
17903
|
+
*/
|
|
17904
|
+
voicemailEnabled?: boolean;
|
|
17905
|
+
/**
|
|
17906
|
+
* Custom spoken greeting; empty string restores the default.
|
|
17907
|
+
*/
|
|
17908
|
+
voicemailGreeting?: string;
|
|
17909
|
+
/**
|
|
17910
|
+
* Outside the windows, inbound skips the forward and goes to voicemail. Off = 24/7.
|
|
17911
|
+
*/
|
|
17912
|
+
businessHoursEnabled?: boolean;
|
|
17913
|
+
/**
|
|
17914
|
+
* IANA timezone the windows are evaluated in.
|
|
17915
|
+
*/
|
|
17916
|
+
businessHoursTimezone?: string;
|
|
17917
|
+
businessHours?: Array<{
|
|
17918
|
+
/**
|
|
17919
|
+
* 0 = Sunday.
|
|
17920
|
+
*/
|
|
17921
|
+
day: number;
|
|
17922
|
+
open: string;
|
|
17923
|
+
close: string;
|
|
17924
|
+
}>;
|
|
17925
|
+
/**
|
|
17926
|
+
* E.164 numbers rejected before answer. Replaces the whole list; bare 10-digit values are normalized as US numbers.
|
|
17927
|
+
*/
|
|
17928
|
+
blockedCallers?: Array<(string)>;
|
|
17929
|
+
/**
|
|
17930
|
+
* Caller ID on the forwarded leg: your number (`business`) or the original caller's (`caller`).
|
|
17931
|
+
*/
|
|
17932
|
+
forwardCallerId?: 'business' | 'caller';
|
|
17933
|
+
/**
|
|
17934
|
+
* IVR menu (supersedes the plain forward within business hours).
|
|
17935
|
+
*/
|
|
17936
|
+
ivrEnabled?: boolean;
|
|
17937
|
+
ivrPrompt?: string;
|
|
17938
|
+
ivrOptions?: Array<{
|
|
17939
|
+
digit: string;
|
|
17940
|
+
/**
|
|
17941
|
+
* tel:+E164, sip:..., or wss://... destination for this digit.
|
|
17942
|
+
*/
|
|
17943
|
+
forwardTo: string;
|
|
17944
|
+
label?: string;
|
|
17945
|
+
}>;
|
|
17946
|
+
};
|
|
17947
|
+
path: {
|
|
17948
|
+
/**
|
|
17949
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
17950
|
+
*/
|
|
17951
|
+
id: string;
|
|
17952
|
+
};
|
|
17953
|
+
};
|
|
17954
|
+
type EnableVoiceOnNumberResponse = ({
|
|
17955
|
+
enabled?: boolean;
|
|
17956
|
+
phoneNumber?: string;
|
|
17957
|
+
pstnForwardTo?: (string) | null;
|
|
17958
|
+
recordingEnabled?: boolean;
|
|
17959
|
+
transcriptionEnabled?: boolean;
|
|
17960
|
+
transcriptionLanguage?: 'auto' | 'en' | 'es';
|
|
17961
|
+
voicemailEnabled?: boolean;
|
|
17962
|
+
voicemailGreeting?: (string) | null;
|
|
17963
|
+
businessHoursEnabled?: boolean;
|
|
17964
|
+
businessHoursTimezone?: (string) | null;
|
|
17965
|
+
businessHours?: Array<{
|
|
17966
|
+
day?: number;
|
|
17967
|
+
open?: string;
|
|
17968
|
+
close?: string;
|
|
17969
|
+
}>;
|
|
17970
|
+
blockedCallers?: Array<(string)>;
|
|
17971
|
+
forwardCallerId?: 'business' | 'caller';
|
|
17972
|
+
ivrEnabled?: boolean;
|
|
17973
|
+
ivrPrompt?: (string) | null;
|
|
17974
|
+
ivrOptions?: Array<{
|
|
17975
|
+
digit?: string;
|
|
17976
|
+
forwardTo?: string;
|
|
17977
|
+
label?: string;
|
|
17978
|
+
}>;
|
|
17979
|
+
});
|
|
17980
|
+
type EnableVoiceOnNumberError = ({
|
|
17981
|
+
error?: string;
|
|
17982
|
+
} | unknown);
|
|
17983
|
+
type DisableVoiceOnNumberData = {
|
|
17984
|
+
path: {
|
|
17985
|
+
id: string;
|
|
17986
|
+
};
|
|
17987
|
+
};
|
|
17988
|
+
type DisableVoiceOnNumberResponse = ({
|
|
17989
|
+
enabled?: boolean;
|
|
17990
|
+
phoneNumber?: string;
|
|
17991
|
+
});
|
|
17992
|
+
type DisableVoiceOnNumberError = ({
|
|
17993
|
+
error?: string;
|
|
17994
|
+
} | unknown);
|
|
17995
|
+
type EnableSmsOnNumberData = {
|
|
17996
|
+
path: {
|
|
17997
|
+
/**
|
|
17998
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
17999
|
+
*/
|
|
18000
|
+
id: string;
|
|
18001
|
+
};
|
|
18002
|
+
};
|
|
18003
|
+
type EnableSmsOnNumberResponse = ({
|
|
18004
|
+
enabled?: boolean;
|
|
18005
|
+
/**
|
|
18006
|
+
* The SMS social account ID (present when enabled).
|
|
18007
|
+
*/
|
|
18008
|
+
id?: string;
|
|
18009
|
+
phoneNumber?: string;
|
|
18010
|
+
/**
|
|
18011
|
+
* False for US numbers until their registration is approved.
|
|
18012
|
+
*/
|
|
18013
|
+
isActive?: boolean;
|
|
18014
|
+
country?: string;
|
|
18015
|
+
/**
|
|
18016
|
+
* Null when capability can't be read yet (still provisioning).
|
|
18017
|
+
*/
|
|
18018
|
+
smsCapable?: (boolean) | null;
|
|
18019
|
+
mmsCapable?: boolean;
|
|
18020
|
+
domesticOnly?: boolean;
|
|
18021
|
+
/**
|
|
18022
|
+
* Number is still provisioning at the carrier; retry shortly.
|
|
18023
|
+
*/
|
|
18024
|
+
notReady?: boolean;
|
|
18025
|
+
/**
|
|
18026
|
+
* US only; a carrier registration is required before delivery.
|
|
18027
|
+
*/
|
|
18028
|
+
needsRegistration?: boolean;
|
|
18029
|
+
/**
|
|
18030
|
+
* A prior non-rejected registration already covers this number; no re-submit needed.
|
|
18031
|
+
*/
|
|
18032
|
+
alreadyRegistered?: boolean;
|
|
18033
|
+
registrationStatus?: ('pending' | 'approved' | 'rejected') | null;
|
|
18034
|
+
/**
|
|
18035
|
+
* Present when an existing approved registration can cover this number via /sms/reuse-registration.
|
|
18036
|
+
*/
|
|
18037
|
+
reusable?: {
|
|
18038
|
+
registrationId?: string;
|
|
18039
|
+
status?: string;
|
|
18040
|
+
} | null;
|
|
18041
|
+
/**
|
|
18042
|
+
* Human-readable explanation when `enabled` is false.
|
|
18043
|
+
*/
|
|
18044
|
+
message?: string;
|
|
18045
|
+
});
|
|
18046
|
+
type EnableSmsOnNumberError = ({
|
|
18047
|
+
error?: string;
|
|
18048
|
+
} | unknown);
|
|
18049
|
+
type DisableSmsOnNumberData = {
|
|
18050
|
+
path: {
|
|
18051
|
+
id: string;
|
|
18052
|
+
};
|
|
18053
|
+
};
|
|
18054
|
+
type DisableSmsOnNumberResponse = ({
|
|
18055
|
+
enabled?: boolean;
|
|
18056
|
+
phoneNumber?: string;
|
|
18057
|
+
/**
|
|
18058
|
+
* False when SMS was already off. Legacy field; prefer `enabled`.
|
|
18059
|
+
*/
|
|
18060
|
+
disabled?: boolean;
|
|
18061
|
+
});
|
|
18062
|
+
type DisableSmsOnNumberError = ({
|
|
18063
|
+
error?: string;
|
|
18064
|
+
} | unknown);
|
|
18065
|
+
type ReuseSmsRegistrationForNumberData = {
|
|
18066
|
+
path: {
|
|
18067
|
+
id: string;
|
|
18068
|
+
};
|
|
18069
|
+
};
|
|
18070
|
+
type ReuseSmsRegistrationForNumberResponse = ({
|
|
18071
|
+
registrationId?: string;
|
|
18072
|
+
status?: 'pending' | 'approved' | 'rejected';
|
|
18073
|
+
});
|
|
18074
|
+
type ReuseSmsRegistrationForNumberError = ({
|
|
18075
|
+
error?: string;
|
|
18076
|
+
} | unknown);
|
|
18077
|
+
type GetWhatsAppCallingData = {
|
|
18078
|
+
path: {
|
|
18079
|
+
/**
|
|
18080
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
18081
|
+
*/
|
|
18082
|
+
id: string;
|
|
18083
|
+
};
|
|
18084
|
+
};
|
|
18085
|
+
type GetWhatsAppCallingResponse = ({
|
|
18086
|
+
phoneNumber?: string;
|
|
18087
|
+
callingEnabled?: boolean;
|
|
18088
|
+
/**
|
|
18089
|
+
* Public calling deep link (https://wa.me/call/<number>). Null while calling is disabled.
|
|
18090
|
+
*/
|
|
18091
|
+
callDeepLink?: (string) | null;
|
|
18092
|
+
/**
|
|
18093
|
+
* tel:+E164 / sip:... / wss://... destination
|
|
18094
|
+
*/
|
|
18095
|
+
forwardTo?: (string) | null;
|
|
18096
|
+
recordingEnabled?: boolean;
|
|
18097
|
+
sipAuthUsername?: (string) | null;
|
|
18098
|
+
/**
|
|
18099
|
+
* True when a SIP digest password is stored. The plaintext is never returned.
|
|
18100
|
+
*/
|
|
18101
|
+
sipAuthPasswordConfigured?: boolean;
|
|
18102
|
+
callIconCountries?: Array<(string)> | null;
|
|
18103
|
+
/**
|
|
18104
|
+
* True when the number's country blocks business-initiated (outbound) WhatsApp calling; inbound still works.
|
|
18105
|
+
*/
|
|
18106
|
+
outboundDisabled?: boolean;
|
|
18107
|
+
});
|
|
18108
|
+
type GetWhatsAppCallingError = ({
|
|
18109
|
+
error?: string;
|
|
18110
|
+
} | unknown);
|
|
18111
|
+
type EnableWhatsAppCallingData = {
|
|
18112
|
+
body: {
|
|
18113
|
+
accountId: string;
|
|
18114
|
+
/**
|
|
18115
|
+
* tel:+E164 / sip:... / wss://... destination
|
|
18116
|
+
*/
|
|
18117
|
+
forwardTo: string;
|
|
18118
|
+
sipAuthUsername?: string;
|
|
18119
|
+
/**
|
|
18120
|
+
* Stored encrypted, never returned by any endpoint.
|
|
18121
|
+
*/
|
|
18122
|
+
sipAuthPassword?: string;
|
|
18123
|
+
recordingEnabled?: boolean;
|
|
18124
|
+
callIconCountries?: Array<(string)>;
|
|
18125
|
+
};
|
|
18126
|
+
path: {
|
|
18127
|
+
/**
|
|
18128
|
+
* Phone number record ID (from GET /v1/phone-numbers).
|
|
18129
|
+
*/
|
|
18130
|
+
id: string;
|
|
18131
|
+
};
|
|
18132
|
+
};
|
|
18133
|
+
type EnableWhatsAppCallingResponse = ({
|
|
18134
|
+
success?: boolean;
|
|
18135
|
+
callingEnabled?: boolean;
|
|
18136
|
+
sipHostname?: string;
|
|
18137
|
+
forwardTo?: string;
|
|
18138
|
+
});
|
|
18139
|
+
type EnableWhatsAppCallingError = ({
|
|
18140
|
+
error?: string;
|
|
18141
|
+
} | unknown);
|
|
18142
|
+
type UpdateWhatsAppCallingData = {
|
|
18143
|
+
body: {
|
|
18144
|
+
accountId: string;
|
|
18145
|
+
forwardTo?: string;
|
|
18146
|
+
sipAuthUsername?: (string) | null;
|
|
18147
|
+
sipAuthPassword?: (string) | null;
|
|
18148
|
+
recordingEnabled?: boolean;
|
|
18149
|
+
callIconCountries?: Array<(string)> | null;
|
|
18150
|
+
};
|
|
18151
|
+
path: {
|
|
18152
|
+
id: string;
|
|
18153
|
+
};
|
|
18154
|
+
};
|
|
18155
|
+
type UpdateWhatsAppCallingResponse = (unknown);
|
|
18156
|
+
type UpdateWhatsAppCallingError = ({
|
|
18157
|
+
error?: string;
|
|
18158
|
+
} | unknown);
|
|
18159
|
+
type DisableWhatsAppCallingData = {
|
|
18160
|
+
path: {
|
|
18161
|
+
id: string;
|
|
18162
|
+
};
|
|
18163
|
+
query: {
|
|
18164
|
+
accountId: string;
|
|
18165
|
+
};
|
|
18166
|
+
};
|
|
18167
|
+
type DisableWhatsAppCallingResponse = (unknown);
|
|
18168
|
+
type DisableWhatsAppCallingError = ({
|
|
18169
|
+
error?: string;
|
|
18170
|
+
} | unknown);
|
|
16136
18171
|
type GetWhatsAppPhoneNumberData = {
|
|
16137
18172
|
path: {
|
|
16138
18173
|
/**
|
|
@@ -22036,4 +24071,4 @@ type GetTrackingTagStatsError = (unknown | {
|
|
|
22036
24071
|
error?: string;
|
|
22037
24072
|
});
|
|
22038
24073
|
|
|
22039
|
-
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 };
|
|
24074
|
+
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 };
|