@zernio/node 0.2.185 → 0.2.187
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 +26 -54
- package/dist/index.d.ts +26 -54
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +8 -4
- package/src/generated/types.gen.ts +26 -54
package/dist/index.d.mts
CHANGED
|
@@ -2191,6 +2191,16 @@ type InboxWebhookConversation = {
|
|
|
2191
2191
|
participantUsername?: string;
|
|
2192
2192
|
participantPicture?: string;
|
|
2193
2193
|
status: 'active' | 'archived';
|
|
2194
|
+
/**
|
|
2195
|
+
* Zernio CRM Contact ID for the participant, when one exists. Resolved by
|
|
2196
|
+
* joining `participantId` to the ContactChannel collection. Best-effort:
|
|
2197
|
+
* omitted when no channel matches or `participantId` is absent. Lets
|
|
2198
|
+
* integrators join any inbox webhook back to the CRM Contact without
|
|
2199
|
+
* needing to look at the sender — which matters for outgoing and
|
|
2200
|
+
* delivery-status events whose sender is the business.
|
|
2201
|
+
*
|
|
2202
|
+
*/
|
|
2203
|
+
contactId?: string;
|
|
2194
2204
|
};
|
|
2195
2205
|
type status3 = 'active' | 'archived';
|
|
2196
2206
|
/**
|
|
@@ -4311,6 +4321,16 @@ type WebhookPayloadConversationStarted = {
|
|
|
4311
4321
|
participantUsername?: string;
|
|
4312
4322
|
participantPicture?: string;
|
|
4313
4323
|
status: 'active' | 'archived';
|
|
4324
|
+
/**
|
|
4325
|
+
* Zernio CRM Contact ID for the participant, when one exists. Resolved by
|
|
4326
|
+
* joining `participantId` to the ContactChannel collection (same join
|
|
4327
|
+
* used by message.*, reaction.received, and call.* webhooks). Best-effort:
|
|
4328
|
+
* omitted when no channel matches or `participantId` is absent. Lets
|
|
4329
|
+
* integrators seed the CRM straight from `conversation.started` without
|
|
4330
|
+
* waiting for the first `message.*` event.
|
|
4331
|
+
*
|
|
4332
|
+
*/
|
|
4333
|
+
contactId?: string;
|
|
4314
4334
|
};
|
|
4315
4335
|
account: InboxWebhookAccount;
|
|
4316
4336
|
/**
|
|
@@ -4498,24 +4518,8 @@ type WebhookPayloadMessage = {
|
|
|
4498
4518
|
sentAt: string;
|
|
4499
4519
|
isRead: boolean;
|
|
4500
4520
|
};
|
|
4501
|
-
conversation:
|
|
4502
|
-
|
|
4503
|
-
platformConversationId: string;
|
|
4504
|
-
participantId?: string;
|
|
4505
|
-
participantName?: string;
|
|
4506
|
-
participantUsername?: string;
|
|
4507
|
-
participantPicture?: string;
|
|
4508
|
-
status: 'active' | 'archived';
|
|
4509
|
-
};
|
|
4510
|
-
account: {
|
|
4511
|
-
/**
|
|
4512
|
-
* Social account ID
|
|
4513
|
-
*/
|
|
4514
|
-
id: string;
|
|
4515
|
-
platform: string;
|
|
4516
|
-
username: string;
|
|
4517
|
-
displayName?: string;
|
|
4518
|
-
};
|
|
4521
|
+
conversation: InboxWebhookConversation;
|
|
4522
|
+
account: InboxWebhookAccount;
|
|
4519
4523
|
/**
|
|
4520
4524
|
* Interactive message metadata (present when message is a quick reply tap, postback button tap, or inline keyboard callback)
|
|
4521
4525
|
*/
|
|
@@ -4827,24 +4831,8 @@ type WebhookPayloadMessageSent = {
|
|
|
4827
4831
|
sentAt: string;
|
|
4828
4832
|
isRead: boolean;
|
|
4829
4833
|
};
|
|
4830
|
-
conversation:
|
|
4831
|
-
|
|
4832
|
-
platformConversationId: string;
|
|
4833
|
-
participantId?: string;
|
|
4834
|
-
participantName?: string;
|
|
4835
|
-
participantUsername?: string;
|
|
4836
|
-
participantPicture?: string;
|
|
4837
|
-
status: 'active' | 'archived';
|
|
4838
|
-
};
|
|
4839
|
-
account: {
|
|
4840
|
-
/**
|
|
4841
|
-
* Social account ID
|
|
4842
|
-
*/
|
|
4843
|
-
id: string;
|
|
4844
|
-
platform: string;
|
|
4845
|
-
username: string;
|
|
4846
|
-
displayName?: string;
|
|
4847
|
-
};
|
|
4834
|
+
conversation: InboxWebhookConversation;
|
|
4835
|
+
account: InboxWebhookAccount;
|
|
4848
4836
|
timestamp: string;
|
|
4849
4837
|
};
|
|
4850
4838
|
type event12 = 'message.sent';
|
|
@@ -4992,24 +4980,8 @@ type WebhookPayloadReaction = {
|
|
|
4992
4980
|
};
|
|
4993
4981
|
reactedAt: string;
|
|
4994
4982
|
};
|
|
4995
|
-
conversation:
|
|
4996
|
-
|
|
4997
|
-
platformConversationId: string;
|
|
4998
|
-
participantId?: string;
|
|
4999
|
-
participantName?: string;
|
|
5000
|
-
participantUsername?: string;
|
|
5001
|
-
participantPicture?: string;
|
|
5002
|
-
status: 'active' | 'archived';
|
|
5003
|
-
};
|
|
5004
|
-
account: {
|
|
5005
|
-
/**
|
|
5006
|
-
* Social account ID
|
|
5007
|
-
*/
|
|
5008
|
-
id: string;
|
|
5009
|
-
platform: string;
|
|
5010
|
-
username: string;
|
|
5011
|
-
displayName?: string;
|
|
5012
|
-
};
|
|
4983
|
+
conversation: InboxWebhookConversation;
|
|
4984
|
+
account: InboxWebhookAccount;
|
|
5013
4985
|
timestamp: string;
|
|
5014
4986
|
};
|
|
5015
4987
|
type event15 = 'reaction.received';
|
package/dist/index.d.ts
CHANGED
|
@@ -2191,6 +2191,16 @@ type InboxWebhookConversation = {
|
|
|
2191
2191
|
participantUsername?: string;
|
|
2192
2192
|
participantPicture?: string;
|
|
2193
2193
|
status: 'active' | 'archived';
|
|
2194
|
+
/**
|
|
2195
|
+
* Zernio CRM Contact ID for the participant, when one exists. Resolved by
|
|
2196
|
+
* joining `participantId` to the ContactChannel collection. Best-effort:
|
|
2197
|
+
* omitted when no channel matches or `participantId` is absent. Lets
|
|
2198
|
+
* integrators join any inbox webhook back to the CRM Contact without
|
|
2199
|
+
* needing to look at the sender — which matters for outgoing and
|
|
2200
|
+
* delivery-status events whose sender is the business.
|
|
2201
|
+
*
|
|
2202
|
+
*/
|
|
2203
|
+
contactId?: string;
|
|
2194
2204
|
};
|
|
2195
2205
|
type status3 = 'active' | 'archived';
|
|
2196
2206
|
/**
|
|
@@ -4311,6 +4321,16 @@ type WebhookPayloadConversationStarted = {
|
|
|
4311
4321
|
participantUsername?: string;
|
|
4312
4322
|
participantPicture?: string;
|
|
4313
4323
|
status: 'active' | 'archived';
|
|
4324
|
+
/**
|
|
4325
|
+
* Zernio CRM Contact ID for the participant, when one exists. Resolved by
|
|
4326
|
+
* joining `participantId` to the ContactChannel collection (same join
|
|
4327
|
+
* used by message.*, reaction.received, and call.* webhooks). Best-effort:
|
|
4328
|
+
* omitted when no channel matches or `participantId` is absent. Lets
|
|
4329
|
+
* integrators seed the CRM straight from `conversation.started` without
|
|
4330
|
+
* waiting for the first `message.*` event.
|
|
4331
|
+
*
|
|
4332
|
+
*/
|
|
4333
|
+
contactId?: string;
|
|
4314
4334
|
};
|
|
4315
4335
|
account: InboxWebhookAccount;
|
|
4316
4336
|
/**
|
|
@@ -4498,24 +4518,8 @@ type WebhookPayloadMessage = {
|
|
|
4498
4518
|
sentAt: string;
|
|
4499
4519
|
isRead: boolean;
|
|
4500
4520
|
};
|
|
4501
|
-
conversation:
|
|
4502
|
-
|
|
4503
|
-
platformConversationId: string;
|
|
4504
|
-
participantId?: string;
|
|
4505
|
-
participantName?: string;
|
|
4506
|
-
participantUsername?: string;
|
|
4507
|
-
participantPicture?: string;
|
|
4508
|
-
status: 'active' | 'archived';
|
|
4509
|
-
};
|
|
4510
|
-
account: {
|
|
4511
|
-
/**
|
|
4512
|
-
* Social account ID
|
|
4513
|
-
*/
|
|
4514
|
-
id: string;
|
|
4515
|
-
platform: string;
|
|
4516
|
-
username: string;
|
|
4517
|
-
displayName?: string;
|
|
4518
|
-
};
|
|
4521
|
+
conversation: InboxWebhookConversation;
|
|
4522
|
+
account: InboxWebhookAccount;
|
|
4519
4523
|
/**
|
|
4520
4524
|
* Interactive message metadata (present when message is a quick reply tap, postback button tap, or inline keyboard callback)
|
|
4521
4525
|
*/
|
|
@@ -4827,24 +4831,8 @@ type WebhookPayloadMessageSent = {
|
|
|
4827
4831
|
sentAt: string;
|
|
4828
4832
|
isRead: boolean;
|
|
4829
4833
|
};
|
|
4830
|
-
conversation:
|
|
4831
|
-
|
|
4832
|
-
platformConversationId: string;
|
|
4833
|
-
participantId?: string;
|
|
4834
|
-
participantName?: string;
|
|
4835
|
-
participantUsername?: string;
|
|
4836
|
-
participantPicture?: string;
|
|
4837
|
-
status: 'active' | 'archived';
|
|
4838
|
-
};
|
|
4839
|
-
account: {
|
|
4840
|
-
/**
|
|
4841
|
-
* Social account ID
|
|
4842
|
-
*/
|
|
4843
|
-
id: string;
|
|
4844
|
-
platform: string;
|
|
4845
|
-
username: string;
|
|
4846
|
-
displayName?: string;
|
|
4847
|
-
};
|
|
4834
|
+
conversation: InboxWebhookConversation;
|
|
4835
|
+
account: InboxWebhookAccount;
|
|
4848
4836
|
timestamp: string;
|
|
4849
4837
|
};
|
|
4850
4838
|
type event12 = 'message.sent';
|
|
@@ -4992,24 +4980,8 @@ type WebhookPayloadReaction = {
|
|
|
4992
4980
|
};
|
|
4993
4981
|
reactedAt: string;
|
|
4994
4982
|
};
|
|
4995
|
-
conversation:
|
|
4996
|
-
|
|
4997
|
-
platformConversationId: string;
|
|
4998
|
-
participantId?: string;
|
|
4999
|
-
participantName?: string;
|
|
5000
|
-
participantUsername?: string;
|
|
5001
|
-
participantPicture?: string;
|
|
5002
|
-
status: 'active' | 'archived';
|
|
5003
|
-
};
|
|
5004
|
-
account: {
|
|
5005
|
-
/**
|
|
5006
|
-
* Social account ID
|
|
5007
|
-
*/
|
|
5008
|
-
id: string;
|
|
5009
|
-
platform: string;
|
|
5010
|
-
username: string;
|
|
5011
|
-
displayName?: string;
|
|
5012
|
-
};
|
|
4983
|
+
conversation: InboxWebhookConversation;
|
|
4984
|
+
account: InboxWebhookAccount;
|
|
5013
4985
|
timestamp: string;
|
|
5014
4986
|
};
|
|
5015
4987
|
type event15 = 'reaction.received';
|
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: "@zernio/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.187",
|
|
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: "@zernio/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.187",
|
|
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
|
@@ -4345,10 +4345,14 @@ export const listWhatsAppConversions = <ThrowOnError extends boolean = false>(op
|
|
|
4345
4345
|
* the conversation and replays it on every event so Meta can attribute
|
|
4346
4346
|
* the conversion back to the Click-to-WhatsApp ad that drove the chat.
|
|
4347
4347
|
*
|
|
4348
|
-
* Configuration
|
|
4349
|
-
* - `metaCapiDatasetId`: the Meta
|
|
4350
|
-
*
|
|
4351
|
-
*
|
|
4348
|
+
* Configuration prerequisite on the WhatsApp account metadata:
|
|
4349
|
+
* - `metaCapiDatasetId`: the Meta dataset ID linked to the WABA.
|
|
4350
|
+
* Provision one with `POST /v1/whatsapp/dataset`.
|
|
4351
|
+
*
|
|
4352
|
+
* The WABA ID (already set automatically at connect time) is forwarded as
|
|
4353
|
+
* `user_data.whatsapp_business_account_id`, which is the per-channel
|
|
4354
|
+
* attribution identifier Meta requires for WhatsApp events. No Facebook
|
|
4355
|
+
* Page ID is needed (that field is the Messenger-branch identifier).
|
|
4352
4356
|
*
|
|
4353
4357
|
* Identify the conversation by either `conversationId` (preferred) or
|
|
4354
4358
|
* `phoneE164` (digits only, no `+`). At least one is required. If the
|
|
@@ -1574,6 +1574,16 @@ export type InboxWebhookConversation = {
|
|
|
1574
1574
|
participantUsername?: string;
|
|
1575
1575
|
participantPicture?: string;
|
|
1576
1576
|
status: 'active' | 'archived';
|
|
1577
|
+
/**
|
|
1578
|
+
* Zernio CRM Contact ID for the participant, when one exists. Resolved by
|
|
1579
|
+
* joining `participantId` to the ContactChannel collection. Best-effort:
|
|
1580
|
+
* omitted when no channel matches or `participantId` is absent. Lets
|
|
1581
|
+
* integrators join any inbox webhook back to the CRM Contact without
|
|
1582
|
+
* needing to look at the sender — which matters for outgoing and
|
|
1583
|
+
* delivery-status events whose sender is the business.
|
|
1584
|
+
*
|
|
1585
|
+
*/
|
|
1586
|
+
contactId?: string;
|
|
1577
1587
|
};
|
|
1578
1588
|
|
|
1579
1589
|
export type status3 = 'active' | 'archived';
|
|
@@ -3803,6 +3813,16 @@ export type WebhookPayloadConversationStarted = {
|
|
|
3803
3813
|
participantUsername?: string;
|
|
3804
3814
|
participantPicture?: string;
|
|
3805
3815
|
status: 'active' | 'archived';
|
|
3816
|
+
/**
|
|
3817
|
+
* Zernio CRM Contact ID for the participant, when one exists. Resolved by
|
|
3818
|
+
* joining `participantId` to the ContactChannel collection (same join
|
|
3819
|
+
* used by message.*, reaction.received, and call.* webhooks). Best-effort:
|
|
3820
|
+
* omitted when no channel matches or `participantId` is absent. Lets
|
|
3821
|
+
* integrators seed the CRM straight from `conversation.started` without
|
|
3822
|
+
* waiting for the first `message.*` event.
|
|
3823
|
+
*
|
|
3824
|
+
*/
|
|
3825
|
+
contactId?: string;
|
|
3806
3826
|
};
|
|
3807
3827
|
account: InboxWebhookAccount;
|
|
3808
3828
|
/**
|
|
@@ -3996,24 +4016,8 @@ export type WebhookPayloadMessage = {
|
|
|
3996
4016
|
sentAt: string;
|
|
3997
4017
|
isRead: boolean;
|
|
3998
4018
|
};
|
|
3999
|
-
conversation:
|
|
4000
|
-
|
|
4001
|
-
platformConversationId: string;
|
|
4002
|
-
participantId?: string;
|
|
4003
|
-
participantName?: string;
|
|
4004
|
-
participantUsername?: string;
|
|
4005
|
-
participantPicture?: string;
|
|
4006
|
-
status: 'active' | 'archived';
|
|
4007
|
-
};
|
|
4008
|
-
account: {
|
|
4009
|
-
/**
|
|
4010
|
-
* Social account ID
|
|
4011
|
-
*/
|
|
4012
|
-
id: string;
|
|
4013
|
-
platform: string;
|
|
4014
|
-
username: string;
|
|
4015
|
-
displayName?: string;
|
|
4016
|
-
};
|
|
4019
|
+
conversation: InboxWebhookConversation;
|
|
4020
|
+
account: InboxWebhookAccount;
|
|
4017
4021
|
/**
|
|
4018
4022
|
* Interactive message metadata (present when message is a quick reply tap, postback button tap, or inline keyboard callback)
|
|
4019
4023
|
*/
|
|
@@ -4334,24 +4338,8 @@ export type WebhookPayloadMessageSent = {
|
|
|
4334
4338
|
sentAt: string;
|
|
4335
4339
|
isRead: boolean;
|
|
4336
4340
|
};
|
|
4337
|
-
conversation:
|
|
4338
|
-
|
|
4339
|
-
platformConversationId: string;
|
|
4340
|
-
participantId?: string;
|
|
4341
|
-
participantName?: string;
|
|
4342
|
-
participantUsername?: string;
|
|
4343
|
-
participantPicture?: string;
|
|
4344
|
-
status: 'active' | 'archived';
|
|
4345
|
-
};
|
|
4346
|
-
account: {
|
|
4347
|
-
/**
|
|
4348
|
-
* Social account ID
|
|
4349
|
-
*/
|
|
4350
|
-
id: string;
|
|
4351
|
-
platform: string;
|
|
4352
|
-
username: string;
|
|
4353
|
-
displayName?: string;
|
|
4354
|
-
};
|
|
4341
|
+
conversation: InboxWebhookConversation;
|
|
4342
|
+
account: InboxWebhookAccount;
|
|
4355
4343
|
timestamp: string;
|
|
4356
4344
|
};
|
|
4357
4345
|
|
|
@@ -4505,24 +4493,8 @@ export type WebhookPayloadReaction = {
|
|
|
4505
4493
|
};
|
|
4506
4494
|
reactedAt: string;
|
|
4507
4495
|
};
|
|
4508
|
-
conversation:
|
|
4509
|
-
|
|
4510
|
-
platformConversationId: string;
|
|
4511
|
-
participantId?: string;
|
|
4512
|
-
participantName?: string;
|
|
4513
|
-
participantUsername?: string;
|
|
4514
|
-
participantPicture?: string;
|
|
4515
|
-
status: 'active' | 'archived';
|
|
4516
|
-
};
|
|
4517
|
-
account: {
|
|
4518
|
-
/**
|
|
4519
|
-
* Social account ID
|
|
4520
|
-
*/
|
|
4521
|
-
id: string;
|
|
4522
|
-
platform: string;
|
|
4523
|
-
username: string;
|
|
4524
|
-
displayName?: string;
|
|
4525
|
-
};
|
|
4496
|
+
conversation: InboxWebhookConversation;
|
|
4497
|
+
account: InboxWebhookAccount;
|
|
4526
4498
|
timestamp: string;
|
|
4527
4499
|
};
|
|
4528
4500
|
|