@getlatedev/node 0.2.335 → 0.2.336
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/dist/index.d.mts +31 -4
- package/dist/index.d.ts +31 -4
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +7 -0
- package/src/generated/types.gen.ts +31 -4
package/dist/index.d.mts
CHANGED
|
@@ -4859,7 +4859,7 @@ type Webhook = {
|
|
|
4859
4859
|
/**
|
|
4860
4860
|
* Events subscribed to
|
|
4861
4861
|
*/
|
|
4862
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
4862
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
4863
4863
|
/**
|
|
4864
4864
|
* Whether webhook delivery is enabled
|
|
4865
4865
|
*/
|
|
@@ -13408,7 +13408,7 @@ type CreateWebhookSettingsData = {
|
|
|
13408
13408
|
/**
|
|
13409
13409
|
* Events to subscribe to (at least one required)
|
|
13410
13410
|
*/
|
|
13411
|
-
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13411
|
+
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13412
13412
|
/**
|
|
13413
13413
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
13414
13414
|
*/
|
|
@@ -13449,7 +13449,7 @@ type UpdateWebhookSettingsData = {
|
|
|
13449
13449
|
/**
|
|
13450
13450
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
13451
13451
|
*/
|
|
13452
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13452
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13453
13453
|
/**
|
|
13454
13454
|
* Enable or disable webhook delivery
|
|
13455
13455
|
*/
|
|
@@ -16886,9 +16886,16 @@ type StartSmsRegistrationData = {
|
|
|
16886
16886
|
*/
|
|
16887
16887
|
campaign?: {
|
|
16888
16888
|
usecase: string;
|
|
16889
|
+
/**
|
|
16890
|
+
* The concrete kinds of messages a MIXED campaign sends (the carrier
|
|
16891
|
+
* registry requires 2-5, and reviewers match them against the sample
|
|
16892
|
+
* messages). Omitted: a default pair is applied for MIXED.
|
|
16893
|
+
*
|
|
16894
|
+
*/
|
|
16895
|
+
subUsecases?: Array<('2FA' | 'ACCOUNT_NOTIFICATION' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'MARKETING' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT')>;
|
|
16889
16896
|
description: string;
|
|
16890
16897
|
/**
|
|
16891
|
-
* How a recipient ends up receiving your messages (the opt-in flow).
|
|
16898
|
+
* How a recipient ends up receiving your messages (the opt-in flow). Include a link to the page or form where they opt in — carrier reviewers reject campaigns whose consent they can't verify.
|
|
16892
16899
|
*/
|
|
16893
16900
|
messageFlow: string;
|
|
16894
16901
|
sample1: string;
|
|
@@ -17019,6 +17026,17 @@ type GetSmsRegistrationResponse = ({
|
|
|
17019
17026
|
declineReason?: (string) | null;
|
|
17020
17027
|
phoneNumbers?: Array<(string)>;
|
|
17021
17028
|
awaitingOtp?: boolean;
|
|
17029
|
+
/**
|
|
17030
|
+
* The submitted campaign content, present only for rejected
|
|
17031
|
+
* registrations with a campaign. Edit and resubmit it via the
|
|
17032
|
+
* appeal endpoint's optional content fields.
|
|
17033
|
+
*
|
|
17034
|
+
*/
|
|
17035
|
+
campaignContent?: {
|
|
17036
|
+
messageFlow?: string;
|
|
17037
|
+
sample1?: string;
|
|
17038
|
+
sample2?: string;
|
|
17039
|
+
};
|
|
17022
17040
|
});
|
|
17023
17041
|
type GetSmsRegistrationError = ({
|
|
17024
17042
|
error?: string;
|
|
@@ -17039,7 +17057,16 @@ type VerifySmsRegistrationOtpError = ({
|
|
|
17039
17057
|
} | unknown);
|
|
17040
17058
|
type AppealSmsRegistrationData = {
|
|
17041
17059
|
body: {
|
|
17060
|
+
/**
|
|
17061
|
+
* Goes verbatim to the carrier reviewer — address the decline reason directly.
|
|
17062
|
+
*/
|
|
17042
17063
|
appealReason: string;
|
|
17064
|
+
/**
|
|
17065
|
+
* Corrected opt-in flow; include a link to the opt-in page/form.
|
|
17066
|
+
*/
|
|
17067
|
+
messageFlow?: string;
|
|
17068
|
+
sample1?: string;
|
|
17069
|
+
sample2?: string;
|
|
17043
17070
|
};
|
|
17044
17071
|
path: {
|
|
17045
17072
|
id: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -4859,7 +4859,7 @@ type Webhook = {
|
|
|
4859
4859
|
/**
|
|
4860
4860
|
* Events subscribed to
|
|
4861
4861
|
*/
|
|
4862
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
4862
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
4863
4863
|
/**
|
|
4864
4864
|
* Whether webhook delivery is enabled
|
|
4865
4865
|
*/
|
|
@@ -13408,7 +13408,7 @@ type CreateWebhookSettingsData = {
|
|
|
13408
13408
|
/**
|
|
13409
13409
|
* Events to subscribe to (at least one required)
|
|
13410
13410
|
*/
|
|
13411
|
-
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13411
|
+
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13412
13412
|
/**
|
|
13413
13413
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
13414
13414
|
*/
|
|
@@ -13449,7 +13449,7 @@ type UpdateWebhookSettingsData = {
|
|
|
13449
13449
|
/**
|
|
13450
13450
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
13451
13451
|
*/
|
|
13452
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13452
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13453
13453
|
/**
|
|
13454
13454
|
* Enable or disable webhook delivery
|
|
13455
13455
|
*/
|
|
@@ -16886,9 +16886,16 @@ type StartSmsRegistrationData = {
|
|
|
16886
16886
|
*/
|
|
16887
16887
|
campaign?: {
|
|
16888
16888
|
usecase: string;
|
|
16889
|
+
/**
|
|
16890
|
+
* The concrete kinds of messages a MIXED campaign sends (the carrier
|
|
16891
|
+
* registry requires 2-5, and reviewers match them against the sample
|
|
16892
|
+
* messages). Omitted: a default pair is applied for MIXED.
|
|
16893
|
+
*
|
|
16894
|
+
*/
|
|
16895
|
+
subUsecases?: Array<('2FA' | 'ACCOUNT_NOTIFICATION' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'MARKETING' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT')>;
|
|
16889
16896
|
description: string;
|
|
16890
16897
|
/**
|
|
16891
|
-
* How a recipient ends up receiving your messages (the opt-in flow).
|
|
16898
|
+
* How a recipient ends up receiving your messages (the opt-in flow). Include a link to the page or form where they opt in — carrier reviewers reject campaigns whose consent they can't verify.
|
|
16892
16899
|
*/
|
|
16893
16900
|
messageFlow: string;
|
|
16894
16901
|
sample1: string;
|
|
@@ -17019,6 +17026,17 @@ type GetSmsRegistrationResponse = ({
|
|
|
17019
17026
|
declineReason?: (string) | null;
|
|
17020
17027
|
phoneNumbers?: Array<(string)>;
|
|
17021
17028
|
awaitingOtp?: boolean;
|
|
17029
|
+
/**
|
|
17030
|
+
* The submitted campaign content, present only for rejected
|
|
17031
|
+
* registrations with a campaign. Edit and resubmit it via the
|
|
17032
|
+
* appeal endpoint's optional content fields.
|
|
17033
|
+
*
|
|
17034
|
+
*/
|
|
17035
|
+
campaignContent?: {
|
|
17036
|
+
messageFlow?: string;
|
|
17037
|
+
sample1?: string;
|
|
17038
|
+
sample2?: string;
|
|
17039
|
+
};
|
|
17022
17040
|
});
|
|
17023
17041
|
type GetSmsRegistrationError = ({
|
|
17024
17042
|
error?: string;
|
|
@@ -17039,7 +17057,16 @@ type VerifySmsRegistrationOtpError = ({
|
|
|
17039
17057
|
} | unknown);
|
|
17040
17058
|
type AppealSmsRegistrationData = {
|
|
17041
17059
|
body: {
|
|
17060
|
+
/**
|
|
17061
|
+
* Goes verbatim to the carrier reviewer — address the decline reason directly.
|
|
17062
|
+
*/
|
|
17042
17063
|
appealReason: string;
|
|
17064
|
+
/**
|
|
17065
|
+
* Corrected opt-in flow; include a link to the opt-in page/form.
|
|
17066
|
+
*/
|
|
17067
|
+
messageFlow?: string;
|
|
17068
|
+
sample1?: string;
|
|
17069
|
+
sample2?: string;
|
|
17043
17070
|
};
|
|
17044
17071
|
path: {
|
|
17045
17072
|
id: string;
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.336",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.336",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -3928,6 +3928,13 @@ export const verifySmsRegistrationOtp = <ThrowOnError extends boolean = false>(o
|
|
|
3928
3928
|
* brand-level rejection should be fixed and re-verified instead. On
|
|
3929
3929
|
* success the registration returns to `pending`.
|
|
3930
3930
|
*
|
|
3931
|
+
* Content rejections (e.g. an opt-in flow without a verifiable form link,
|
|
3932
|
+
* or unrealistic samples) should be FIXED in the same call: pass the
|
|
3933
|
+
* corrected `messageFlow` / `sample1` / `sample2` and the campaign is
|
|
3934
|
+
* updated before the appeal is filed, so the reviewer sees the new
|
|
3935
|
+
* content. The current content is on `GET /v1/sms/registrations/{id}`
|
|
3936
|
+
* (`campaignContent`).
|
|
3937
|
+
*
|
|
3931
3938
|
*/
|
|
3932
3939
|
export const appealSmsRegistration = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<AppealSmsRegistrationData, ThrowOnError>) => {
|
|
3933
3940
|
return (options?.client ?? client).post<AppealSmsRegistrationResponse, AppealSmsRegistrationError, ThrowOnError>({
|
|
@@ -4164,7 +4164,7 @@ export type Webhook = {
|
|
|
4164
4164
|
/**
|
|
4165
4165
|
* Events subscribed to
|
|
4166
4166
|
*/
|
|
4167
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
4167
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
4168
4168
|
/**
|
|
4169
4169
|
* Whether webhook delivery is enabled
|
|
4170
4170
|
*/
|
|
@@ -13307,7 +13307,7 @@ export type CreateWebhookSettingsData = {
|
|
|
13307
13307
|
/**
|
|
13308
13308
|
* Events to subscribe to (at least one required)
|
|
13309
13309
|
*/
|
|
13310
|
-
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13310
|
+
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13311
13311
|
/**
|
|
13312
13312
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
13313
13313
|
*/
|
|
@@ -13351,7 +13351,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
13351
13351
|
/**
|
|
13352
13352
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
13353
13353
|
*/
|
|
13354
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13354
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.status_updated' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted')>;
|
|
13355
13355
|
/**
|
|
13356
13356
|
* Enable or disable webhook delivery
|
|
13357
13357
|
*/
|
|
@@ -17027,9 +17027,16 @@ export type StartSmsRegistrationData = {
|
|
|
17027
17027
|
*/
|
|
17028
17028
|
campaign?: {
|
|
17029
17029
|
usecase: string;
|
|
17030
|
+
/**
|
|
17031
|
+
* The concrete kinds of messages a MIXED campaign sends (the carrier
|
|
17032
|
+
* registry requires 2-5, and reviewers match them against the sample
|
|
17033
|
+
* messages). Omitted: a default pair is applied for MIXED.
|
|
17034
|
+
*
|
|
17035
|
+
*/
|
|
17036
|
+
subUsecases?: Array<('2FA' | 'ACCOUNT_NOTIFICATION' | 'CUSTOMER_CARE' | 'DELIVERY_NOTIFICATION' | 'FRAUD_ALERT' | 'HIGHER_EDUCATION' | 'MARKETING' | 'POLLING_VOTING' | 'PUBLIC_SERVICE_ANNOUNCEMENT' | 'SECURITY_ALERT')>;
|
|
17030
17037
|
description: string;
|
|
17031
17038
|
/**
|
|
17032
|
-
* How a recipient ends up receiving your messages (the opt-in flow).
|
|
17039
|
+
* How a recipient ends up receiving your messages (the opt-in flow). Include a link to the page or form where they opt in — carrier reviewers reject campaigns whose consent they can't verify.
|
|
17033
17040
|
*/
|
|
17034
17041
|
messageFlow: string;
|
|
17035
17042
|
sample1: string;
|
|
@@ -17166,6 +17173,17 @@ export type GetSmsRegistrationResponse = ({
|
|
|
17166
17173
|
declineReason?: (string) | null;
|
|
17167
17174
|
phoneNumbers?: Array<(string)>;
|
|
17168
17175
|
awaitingOtp?: boolean;
|
|
17176
|
+
/**
|
|
17177
|
+
* The submitted campaign content, present only for rejected
|
|
17178
|
+
* registrations with a campaign. Edit and resubmit it via the
|
|
17179
|
+
* appeal endpoint's optional content fields.
|
|
17180
|
+
*
|
|
17181
|
+
*/
|
|
17182
|
+
campaignContent?: {
|
|
17183
|
+
messageFlow?: string;
|
|
17184
|
+
sample1?: string;
|
|
17185
|
+
sample2?: string;
|
|
17186
|
+
};
|
|
17169
17187
|
});
|
|
17170
17188
|
|
|
17171
17189
|
export type GetSmsRegistrationError = ({
|
|
@@ -17191,7 +17209,16 @@ export type VerifySmsRegistrationOtpError = ({
|
|
|
17191
17209
|
|
|
17192
17210
|
export type AppealSmsRegistrationData = {
|
|
17193
17211
|
body: {
|
|
17212
|
+
/**
|
|
17213
|
+
* Goes verbatim to the carrier reviewer — address the decline reason directly.
|
|
17214
|
+
*/
|
|
17194
17215
|
appealReason: string;
|
|
17216
|
+
/**
|
|
17217
|
+
* Corrected opt-in flow; include a link to the opt-in page/form.
|
|
17218
|
+
*/
|
|
17219
|
+
messageFlow?: string;
|
|
17220
|
+
sample1?: string;
|
|
17221
|
+
sample2?: string;
|
|
17195
17222
|
};
|
|
17196
17223
|
path: {
|
|
17197
17224
|
id: string;
|