@wraps.dev/client 0.2.0 → 0.4.0
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 +337 -0
- package/dist/index.d.ts +337 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -146,6 +146,86 @@ interface paths {
|
|
|
146
146
|
patch?: never;
|
|
147
147
|
trace?: never;
|
|
148
148
|
};
|
|
149
|
+
"/v1/events/": {
|
|
150
|
+
parameters: {
|
|
151
|
+
query?: never;
|
|
152
|
+
header?: never;
|
|
153
|
+
path?: never;
|
|
154
|
+
cookie?: never;
|
|
155
|
+
};
|
|
156
|
+
get?: never;
|
|
157
|
+
put?: never;
|
|
158
|
+
/**
|
|
159
|
+
* Ingest event
|
|
160
|
+
* @description Send a custom event to trigger workflows and resume waiting executions
|
|
161
|
+
*/
|
|
162
|
+
post: operations["postV1Events"];
|
|
163
|
+
delete?: never;
|
|
164
|
+
options?: never;
|
|
165
|
+
head?: never;
|
|
166
|
+
patch?: never;
|
|
167
|
+
trace?: never;
|
|
168
|
+
};
|
|
169
|
+
"/v1/events/batch": {
|
|
170
|
+
parameters: {
|
|
171
|
+
query?: never;
|
|
172
|
+
header?: never;
|
|
173
|
+
path?: never;
|
|
174
|
+
cookie?: never;
|
|
175
|
+
};
|
|
176
|
+
get?: never;
|
|
177
|
+
put?: never;
|
|
178
|
+
/**
|
|
179
|
+
* Batch ingest events
|
|
180
|
+
* @description Process multiple events in a single request
|
|
181
|
+
*/
|
|
182
|
+
post: operations["postV1EventsBatch"];
|
|
183
|
+
delete?: never;
|
|
184
|
+
options?: never;
|
|
185
|
+
head?: never;
|
|
186
|
+
patch?: never;
|
|
187
|
+
trace?: never;
|
|
188
|
+
};
|
|
189
|
+
"/v1/workflows/{workflowId}/trigger": {
|
|
190
|
+
parameters: {
|
|
191
|
+
query?: never;
|
|
192
|
+
header?: never;
|
|
193
|
+
path?: never;
|
|
194
|
+
cookie?: never;
|
|
195
|
+
};
|
|
196
|
+
get?: never;
|
|
197
|
+
put?: never;
|
|
198
|
+
/**
|
|
199
|
+
* Trigger workflow
|
|
200
|
+
* @description Trigger a specific workflow for a contact. The workflow must have triggerType 'api' and be enabled.
|
|
201
|
+
*/
|
|
202
|
+
post: operations["postV1WorkflowsByWorkflowIdTrigger"];
|
|
203
|
+
delete?: never;
|
|
204
|
+
options?: never;
|
|
205
|
+
head?: never;
|
|
206
|
+
patch?: never;
|
|
207
|
+
trace?: never;
|
|
208
|
+
};
|
|
209
|
+
"/v1/workflows/{workflowId}/trigger/batch": {
|
|
210
|
+
parameters: {
|
|
211
|
+
query?: never;
|
|
212
|
+
header?: never;
|
|
213
|
+
path?: never;
|
|
214
|
+
cookie?: never;
|
|
215
|
+
};
|
|
216
|
+
get?: never;
|
|
217
|
+
put?: never;
|
|
218
|
+
/**
|
|
219
|
+
* Batch trigger workflow
|
|
220
|
+
* @description Trigger a workflow for multiple contacts at once. Each contact can have its own data that gets merged with common data.
|
|
221
|
+
*/
|
|
222
|
+
post: operations["postV1WorkflowsByWorkflowIdTriggerBatch"];
|
|
223
|
+
delete?: never;
|
|
224
|
+
options?: never;
|
|
225
|
+
head?: never;
|
|
226
|
+
patch?: never;
|
|
227
|
+
trace?: never;
|
|
228
|
+
};
|
|
149
229
|
"/webhooks/ses/{awsAccountNumber}": {
|
|
150
230
|
parameters: {
|
|
151
231
|
query?: never;
|
|
@@ -261,6 +341,10 @@ interface operations {
|
|
|
261
341
|
"application/json": {
|
|
262
342
|
email?: string;
|
|
263
343
|
phone?: string;
|
|
344
|
+
firstName?: string;
|
|
345
|
+
lastName?: string;
|
|
346
|
+
company?: string;
|
|
347
|
+
jobTitle?: string;
|
|
264
348
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
265
349
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
266
350
|
properties?: {
|
|
@@ -272,6 +356,10 @@ interface operations {
|
|
|
272
356
|
"multipart/form-data": {
|
|
273
357
|
email?: string;
|
|
274
358
|
phone?: string;
|
|
359
|
+
firstName?: string;
|
|
360
|
+
lastName?: string;
|
|
361
|
+
company?: string;
|
|
362
|
+
jobTitle?: string;
|
|
275
363
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
276
364
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
277
365
|
properties?: {
|
|
@@ -283,6 +371,10 @@ interface operations {
|
|
|
283
371
|
"text/plain": {
|
|
284
372
|
email?: string;
|
|
285
373
|
phone?: string;
|
|
374
|
+
firstName?: string;
|
|
375
|
+
lastName?: string;
|
|
376
|
+
company?: string;
|
|
377
|
+
jobTitle?: string;
|
|
286
378
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
287
379
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
288
380
|
properties?: {
|
|
@@ -383,6 +475,10 @@ interface operations {
|
|
|
383
475
|
"application/json": {
|
|
384
476
|
email?: string;
|
|
385
477
|
phone?: string;
|
|
478
|
+
firstName?: (string | null) | null;
|
|
479
|
+
lastName?: (string | null) | null;
|
|
480
|
+
company?: (string | null) | null;
|
|
481
|
+
jobTitle?: (string | null) | null;
|
|
386
482
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
387
483
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
388
484
|
properties?: {
|
|
@@ -394,6 +490,10 @@ interface operations {
|
|
|
394
490
|
"multipart/form-data": {
|
|
395
491
|
email?: string;
|
|
396
492
|
phone?: string;
|
|
493
|
+
firstName?: (string | null) | null;
|
|
494
|
+
lastName?: (string | null) | null;
|
|
495
|
+
company?: (string | null) | null;
|
|
496
|
+
jobTitle?: (string | null) | null;
|
|
397
497
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
398
498
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
399
499
|
properties?: {
|
|
@@ -405,6 +505,10 @@ interface operations {
|
|
|
405
505
|
"text/plain": {
|
|
406
506
|
email?: string;
|
|
407
507
|
phone?: string;
|
|
508
|
+
firstName?: (string | null) | null;
|
|
509
|
+
lastName?: (string | null) | null;
|
|
510
|
+
company?: (string | null) | null;
|
|
511
|
+
jobTitle?: (string | null) | null;
|
|
408
512
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
409
513
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
410
514
|
properties?: {
|
|
@@ -436,6 +540,9 @@ interface operations {
|
|
|
436
540
|
"application/json": {
|
|
437
541
|
channel?: "email" | "sms";
|
|
438
542
|
name?: string;
|
|
543
|
+
audienceType?: "all" | "topic" | "segment";
|
|
544
|
+
topicId?: string;
|
|
545
|
+
segmentId?: string;
|
|
439
546
|
subject?: string;
|
|
440
547
|
previewText?: string;
|
|
441
548
|
from?: string;
|
|
@@ -452,6 +559,9 @@ interface operations {
|
|
|
452
559
|
"multipart/form-data": {
|
|
453
560
|
channel?: "email" | "sms";
|
|
454
561
|
name?: string;
|
|
562
|
+
audienceType?: "all" | "topic" | "segment";
|
|
563
|
+
topicId?: string;
|
|
564
|
+
segmentId?: string;
|
|
455
565
|
subject?: string;
|
|
456
566
|
previewText?: string;
|
|
457
567
|
from?: string;
|
|
@@ -468,6 +578,9 @@ interface operations {
|
|
|
468
578
|
"text/plain": {
|
|
469
579
|
channel?: "email" | "sms";
|
|
470
580
|
name?: string;
|
|
581
|
+
audienceType?: "all" | "topic" | "segment";
|
|
582
|
+
topicId?: string;
|
|
583
|
+
segmentId?: string;
|
|
471
584
|
subject?: string;
|
|
472
585
|
previewText?: string;
|
|
473
586
|
from?: string;
|
|
@@ -568,6 +681,230 @@ interface operations {
|
|
|
568
681
|
};
|
|
569
682
|
};
|
|
570
683
|
};
|
|
684
|
+
postV1Events: {
|
|
685
|
+
parameters: {
|
|
686
|
+
query?: never;
|
|
687
|
+
header?: never;
|
|
688
|
+
path?: never;
|
|
689
|
+
cookie?: never;
|
|
690
|
+
};
|
|
691
|
+
requestBody: {
|
|
692
|
+
content: {
|
|
693
|
+
"application/json": {
|
|
694
|
+
/** @description Event name (e.g., 'purchase.completed') */
|
|
695
|
+
name: string;
|
|
696
|
+
/** @description Contact ID */
|
|
697
|
+
contactId?: string;
|
|
698
|
+
/** @description Contact email (alternative to contactId) */
|
|
699
|
+
contactEmail?: string;
|
|
700
|
+
/** @description Event properties */
|
|
701
|
+
properties?: {
|
|
702
|
+
[key: string]: unknown;
|
|
703
|
+
};
|
|
704
|
+
};
|
|
705
|
+
"multipart/form-data": {
|
|
706
|
+
/** @description Event name (e.g., 'purchase.completed') */
|
|
707
|
+
name: string;
|
|
708
|
+
/** @description Contact ID */
|
|
709
|
+
contactId?: string;
|
|
710
|
+
/** @description Contact email (alternative to contactId) */
|
|
711
|
+
contactEmail?: string;
|
|
712
|
+
/** @description Event properties */
|
|
713
|
+
properties?: {
|
|
714
|
+
[key: string]: unknown;
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
"text/plain": {
|
|
718
|
+
/** @description Event name (e.g., 'purchase.completed') */
|
|
719
|
+
name: string;
|
|
720
|
+
/** @description Contact ID */
|
|
721
|
+
contactId?: string;
|
|
722
|
+
/** @description Contact email (alternative to contactId) */
|
|
723
|
+
contactEmail?: string;
|
|
724
|
+
/** @description Event properties */
|
|
725
|
+
properties?: {
|
|
726
|
+
[key: string]: unknown;
|
|
727
|
+
};
|
|
728
|
+
};
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
responses: {
|
|
732
|
+
200: {
|
|
733
|
+
headers: {
|
|
734
|
+
[name: string]: unknown;
|
|
735
|
+
};
|
|
736
|
+
content?: never;
|
|
737
|
+
};
|
|
738
|
+
};
|
|
739
|
+
};
|
|
740
|
+
postV1EventsBatch: {
|
|
741
|
+
parameters: {
|
|
742
|
+
query?: never;
|
|
743
|
+
header?: never;
|
|
744
|
+
path?: never;
|
|
745
|
+
cookie?: never;
|
|
746
|
+
};
|
|
747
|
+
requestBody: {
|
|
748
|
+
content: {
|
|
749
|
+
"application/json": {
|
|
750
|
+
events: {
|
|
751
|
+
name: string;
|
|
752
|
+
contactId?: string;
|
|
753
|
+
contactEmail?: string;
|
|
754
|
+
properties?: {
|
|
755
|
+
[key: string]: unknown;
|
|
756
|
+
};
|
|
757
|
+
}[];
|
|
758
|
+
};
|
|
759
|
+
"multipart/form-data": {
|
|
760
|
+
events: {
|
|
761
|
+
name: string;
|
|
762
|
+
contactId?: string;
|
|
763
|
+
contactEmail?: string;
|
|
764
|
+
properties?: {
|
|
765
|
+
[key: string]: unknown;
|
|
766
|
+
};
|
|
767
|
+
}[];
|
|
768
|
+
};
|
|
769
|
+
"text/plain": {
|
|
770
|
+
events: {
|
|
771
|
+
name: string;
|
|
772
|
+
contactId?: string;
|
|
773
|
+
contactEmail?: string;
|
|
774
|
+
properties?: {
|
|
775
|
+
[key: string]: unknown;
|
|
776
|
+
};
|
|
777
|
+
}[];
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
};
|
|
781
|
+
responses: {
|
|
782
|
+
200: {
|
|
783
|
+
headers: {
|
|
784
|
+
[name: string]: unknown;
|
|
785
|
+
};
|
|
786
|
+
content?: never;
|
|
787
|
+
};
|
|
788
|
+
};
|
|
789
|
+
};
|
|
790
|
+
postV1WorkflowsByWorkflowIdTrigger: {
|
|
791
|
+
parameters: {
|
|
792
|
+
query?: never;
|
|
793
|
+
header?: never;
|
|
794
|
+
path: {
|
|
795
|
+
/** @description Workflow ID to trigger */
|
|
796
|
+
workflowId: string;
|
|
797
|
+
};
|
|
798
|
+
cookie?: never;
|
|
799
|
+
};
|
|
800
|
+
requestBody: {
|
|
801
|
+
content: {
|
|
802
|
+
"application/json": {
|
|
803
|
+
/** @description Contact ID */
|
|
804
|
+
contactId?: string;
|
|
805
|
+
/** @description Contact email (alternative to contactId) */
|
|
806
|
+
contactEmail?: string;
|
|
807
|
+
/** @description Data to pass to the workflow as trigger data */
|
|
808
|
+
data?: {
|
|
809
|
+
[key: string]: unknown;
|
|
810
|
+
};
|
|
811
|
+
};
|
|
812
|
+
"multipart/form-data": {
|
|
813
|
+
/** @description Contact ID */
|
|
814
|
+
contactId?: string;
|
|
815
|
+
/** @description Contact email (alternative to contactId) */
|
|
816
|
+
contactEmail?: string;
|
|
817
|
+
/** @description Data to pass to the workflow as trigger data */
|
|
818
|
+
data?: {
|
|
819
|
+
[key: string]: unknown;
|
|
820
|
+
};
|
|
821
|
+
};
|
|
822
|
+
"text/plain": {
|
|
823
|
+
/** @description Contact ID */
|
|
824
|
+
contactId?: string;
|
|
825
|
+
/** @description Contact email (alternative to contactId) */
|
|
826
|
+
contactEmail?: string;
|
|
827
|
+
/** @description Data to pass to the workflow as trigger data */
|
|
828
|
+
data?: {
|
|
829
|
+
[key: string]: unknown;
|
|
830
|
+
};
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
responses: {
|
|
835
|
+
200: {
|
|
836
|
+
headers: {
|
|
837
|
+
[name: string]: unknown;
|
|
838
|
+
};
|
|
839
|
+
content?: never;
|
|
840
|
+
};
|
|
841
|
+
};
|
|
842
|
+
};
|
|
843
|
+
postV1WorkflowsByWorkflowIdTriggerBatch: {
|
|
844
|
+
parameters: {
|
|
845
|
+
query?: never;
|
|
846
|
+
header?: never;
|
|
847
|
+
path: {
|
|
848
|
+
/** @description Workflow ID to trigger */
|
|
849
|
+
workflowId: string;
|
|
850
|
+
};
|
|
851
|
+
cookie?: never;
|
|
852
|
+
};
|
|
853
|
+
requestBody: {
|
|
854
|
+
content: {
|
|
855
|
+
"application/json": {
|
|
856
|
+
/** @description List of contacts to trigger the workflow for */
|
|
857
|
+
contacts: {
|
|
858
|
+
contactId?: string;
|
|
859
|
+
contactEmail?: string;
|
|
860
|
+
data?: {
|
|
861
|
+
[key: string]: unknown;
|
|
862
|
+
};
|
|
863
|
+
}[];
|
|
864
|
+
/** @description Common data to pass to all workflow triggers */
|
|
865
|
+
data?: {
|
|
866
|
+
[key: string]: unknown;
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
"multipart/form-data": {
|
|
870
|
+
/** @description List of contacts to trigger the workflow for */
|
|
871
|
+
contacts: {
|
|
872
|
+
contactId?: string;
|
|
873
|
+
contactEmail?: string;
|
|
874
|
+
data?: {
|
|
875
|
+
[key: string]: unknown;
|
|
876
|
+
};
|
|
877
|
+
}[];
|
|
878
|
+
/** @description Common data to pass to all workflow triggers */
|
|
879
|
+
data?: {
|
|
880
|
+
[key: string]: unknown;
|
|
881
|
+
};
|
|
882
|
+
};
|
|
883
|
+
"text/plain": {
|
|
884
|
+
/** @description List of contacts to trigger the workflow for */
|
|
885
|
+
contacts: {
|
|
886
|
+
contactId?: string;
|
|
887
|
+
contactEmail?: string;
|
|
888
|
+
data?: {
|
|
889
|
+
[key: string]: unknown;
|
|
890
|
+
};
|
|
891
|
+
}[];
|
|
892
|
+
/** @description Common data to pass to all workflow triggers */
|
|
893
|
+
data?: {
|
|
894
|
+
[key: string]: unknown;
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
};
|
|
899
|
+
responses: {
|
|
900
|
+
200: {
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content?: never;
|
|
905
|
+
};
|
|
906
|
+
};
|
|
907
|
+
};
|
|
571
908
|
postWebhooksSesByAwsAccountNumber: {
|
|
572
909
|
parameters: {
|
|
573
910
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -146,6 +146,86 @@ interface paths {
|
|
|
146
146
|
patch?: never;
|
|
147
147
|
trace?: never;
|
|
148
148
|
};
|
|
149
|
+
"/v1/events/": {
|
|
150
|
+
parameters: {
|
|
151
|
+
query?: never;
|
|
152
|
+
header?: never;
|
|
153
|
+
path?: never;
|
|
154
|
+
cookie?: never;
|
|
155
|
+
};
|
|
156
|
+
get?: never;
|
|
157
|
+
put?: never;
|
|
158
|
+
/**
|
|
159
|
+
* Ingest event
|
|
160
|
+
* @description Send a custom event to trigger workflows and resume waiting executions
|
|
161
|
+
*/
|
|
162
|
+
post: operations["postV1Events"];
|
|
163
|
+
delete?: never;
|
|
164
|
+
options?: never;
|
|
165
|
+
head?: never;
|
|
166
|
+
patch?: never;
|
|
167
|
+
trace?: never;
|
|
168
|
+
};
|
|
169
|
+
"/v1/events/batch": {
|
|
170
|
+
parameters: {
|
|
171
|
+
query?: never;
|
|
172
|
+
header?: never;
|
|
173
|
+
path?: never;
|
|
174
|
+
cookie?: never;
|
|
175
|
+
};
|
|
176
|
+
get?: never;
|
|
177
|
+
put?: never;
|
|
178
|
+
/**
|
|
179
|
+
* Batch ingest events
|
|
180
|
+
* @description Process multiple events in a single request
|
|
181
|
+
*/
|
|
182
|
+
post: operations["postV1EventsBatch"];
|
|
183
|
+
delete?: never;
|
|
184
|
+
options?: never;
|
|
185
|
+
head?: never;
|
|
186
|
+
patch?: never;
|
|
187
|
+
trace?: never;
|
|
188
|
+
};
|
|
189
|
+
"/v1/workflows/{workflowId}/trigger": {
|
|
190
|
+
parameters: {
|
|
191
|
+
query?: never;
|
|
192
|
+
header?: never;
|
|
193
|
+
path?: never;
|
|
194
|
+
cookie?: never;
|
|
195
|
+
};
|
|
196
|
+
get?: never;
|
|
197
|
+
put?: never;
|
|
198
|
+
/**
|
|
199
|
+
* Trigger workflow
|
|
200
|
+
* @description Trigger a specific workflow for a contact. The workflow must have triggerType 'api' and be enabled.
|
|
201
|
+
*/
|
|
202
|
+
post: operations["postV1WorkflowsByWorkflowIdTrigger"];
|
|
203
|
+
delete?: never;
|
|
204
|
+
options?: never;
|
|
205
|
+
head?: never;
|
|
206
|
+
patch?: never;
|
|
207
|
+
trace?: never;
|
|
208
|
+
};
|
|
209
|
+
"/v1/workflows/{workflowId}/trigger/batch": {
|
|
210
|
+
parameters: {
|
|
211
|
+
query?: never;
|
|
212
|
+
header?: never;
|
|
213
|
+
path?: never;
|
|
214
|
+
cookie?: never;
|
|
215
|
+
};
|
|
216
|
+
get?: never;
|
|
217
|
+
put?: never;
|
|
218
|
+
/**
|
|
219
|
+
* Batch trigger workflow
|
|
220
|
+
* @description Trigger a workflow for multiple contacts at once. Each contact can have its own data that gets merged with common data.
|
|
221
|
+
*/
|
|
222
|
+
post: operations["postV1WorkflowsByWorkflowIdTriggerBatch"];
|
|
223
|
+
delete?: never;
|
|
224
|
+
options?: never;
|
|
225
|
+
head?: never;
|
|
226
|
+
patch?: never;
|
|
227
|
+
trace?: never;
|
|
228
|
+
};
|
|
149
229
|
"/webhooks/ses/{awsAccountNumber}": {
|
|
150
230
|
parameters: {
|
|
151
231
|
query?: never;
|
|
@@ -261,6 +341,10 @@ interface operations {
|
|
|
261
341
|
"application/json": {
|
|
262
342
|
email?: string;
|
|
263
343
|
phone?: string;
|
|
344
|
+
firstName?: string;
|
|
345
|
+
lastName?: string;
|
|
346
|
+
company?: string;
|
|
347
|
+
jobTitle?: string;
|
|
264
348
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
265
349
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
266
350
|
properties?: {
|
|
@@ -272,6 +356,10 @@ interface operations {
|
|
|
272
356
|
"multipart/form-data": {
|
|
273
357
|
email?: string;
|
|
274
358
|
phone?: string;
|
|
359
|
+
firstName?: string;
|
|
360
|
+
lastName?: string;
|
|
361
|
+
company?: string;
|
|
362
|
+
jobTitle?: string;
|
|
275
363
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
276
364
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
277
365
|
properties?: {
|
|
@@ -283,6 +371,10 @@ interface operations {
|
|
|
283
371
|
"text/plain": {
|
|
284
372
|
email?: string;
|
|
285
373
|
phone?: string;
|
|
374
|
+
firstName?: string;
|
|
375
|
+
lastName?: string;
|
|
376
|
+
company?: string;
|
|
377
|
+
jobTitle?: string;
|
|
286
378
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
287
379
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
288
380
|
properties?: {
|
|
@@ -383,6 +475,10 @@ interface operations {
|
|
|
383
475
|
"application/json": {
|
|
384
476
|
email?: string;
|
|
385
477
|
phone?: string;
|
|
478
|
+
firstName?: (string | null) | null;
|
|
479
|
+
lastName?: (string | null) | null;
|
|
480
|
+
company?: (string | null) | null;
|
|
481
|
+
jobTitle?: (string | null) | null;
|
|
386
482
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
387
483
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
388
484
|
properties?: {
|
|
@@ -394,6 +490,10 @@ interface operations {
|
|
|
394
490
|
"multipart/form-data": {
|
|
395
491
|
email?: string;
|
|
396
492
|
phone?: string;
|
|
493
|
+
firstName?: (string | null) | null;
|
|
494
|
+
lastName?: (string | null) | null;
|
|
495
|
+
company?: (string | null) | null;
|
|
496
|
+
jobTitle?: (string | null) | null;
|
|
397
497
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
398
498
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
399
499
|
properties?: {
|
|
@@ -405,6 +505,10 @@ interface operations {
|
|
|
405
505
|
"text/plain": {
|
|
406
506
|
email?: string;
|
|
407
507
|
phone?: string;
|
|
508
|
+
firstName?: (string | null) | null;
|
|
509
|
+
lastName?: (string | null) | null;
|
|
510
|
+
company?: (string | null) | null;
|
|
511
|
+
jobTitle?: (string | null) | null;
|
|
408
512
|
emailStatus?: "active" | "unsubscribed" | "bounced" | "complained";
|
|
409
513
|
smsStatus?: "pending_consent" | "opted_in" | "opted_out" | "invalid";
|
|
410
514
|
properties?: {
|
|
@@ -436,6 +540,9 @@ interface operations {
|
|
|
436
540
|
"application/json": {
|
|
437
541
|
channel?: "email" | "sms";
|
|
438
542
|
name?: string;
|
|
543
|
+
audienceType?: "all" | "topic" | "segment";
|
|
544
|
+
topicId?: string;
|
|
545
|
+
segmentId?: string;
|
|
439
546
|
subject?: string;
|
|
440
547
|
previewText?: string;
|
|
441
548
|
from?: string;
|
|
@@ -452,6 +559,9 @@ interface operations {
|
|
|
452
559
|
"multipart/form-data": {
|
|
453
560
|
channel?: "email" | "sms";
|
|
454
561
|
name?: string;
|
|
562
|
+
audienceType?: "all" | "topic" | "segment";
|
|
563
|
+
topicId?: string;
|
|
564
|
+
segmentId?: string;
|
|
455
565
|
subject?: string;
|
|
456
566
|
previewText?: string;
|
|
457
567
|
from?: string;
|
|
@@ -468,6 +578,9 @@ interface operations {
|
|
|
468
578
|
"text/plain": {
|
|
469
579
|
channel?: "email" | "sms";
|
|
470
580
|
name?: string;
|
|
581
|
+
audienceType?: "all" | "topic" | "segment";
|
|
582
|
+
topicId?: string;
|
|
583
|
+
segmentId?: string;
|
|
471
584
|
subject?: string;
|
|
472
585
|
previewText?: string;
|
|
473
586
|
from?: string;
|
|
@@ -568,6 +681,230 @@ interface operations {
|
|
|
568
681
|
};
|
|
569
682
|
};
|
|
570
683
|
};
|
|
684
|
+
postV1Events: {
|
|
685
|
+
parameters: {
|
|
686
|
+
query?: never;
|
|
687
|
+
header?: never;
|
|
688
|
+
path?: never;
|
|
689
|
+
cookie?: never;
|
|
690
|
+
};
|
|
691
|
+
requestBody: {
|
|
692
|
+
content: {
|
|
693
|
+
"application/json": {
|
|
694
|
+
/** @description Event name (e.g., 'purchase.completed') */
|
|
695
|
+
name: string;
|
|
696
|
+
/** @description Contact ID */
|
|
697
|
+
contactId?: string;
|
|
698
|
+
/** @description Contact email (alternative to contactId) */
|
|
699
|
+
contactEmail?: string;
|
|
700
|
+
/** @description Event properties */
|
|
701
|
+
properties?: {
|
|
702
|
+
[key: string]: unknown;
|
|
703
|
+
};
|
|
704
|
+
};
|
|
705
|
+
"multipart/form-data": {
|
|
706
|
+
/** @description Event name (e.g., 'purchase.completed') */
|
|
707
|
+
name: string;
|
|
708
|
+
/** @description Contact ID */
|
|
709
|
+
contactId?: string;
|
|
710
|
+
/** @description Contact email (alternative to contactId) */
|
|
711
|
+
contactEmail?: string;
|
|
712
|
+
/** @description Event properties */
|
|
713
|
+
properties?: {
|
|
714
|
+
[key: string]: unknown;
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
"text/plain": {
|
|
718
|
+
/** @description Event name (e.g., 'purchase.completed') */
|
|
719
|
+
name: string;
|
|
720
|
+
/** @description Contact ID */
|
|
721
|
+
contactId?: string;
|
|
722
|
+
/** @description Contact email (alternative to contactId) */
|
|
723
|
+
contactEmail?: string;
|
|
724
|
+
/** @description Event properties */
|
|
725
|
+
properties?: {
|
|
726
|
+
[key: string]: unknown;
|
|
727
|
+
};
|
|
728
|
+
};
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
responses: {
|
|
732
|
+
200: {
|
|
733
|
+
headers: {
|
|
734
|
+
[name: string]: unknown;
|
|
735
|
+
};
|
|
736
|
+
content?: never;
|
|
737
|
+
};
|
|
738
|
+
};
|
|
739
|
+
};
|
|
740
|
+
postV1EventsBatch: {
|
|
741
|
+
parameters: {
|
|
742
|
+
query?: never;
|
|
743
|
+
header?: never;
|
|
744
|
+
path?: never;
|
|
745
|
+
cookie?: never;
|
|
746
|
+
};
|
|
747
|
+
requestBody: {
|
|
748
|
+
content: {
|
|
749
|
+
"application/json": {
|
|
750
|
+
events: {
|
|
751
|
+
name: string;
|
|
752
|
+
contactId?: string;
|
|
753
|
+
contactEmail?: string;
|
|
754
|
+
properties?: {
|
|
755
|
+
[key: string]: unknown;
|
|
756
|
+
};
|
|
757
|
+
}[];
|
|
758
|
+
};
|
|
759
|
+
"multipart/form-data": {
|
|
760
|
+
events: {
|
|
761
|
+
name: string;
|
|
762
|
+
contactId?: string;
|
|
763
|
+
contactEmail?: string;
|
|
764
|
+
properties?: {
|
|
765
|
+
[key: string]: unknown;
|
|
766
|
+
};
|
|
767
|
+
}[];
|
|
768
|
+
};
|
|
769
|
+
"text/plain": {
|
|
770
|
+
events: {
|
|
771
|
+
name: string;
|
|
772
|
+
contactId?: string;
|
|
773
|
+
contactEmail?: string;
|
|
774
|
+
properties?: {
|
|
775
|
+
[key: string]: unknown;
|
|
776
|
+
};
|
|
777
|
+
}[];
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
};
|
|
781
|
+
responses: {
|
|
782
|
+
200: {
|
|
783
|
+
headers: {
|
|
784
|
+
[name: string]: unknown;
|
|
785
|
+
};
|
|
786
|
+
content?: never;
|
|
787
|
+
};
|
|
788
|
+
};
|
|
789
|
+
};
|
|
790
|
+
postV1WorkflowsByWorkflowIdTrigger: {
|
|
791
|
+
parameters: {
|
|
792
|
+
query?: never;
|
|
793
|
+
header?: never;
|
|
794
|
+
path: {
|
|
795
|
+
/** @description Workflow ID to trigger */
|
|
796
|
+
workflowId: string;
|
|
797
|
+
};
|
|
798
|
+
cookie?: never;
|
|
799
|
+
};
|
|
800
|
+
requestBody: {
|
|
801
|
+
content: {
|
|
802
|
+
"application/json": {
|
|
803
|
+
/** @description Contact ID */
|
|
804
|
+
contactId?: string;
|
|
805
|
+
/** @description Contact email (alternative to contactId) */
|
|
806
|
+
contactEmail?: string;
|
|
807
|
+
/** @description Data to pass to the workflow as trigger data */
|
|
808
|
+
data?: {
|
|
809
|
+
[key: string]: unknown;
|
|
810
|
+
};
|
|
811
|
+
};
|
|
812
|
+
"multipart/form-data": {
|
|
813
|
+
/** @description Contact ID */
|
|
814
|
+
contactId?: string;
|
|
815
|
+
/** @description Contact email (alternative to contactId) */
|
|
816
|
+
contactEmail?: string;
|
|
817
|
+
/** @description Data to pass to the workflow as trigger data */
|
|
818
|
+
data?: {
|
|
819
|
+
[key: string]: unknown;
|
|
820
|
+
};
|
|
821
|
+
};
|
|
822
|
+
"text/plain": {
|
|
823
|
+
/** @description Contact ID */
|
|
824
|
+
contactId?: string;
|
|
825
|
+
/** @description Contact email (alternative to contactId) */
|
|
826
|
+
contactEmail?: string;
|
|
827
|
+
/** @description Data to pass to the workflow as trigger data */
|
|
828
|
+
data?: {
|
|
829
|
+
[key: string]: unknown;
|
|
830
|
+
};
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
responses: {
|
|
835
|
+
200: {
|
|
836
|
+
headers: {
|
|
837
|
+
[name: string]: unknown;
|
|
838
|
+
};
|
|
839
|
+
content?: never;
|
|
840
|
+
};
|
|
841
|
+
};
|
|
842
|
+
};
|
|
843
|
+
postV1WorkflowsByWorkflowIdTriggerBatch: {
|
|
844
|
+
parameters: {
|
|
845
|
+
query?: never;
|
|
846
|
+
header?: never;
|
|
847
|
+
path: {
|
|
848
|
+
/** @description Workflow ID to trigger */
|
|
849
|
+
workflowId: string;
|
|
850
|
+
};
|
|
851
|
+
cookie?: never;
|
|
852
|
+
};
|
|
853
|
+
requestBody: {
|
|
854
|
+
content: {
|
|
855
|
+
"application/json": {
|
|
856
|
+
/** @description List of contacts to trigger the workflow for */
|
|
857
|
+
contacts: {
|
|
858
|
+
contactId?: string;
|
|
859
|
+
contactEmail?: string;
|
|
860
|
+
data?: {
|
|
861
|
+
[key: string]: unknown;
|
|
862
|
+
};
|
|
863
|
+
}[];
|
|
864
|
+
/** @description Common data to pass to all workflow triggers */
|
|
865
|
+
data?: {
|
|
866
|
+
[key: string]: unknown;
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
"multipart/form-data": {
|
|
870
|
+
/** @description List of contacts to trigger the workflow for */
|
|
871
|
+
contacts: {
|
|
872
|
+
contactId?: string;
|
|
873
|
+
contactEmail?: string;
|
|
874
|
+
data?: {
|
|
875
|
+
[key: string]: unknown;
|
|
876
|
+
};
|
|
877
|
+
}[];
|
|
878
|
+
/** @description Common data to pass to all workflow triggers */
|
|
879
|
+
data?: {
|
|
880
|
+
[key: string]: unknown;
|
|
881
|
+
};
|
|
882
|
+
};
|
|
883
|
+
"text/plain": {
|
|
884
|
+
/** @description List of contacts to trigger the workflow for */
|
|
885
|
+
contacts: {
|
|
886
|
+
contactId?: string;
|
|
887
|
+
contactEmail?: string;
|
|
888
|
+
data?: {
|
|
889
|
+
[key: string]: unknown;
|
|
890
|
+
};
|
|
891
|
+
}[];
|
|
892
|
+
/** @description Common data to pass to all workflow triggers */
|
|
893
|
+
data?: {
|
|
894
|
+
[key: string]: unknown;
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
};
|
|
899
|
+
responses: {
|
|
900
|
+
200: {
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content?: never;
|
|
905
|
+
};
|
|
906
|
+
};
|
|
907
|
+
};
|
|
571
908
|
postWebhooksSesByAwsAccountNumber: {
|
|
572
909
|
parameters: {
|
|
573
910
|
query?: never;
|