mailmeteor 0.0.50 → 0.0.51
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.cjs +6 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +103 -0
- package/dist/index.mjs +6 -0
- package/dist/index.mjs.map +1 -1
- package/dist/types/generated-sdk/sdk.gen.d.ts +10 -0
- package/dist/types/generated-sdk/sdk.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/types.gen.d.ts +93 -0
- package/dist/types/generated-sdk/types.gen.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -382,6 +382,7 @@ type UserIdResponse200 = {
|
|
|
382
382
|
};
|
|
383
383
|
sendgrid?: {
|
|
384
384
|
api_key: string;
|
|
385
|
+
service?: string;
|
|
385
386
|
};
|
|
386
387
|
[key: string]: {
|
|
387
388
|
access_token?: string;
|
|
@@ -395,6 +396,17 @@ type UserIdResponse200 = {
|
|
|
395
396
|
service?: string;
|
|
396
397
|
} | {
|
|
397
398
|
api_key: string;
|
|
399
|
+
service?: string;
|
|
400
|
+
} | {
|
|
401
|
+
host: string;
|
|
402
|
+
port: number;
|
|
403
|
+
security: 'auto' | 'none' | 'ssl' | 'tls';
|
|
404
|
+
username: string;
|
|
405
|
+
password: string;
|
|
406
|
+
email: string;
|
|
407
|
+
service: 'smtp';
|
|
408
|
+
creation_date?: number;
|
|
409
|
+
update_date?: number;
|
|
398
410
|
} | {
|
|
399
411
|
access_token?: string;
|
|
400
412
|
refresh_token?: string;
|
|
@@ -427,6 +439,7 @@ type UserIdResponse200 = {
|
|
|
427
439
|
service?: string;
|
|
428
440
|
} | {
|
|
429
441
|
api_key: string;
|
|
442
|
+
service?: string;
|
|
430
443
|
} | undefined;
|
|
431
444
|
};
|
|
432
445
|
billing?: {
|
|
@@ -664,6 +677,9 @@ type ContactsResponse201 = {
|
|
|
664
677
|
blocked_at?: number;
|
|
665
678
|
unsubscribed?: boolean;
|
|
666
679
|
unsubscribed_at?: number;
|
|
680
|
+
consent?: {
|
|
681
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
682
|
+
};
|
|
667
683
|
contact_lists?: Array<string>;
|
|
668
684
|
properties?: {
|
|
669
685
|
[key: string]: string;
|
|
@@ -718,6 +734,9 @@ type ContactIdResponse200 = {
|
|
|
718
734
|
blocked_at?: number;
|
|
719
735
|
unsubscribed?: boolean;
|
|
720
736
|
unsubscribed_at?: number;
|
|
737
|
+
consent?: {
|
|
738
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
739
|
+
};
|
|
721
740
|
contact_lists?: Array<string>;
|
|
722
741
|
properties?: {
|
|
723
742
|
[key: string]: string;
|
|
@@ -732,6 +751,9 @@ type ContactIdResponse200 = {
|
|
|
732
751
|
type ContactIdBody = {
|
|
733
752
|
blocked?: boolean;
|
|
734
753
|
unsubscribed?: boolean;
|
|
754
|
+
consent?: {
|
|
755
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
756
|
+
};
|
|
735
757
|
contact_lists?: Array<string>;
|
|
736
758
|
properties?: {
|
|
737
759
|
[key: string]: string;
|
|
@@ -756,6 +778,9 @@ type BlockResponse200 = {
|
|
|
756
778
|
blocked_at?: number;
|
|
757
779
|
unsubscribed?: boolean;
|
|
758
780
|
unsubscribed_at?: number;
|
|
781
|
+
consent?: {
|
|
782
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
783
|
+
};
|
|
759
784
|
contact_lists?: Array<string>;
|
|
760
785
|
properties?: {
|
|
761
786
|
[key: string]: string;
|
|
@@ -782,6 +807,9 @@ type UnblockResponse200 = {
|
|
|
782
807
|
blocked_at?: number;
|
|
783
808
|
unsubscribed?: boolean;
|
|
784
809
|
unsubscribed_at?: number;
|
|
810
|
+
consent?: {
|
|
811
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
812
|
+
};
|
|
785
813
|
contact_lists?: Array<string>;
|
|
786
814
|
properties?: {
|
|
787
815
|
[key: string]: string;
|
|
@@ -808,6 +836,9 @@ type ResubscribeResponse200 = {
|
|
|
808
836
|
blocked_at?: number;
|
|
809
837
|
unsubscribed?: boolean;
|
|
810
838
|
unsubscribed_at?: number;
|
|
839
|
+
consent?: {
|
|
840
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
841
|
+
};
|
|
811
842
|
contact_lists?: Array<string>;
|
|
812
843
|
properties?: {
|
|
813
844
|
[key: string]: string;
|
|
@@ -840,6 +871,9 @@ type ContactsResponse200 = {
|
|
|
840
871
|
blocked_at?: number;
|
|
841
872
|
unsubscribed?: boolean;
|
|
842
873
|
unsubscribed_at?: number;
|
|
874
|
+
consent?: {
|
|
875
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
876
|
+
};
|
|
843
877
|
contact_lists?: Array<string>;
|
|
844
878
|
properties?: {
|
|
845
879
|
[key: string]: string;
|
|
@@ -900,6 +934,9 @@ type PipelineConversationsQuery = {
|
|
|
900
934
|
thread_id?: string;
|
|
901
935
|
last_activity_after?: number | null;
|
|
902
936
|
last_activity_before?: number | null;
|
|
937
|
+
followups?: {
|
|
938
|
+
exists: boolean;
|
|
939
|
+
};
|
|
903
940
|
limit?: number;
|
|
904
941
|
starting_after?: string;
|
|
905
942
|
ending_before?: string;
|
|
@@ -925,6 +962,7 @@ type PipelineConversationsResponse200 = {
|
|
|
925
962
|
status_updated_at: number;
|
|
926
963
|
campaign: string | null;
|
|
927
964
|
original_email: string | null;
|
|
965
|
+
followups: Array<string>;
|
|
928
966
|
opens_count: number;
|
|
929
967
|
clicks_count: number;
|
|
930
968
|
unsubscribed: boolean;
|
|
@@ -938,6 +976,10 @@ type CountQuery = {
|
|
|
938
976
|
campaign?: string;
|
|
939
977
|
last_activity_after?: number | null;
|
|
940
978
|
last_activity_before?: number | null;
|
|
979
|
+
followups?: {
|
|
980
|
+
exists: boolean;
|
|
981
|
+
};
|
|
982
|
+
is_read?: boolean;
|
|
941
983
|
group_by?: 'status';
|
|
942
984
|
};
|
|
943
985
|
type CountResponse200 = {
|
|
@@ -973,6 +1015,7 @@ type PipelineConversationIdResponse200 = {
|
|
|
973
1015
|
status_updated_at: number;
|
|
974
1016
|
campaign: string | null;
|
|
975
1017
|
original_email: string | null;
|
|
1018
|
+
followups: Array<string>;
|
|
976
1019
|
opens_count: number;
|
|
977
1020
|
clicks_count: number;
|
|
978
1021
|
unsubscribed: boolean;
|
|
@@ -1305,6 +1348,7 @@ type UsersRetrieveResponses = {
|
|
|
1305
1348
|
};
|
|
1306
1349
|
sendgrid?: {
|
|
1307
1350
|
api_key: string;
|
|
1351
|
+
service?: string;
|
|
1308
1352
|
};
|
|
1309
1353
|
[key: string]: {
|
|
1310
1354
|
access_token?: string;
|
|
@@ -1318,6 +1362,17 @@ type UsersRetrieveResponses = {
|
|
|
1318
1362
|
service?: string;
|
|
1319
1363
|
} | {
|
|
1320
1364
|
api_key: string;
|
|
1365
|
+
service?: string;
|
|
1366
|
+
} | {
|
|
1367
|
+
host: string;
|
|
1368
|
+
port: number;
|
|
1369
|
+
security: 'auto' | 'none' | 'ssl' | 'tls';
|
|
1370
|
+
username: string;
|
|
1371
|
+
password: string;
|
|
1372
|
+
email: string;
|
|
1373
|
+
service: 'smtp';
|
|
1374
|
+
creation_date?: number;
|
|
1375
|
+
update_date?: number;
|
|
1321
1376
|
} | {
|
|
1322
1377
|
access_token?: string;
|
|
1323
1378
|
refresh_token?: string;
|
|
@@ -1350,6 +1405,7 @@ type UsersRetrieveResponses = {
|
|
|
1350
1405
|
service?: string;
|
|
1351
1406
|
} | {
|
|
1352
1407
|
api_key: string;
|
|
1408
|
+
service?: string;
|
|
1353
1409
|
} | undefined;
|
|
1354
1410
|
};
|
|
1355
1411
|
billing?: {
|
|
@@ -2108,6 +2164,9 @@ type ContactsListResponses = {
|
|
|
2108
2164
|
blocked_at?: number;
|
|
2109
2165
|
unsubscribed?: boolean;
|
|
2110
2166
|
unsubscribed_at?: number;
|
|
2167
|
+
consent?: {
|
|
2168
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2169
|
+
};
|
|
2111
2170
|
contact_lists?: Array<string>;
|
|
2112
2171
|
properties?: {
|
|
2113
2172
|
[key: string]: string;
|
|
@@ -2164,6 +2223,9 @@ type ContactsCreateResponses = {
|
|
|
2164
2223
|
blocked_at?: number;
|
|
2165
2224
|
unsubscribed?: boolean;
|
|
2166
2225
|
unsubscribed_at?: number;
|
|
2226
|
+
consent?: {
|
|
2227
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2228
|
+
};
|
|
2167
2229
|
contact_lists?: Array<string>;
|
|
2168
2230
|
properties?: {
|
|
2169
2231
|
[key: string]: string;
|
|
@@ -2274,6 +2336,9 @@ type ContactsDelResponses = {
|
|
|
2274
2336
|
blocked_at?: number;
|
|
2275
2337
|
unsubscribed?: boolean;
|
|
2276
2338
|
unsubscribed_at?: number;
|
|
2339
|
+
consent?: {
|
|
2340
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2341
|
+
};
|
|
2277
2342
|
contact_lists?: Array<string>;
|
|
2278
2343
|
properties?: {
|
|
2279
2344
|
[key: string]: string;
|
|
@@ -2318,6 +2383,9 @@ type ContactsRetrieveResponses = {
|
|
|
2318
2383
|
blocked_at?: number;
|
|
2319
2384
|
unsubscribed?: boolean;
|
|
2320
2385
|
unsubscribed_at?: number;
|
|
2386
|
+
consent?: {
|
|
2387
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2388
|
+
};
|
|
2321
2389
|
contact_lists?: Array<string>;
|
|
2322
2390
|
properties?: {
|
|
2323
2391
|
[key: string]: string;
|
|
@@ -2335,6 +2403,9 @@ type ContactsUpdateData = {
|
|
|
2335
2403
|
body: {
|
|
2336
2404
|
blocked?: boolean;
|
|
2337
2405
|
unsubscribed?: boolean;
|
|
2406
|
+
consent?: {
|
|
2407
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2408
|
+
};
|
|
2338
2409
|
contact_lists?: Array<string>;
|
|
2339
2410
|
properties?: {
|
|
2340
2411
|
[key: string]: string;
|
|
@@ -2373,6 +2444,9 @@ type ContactsUpdateResponses = {
|
|
|
2373
2444
|
blocked_at?: number;
|
|
2374
2445
|
unsubscribed?: boolean;
|
|
2375
2446
|
unsubscribed_at?: number;
|
|
2447
|
+
consent?: {
|
|
2448
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2449
|
+
};
|
|
2376
2450
|
contact_lists?: Array<string>;
|
|
2377
2451
|
properties?: {
|
|
2378
2452
|
[key: string]: string;
|
|
@@ -2417,6 +2491,9 @@ type ContactsBlockResponses = {
|
|
|
2417
2491
|
blocked_at?: number;
|
|
2418
2492
|
unsubscribed?: boolean;
|
|
2419
2493
|
unsubscribed_at?: number;
|
|
2494
|
+
consent?: {
|
|
2495
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2496
|
+
};
|
|
2420
2497
|
contact_lists?: Array<string>;
|
|
2421
2498
|
properties?: {
|
|
2422
2499
|
[key: string]: string;
|
|
@@ -2461,6 +2538,9 @@ type ContactsUnblockResponses = {
|
|
|
2461
2538
|
blocked_at?: number;
|
|
2462
2539
|
unsubscribed?: boolean;
|
|
2463
2540
|
unsubscribed_at?: number;
|
|
2541
|
+
consent?: {
|
|
2542
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2543
|
+
};
|
|
2464
2544
|
contact_lists?: Array<string>;
|
|
2465
2545
|
properties?: {
|
|
2466
2546
|
[key: string]: string;
|
|
@@ -2505,6 +2585,9 @@ type ContactsResubscribeResponses = {
|
|
|
2505
2585
|
blocked_at?: number;
|
|
2506
2586
|
unsubscribed?: boolean;
|
|
2507
2587
|
unsubscribed_at?: number;
|
|
2588
|
+
consent?: {
|
|
2589
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
2590
|
+
};
|
|
2508
2591
|
contact_lists?: Array<string>;
|
|
2509
2592
|
properties?: {
|
|
2510
2593
|
[key: string]: string;
|
|
@@ -2660,6 +2743,9 @@ type PipelineConversationsListData = {
|
|
|
2660
2743
|
thread_id?: string;
|
|
2661
2744
|
last_activity_after?: number | null;
|
|
2662
2745
|
last_activity_before?: number | null;
|
|
2746
|
+
followups?: {
|
|
2747
|
+
exists: boolean;
|
|
2748
|
+
};
|
|
2663
2749
|
limit?: number;
|
|
2664
2750
|
starting_after?: string;
|
|
2665
2751
|
ending_before?: string;
|
|
@@ -2698,6 +2784,7 @@ type PipelineConversationsListResponses = {
|
|
|
2698
2784
|
status_updated_at: number;
|
|
2699
2785
|
campaign: string | null;
|
|
2700
2786
|
original_email: string | null;
|
|
2787
|
+
followups: Array<string>;
|
|
2701
2788
|
opens_count: number;
|
|
2702
2789
|
clicks_count: number;
|
|
2703
2790
|
unsubscribed: boolean;
|
|
@@ -2716,6 +2803,10 @@ type PipelineConversationsCountData = {
|
|
|
2716
2803
|
campaign?: string;
|
|
2717
2804
|
last_activity_after?: number | null;
|
|
2718
2805
|
last_activity_before?: number | null;
|
|
2806
|
+
followups?: {
|
|
2807
|
+
exists: boolean;
|
|
2808
|
+
};
|
|
2809
|
+
is_read?: boolean;
|
|
2719
2810
|
group_by?: 'status';
|
|
2720
2811
|
};
|
|
2721
2812
|
url: '/pipeline_conversations/count';
|
|
@@ -2782,6 +2873,7 @@ type PipelineConversationsRetrieveResponses = {
|
|
|
2782
2873
|
status_updated_at: number;
|
|
2783
2874
|
campaign: string | null;
|
|
2784
2875
|
original_email: string | null;
|
|
2876
|
+
followups: Array<string>;
|
|
2785
2877
|
opens_count: number;
|
|
2786
2878
|
clicks_count: number;
|
|
2787
2879
|
unsubscribed: boolean;
|
|
@@ -2835,6 +2927,7 @@ type PipelineConversationsUpdateResponses = {
|
|
|
2835
2927
|
status_updated_at: number;
|
|
2836
2928
|
campaign: string | null;
|
|
2837
2929
|
original_email: string | null;
|
|
2930
|
+
followups: Array<string>;
|
|
2838
2931
|
opens_count: number;
|
|
2839
2932
|
clicks_count: number;
|
|
2840
2933
|
unsubscribed: boolean;
|
|
@@ -3766,6 +3859,9 @@ declare class Contacts extends HeyApiClient {
|
|
|
3766
3859
|
update<ThrowOnError extends boolean = true>(contact_id: string, parameters?: {
|
|
3767
3860
|
blocked?: boolean;
|
|
3768
3861
|
unsubscribed?: boolean;
|
|
3862
|
+
consent?: {
|
|
3863
|
+
tracking?: 'none' | 'opt-in' | 'opt-out';
|
|
3864
|
+
};
|
|
3769
3865
|
contact_lists?: Array<string>;
|
|
3770
3866
|
properties?: {
|
|
3771
3867
|
[key: string]: string;
|
|
@@ -3798,6 +3894,9 @@ declare class PipelineConversations extends HeyApiClient {
|
|
|
3798
3894
|
thread_id?: string;
|
|
3799
3895
|
last_activity_after?: number | null;
|
|
3800
3896
|
last_activity_before?: number | null;
|
|
3897
|
+
followups?: {
|
|
3898
|
+
exists: boolean;
|
|
3899
|
+
};
|
|
3801
3900
|
limit?: number;
|
|
3802
3901
|
starting_after?: string;
|
|
3803
3902
|
ending_before?: string;
|
|
@@ -3809,6 +3908,10 @@ declare class PipelineConversations extends HeyApiClient {
|
|
|
3809
3908
|
campaign?: string;
|
|
3810
3909
|
last_activity_after?: number | null;
|
|
3811
3910
|
last_activity_before?: number | null;
|
|
3911
|
+
followups?: {
|
|
3912
|
+
exists: boolean;
|
|
3913
|
+
};
|
|
3914
|
+
is_read?: boolean;
|
|
3812
3915
|
group_by?: 'status';
|
|
3813
3916
|
}, options?: Options<never, ThrowOnError>): RequestResult<PipelineConversationsCountResponses, PipelineConversationsCountErrors, ThrowOnError, "data">;
|
|
3814
3917
|
retrieve<ThrowOnError extends boolean = true>(pipeline_conversation_id: string, parameters?: {
|
package/dist/index.mjs
CHANGED
|
@@ -1474,6 +1474,7 @@ class Contacts extends HeyApiClient {
|
|
|
1474
1474
|
const params = buildClientParams([contact_id, parameters], [{ in: 'path', key: 'contact_id' }, { args: [
|
|
1475
1475
|
{ in: 'body', key: 'blocked' },
|
|
1476
1476
|
{ in: 'body', key: 'unsubscribed' },
|
|
1477
|
+
{ in: 'body', key: 'consent' },
|
|
1477
1478
|
{ in: 'body', key: 'contact_lists' },
|
|
1478
1479
|
{ in: 'body', key: 'properties' },
|
|
1479
1480
|
{ in: 'body', key: 'notes' },
|
|
@@ -1595,12 +1596,14 @@ class PipelineConversations extends HeyApiClient {
|
|
|
1595
1596
|
{ in: 'query', key: 'thread_id' },
|
|
1596
1597
|
{ in: 'query', key: 'last_activity_after' },
|
|
1597
1598
|
{ in: 'query', key: 'last_activity_before' },
|
|
1599
|
+
{ in: 'query', key: 'followups' },
|
|
1598
1600
|
{ in: 'query', key: 'limit' },
|
|
1599
1601
|
{ in: 'query', key: 'starting_after' },
|
|
1600
1602
|
{ in: 'query', key: 'ending_before' },
|
|
1601
1603
|
{ in: 'query', key: 'include_metrics' }
|
|
1602
1604
|
] }]);
|
|
1603
1605
|
return (options?.client ?? this.client).get({
|
|
1606
|
+
querySerializer: { parameters: { followups: { object: { style: 'form' } } } },
|
|
1604
1607
|
responseStyle: 'data',
|
|
1605
1608
|
url: '/pipeline_conversations',
|
|
1606
1609
|
...options,
|
|
@@ -1614,9 +1617,12 @@ class PipelineConversations extends HeyApiClient {
|
|
|
1614
1617
|
{ in: 'query', key: 'campaign' },
|
|
1615
1618
|
{ in: 'query', key: 'last_activity_after' },
|
|
1616
1619
|
{ in: 'query', key: 'last_activity_before' },
|
|
1620
|
+
{ in: 'query', key: 'followups' },
|
|
1621
|
+
{ in: 'query', key: 'is_read' },
|
|
1617
1622
|
{ in: 'query', key: 'group_by' }
|
|
1618
1623
|
] }]);
|
|
1619
1624
|
return (options?.client ?? this.client).get({
|
|
1625
|
+
querySerializer: { parameters: { followups: { object: { style: 'form' } } } },
|
|
1620
1626
|
responseStyle: 'data',
|
|
1621
1627
|
url: '/pipeline_conversations/count',
|
|
1622
1628
|
...options,
|