@medalsocial/sdk 1.1.6 → 1.2.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.
@@ -0,0 +1,3431 @@
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "Medal Social API",
5
+ "version": "1.1.7",
6
+ "description": "Public API contract for the Medal Social TypeScript SDK.",
7
+ "license": {
8
+ "name": "Apache-2.0",
9
+ "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
10
+ }
11
+ },
12
+ "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
13
+ "servers": [
14
+ {
15
+ "url": "https://io.medalsocial.com",
16
+ "description": "Medal Social production API"
17
+ }
18
+ ],
19
+ "security": [
20
+ {
21
+ "bearerAuth": []
22
+ }
23
+ ],
24
+ "tags": [
25
+ {
26
+ "name": "Posts",
27
+ "description": "Create, schedule, publish, and inspect posts."
28
+ },
29
+ {
30
+ "name": "Emails",
31
+ "description": "Send transactional email and inspect templates."
32
+ },
33
+ {
34
+ "name": "Contacts",
35
+ "description": "Manage workspace CRM contacts."
36
+ },
37
+ {
38
+ "name": "Deals",
39
+ "description": "Manage sponsorship and brand deals."
40
+ },
41
+ {
42
+ "name": "GDPR",
43
+ "description": "Manage exports, consent records, and cookie consent."
44
+ },
45
+ {
46
+ "name": "Workspaces",
47
+ "description": "Inspect workspaces accessible to the current credential."
48
+ }
49
+ ],
50
+ "paths": {
51
+ "/api/v1/posts": {
52
+ "get": {
53
+ "tags": [
54
+ "Posts"
55
+ ],
56
+ "operationId": "listPosts",
57
+ "summary": "List posts",
58
+ "parameters": [
59
+ {
60
+ "$ref": "#/components/parameters/Limit"
61
+ },
62
+ {
63
+ "$ref": "#/components/parameters/Cursor"
64
+ },
65
+ {
66
+ "name": "status",
67
+ "in": "query",
68
+ "schema": {
69
+ "type": "string"
70
+ }
71
+ },
72
+ {
73
+ "name": "type",
74
+ "in": "query",
75
+ "schema": {
76
+ "$ref": "#/components/schemas/PostType"
77
+ }
78
+ }
79
+ ],
80
+ "responses": {
81
+ "200": {
82
+ "description": "Posts page.",
83
+ "content": {
84
+ "application/json": {
85
+ "schema": {
86
+ "$ref": "#/components/schemas/PaginatedResponse_Post"
87
+ }
88
+ }
89
+ }
90
+ },
91
+ "default": {
92
+ "$ref": "#/components/responses/ApiError"
93
+ }
94
+ }
95
+ },
96
+ "post": {
97
+ "tags": [
98
+ "Posts"
99
+ ],
100
+ "operationId": "createPost",
101
+ "summary": "Create a post",
102
+ "requestBody": {
103
+ "required": true,
104
+ "content": {
105
+ "application/json": {
106
+ "schema": {
107
+ "$ref": "#/components/schemas/CreatePostInput"
108
+ }
109
+ }
110
+ }
111
+ },
112
+ "responses": {
113
+ "200": {
114
+ "description": "Created post reference.",
115
+ "content": {
116
+ "application/json": {
117
+ "schema": {
118
+ "$ref": "#/components/schemas/Envelope_PostCreateResult"
119
+ }
120
+ }
121
+ }
122
+ },
123
+ "default": {
124
+ "$ref": "#/components/responses/ApiError"
125
+ }
126
+ }
127
+ }
128
+ },
129
+ "/api/v1/posts/channels": {
130
+ "get": {
131
+ "tags": [
132
+ "Posts"
133
+ ],
134
+ "operationId": "listPostChannels",
135
+ "summary": "List connected post channels",
136
+ "responses": {
137
+ "200": {
138
+ "description": "Connected channels.",
139
+ "content": {
140
+ "application/json": {
141
+ "schema": {
142
+ "$ref": "#/components/schemas/Envelope_ChannelArray"
143
+ }
144
+ }
145
+ }
146
+ },
147
+ "default": {
148
+ "$ref": "#/components/responses/ApiError"
149
+ }
150
+ }
151
+ }
152
+ },
153
+ "/api/v1/posts/{id}": {
154
+ "parameters": [
155
+ {
156
+ "$ref": "#/components/parameters/Id"
157
+ }
158
+ ],
159
+ "get": {
160
+ "tags": [
161
+ "Posts"
162
+ ],
163
+ "operationId": "getPost",
164
+ "summary": "Get post detail",
165
+ "responses": {
166
+ "200": {
167
+ "description": "Post detail.",
168
+ "content": {
169
+ "application/json": {
170
+ "schema": {
171
+ "$ref": "#/components/schemas/Envelope_PostDetail"
172
+ }
173
+ }
174
+ }
175
+ },
176
+ "default": {
177
+ "$ref": "#/components/responses/ApiError"
178
+ }
179
+ }
180
+ },
181
+ "patch": {
182
+ "tags": [
183
+ "Posts"
184
+ ],
185
+ "operationId": "updatePost",
186
+ "summary": "Update a draft post",
187
+ "requestBody": {
188
+ "required": true,
189
+ "content": {
190
+ "application/json": {
191
+ "schema": {
192
+ "$ref": "#/components/schemas/UpdatePostInput"
193
+ }
194
+ }
195
+ }
196
+ },
197
+ "responses": {
198
+ "200": {
199
+ "description": "Update result.",
200
+ "content": {
201
+ "application/json": {
202
+ "schema": {
203
+ "$ref": "#/components/schemas/Envelope_Success"
204
+ }
205
+ }
206
+ }
207
+ },
208
+ "default": {
209
+ "$ref": "#/components/responses/ApiError"
210
+ }
211
+ }
212
+ },
213
+ "delete": {
214
+ "tags": [
215
+ "Posts"
216
+ ],
217
+ "operationId": "deletePost",
218
+ "summary": "Delete a post",
219
+ "responses": {
220
+ "200": {
221
+ "description": "Delete result.",
222
+ "content": {
223
+ "application/json": {
224
+ "schema": {
225
+ "$ref": "#/components/schemas/Envelope_Success"
226
+ }
227
+ }
228
+ }
229
+ },
230
+ "default": {
231
+ "$ref": "#/components/responses/ApiError"
232
+ }
233
+ }
234
+ }
235
+ },
236
+ "/api/v1/posts/{id}/schedule": {
237
+ "parameters": [
238
+ {
239
+ "$ref": "#/components/parameters/Id"
240
+ }
241
+ ],
242
+ "post": {
243
+ "tags": [
244
+ "Posts"
245
+ ],
246
+ "operationId": "schedulePost",
247
+ "summary": "Schedule a post",
248
+ "requestBody": {
249
+ "required": true,
250
+ "content": {
251
+ "application/json": {
252
+ "schema": {
253
+ "$ref": "#/components/schemas/SchedulePostInput"
254
+ }
255
+ }
256
+ }
257
+ },
258
+ "responses": {
259
+ "200": {
260
+ "description": "Schedule result.",
261
+ "content": {
262
+ "application/json": {
263
+ "schema": {
264
+ "$ref": "#/components/schemas/Envelope_ScheduleResult"
265
+ }
266
+ }
267
+ }
268
+ },
269
+ "default": {
270
+ "$ref": "#/components/responses/ApiError"
271
+ }
272
+ }
273
+ }
274
+ },
275
+ "/api/v1/posts/{id}/publish": {
276
+ "parameters": [
277
+ {
278
+ "$ref": "#/components/parameters/Id"
279
+ }
280
+ ],
281
+ "post": {
282
+ "tags": [
283
+ "Posts"
284
+ ],
285
+ "operationId": "publishPost",
286
+ "summary": "Publish a post",
287
+ "responses": {
288
+ "200": {
289
+ "description": "Publish result.",
290
+ "content": {
291
+ "application/json": {
292
+ "schema": {
293
+ "$ref": "#/components/schemas/Envelope_PublishResult"
294
+ }
295
+ }
296
+ }
297
+ },
298
+ "default": {
299
+ "$ref": "#/components/responses/ApiError"
300
+ }
301
+ }
302
+ }
303
+ },
304
+ "/api/v1/emails": {
305
+ "post": {
306
+ "tags": [
307
+ "Emails"
308
+ ],
309
+ "operationId": "sendEmail",
310
+ "summary": "Send a transactional email",
311
+ "requestBody": {
312
+ "required": true,
313
+ "content": {
314
+ "application/json": {
315
+ "schema": {
316
+ "$ref": "#/components/schemas/SendEmailInput"
317
+ }
318
+ }
319
+ }
320
+ },
321
+ "responses": {
322
+ "202": {
323
+ "description": "Email queued.",
324
+ "content": {
325
+ "application/json": {
326
+ "schema": {
327
+ "$ref": "#/components/schemas/Envelope_EmailSendResult"
328
+ }
329
+ }
330
+ }
331
+ },
332
+ "default": {
333
+ "$ref": "#/components/responses/ApiError"
334
+ }
335
+ }
336
+ }
337
+ },
338
+ "/api/v1/emails/batch": {
339
+ "post": {
340
+ "tags": [
341
+ "Emails"
342
+ ],
343
+ "operationId": "batchSendEmails",
344
+ "summary": "Send a batch of transactional emails",
345
+ "requestBody": {
346
+ "required": true,
347
+ "content": {
348
+ "application/json": {
349
+ "schema": {
350
+ "$ref": "#/components/schemas/BatchSendInput"
351
+ }
352
+ }
353
+ }
354
+ },
355
+ "responses": {
356
+ "202": {
357
+ "description": "Batch queued.",
358
+ "content": {
359
+ "application/json": {
360
+ "schema": {
361
+ "$ref": "#/components/schemas/Envelope_BatchSendSummary"
362
+ }
363
+ }
364
+ }
365
+ },
366
+ "default": {
367
+ "$ref": "#/components/responses/ApiError"
368
+ }
369
+ }
370
+ }
371
+ },
372
+ "/api/v1/emails/templates": {
373
+ "get": {
374
+ "tags": [
375
+ "Emails"
376
+ ],
377
+ "operationId": "listEmailTemplates",
378
+ "summary": "List active email templates",
379
+ "responses": {
380
+ "200": {
381
+ "description": "Active templates.",
382
+ "content": {
383
+ "application/json": {
384
+ "schema": {
385
+ "$ref": "#/components/schemas/Envelope_EmailTemplateArray"
386
+ }
387
+ }
388
+ }
389
+ },
390
+ "default": {
391
+ "$ref": "#/components/responses/ApiError"
392
+ }
393
+ }
394
+ }
395
+ },
396
+ "/api/v1/emails/templates/{slug}": {
397
+ "parameters": [
398
+ {
399
+ "$ref": "#/components/parameters/Slug"
400
+ }
401
+ ],
402
+ "get": {
403
+ "tags": [
404
+ "Emails"
405
+ ],
406
+ "operationId": "getEmailTemplate",
407
+ "summary": "Get an email template",
408
+ "parameters": [
409
+ {
410
+ "name": "locale",
411
+ "in": "query",
412
+ "schema": {
413
+ "type": "string"
414
+ }
415
+ },
416
+ {
417
+ "name": "fallback_locale",
418
+ "in": "query",
419
+ "schema": {
420
+ "type": "string"
421
+ }
422
+ }
423
+ ],
424
+ "responses": {
425
+ "200": {
426
+ "description": "Email template detail.",
427
+ "content": {
428
+ "application/json": {
429
+ "schema": {
430
+ "$ref": "#/components/schemas/Envelope_EmailTemplateDetail"
431
+ }
432
+ }
433
+ }
434
+ },
435
+ "default": {
436
+ "$ref": "#/components/responses/ApiError"
437
+ }
438
+ }
439
+ }
440
+ },
441
+ "/api/v1/emails/{id}": {
442
+ "parameters": [
443
+ {
444
+ "$ref": "#/components/parameters/Id"
445
+ }
446
+ ],
447
+ "get": {
448
+ "tags": [
449
+ "Emails"
450
+ ],
451
+ "operationId": "getEmailSend",
452
+ "summary": "Get sent email status",
453
+ "responses": {
454
+ "200": {
455
+ "description": "Sent email status.",
456
+ "content": {
457
+ "application/json": {
458
+ "schema": {
459
+ "$ref": "#/components/schemas/Envelope_EmailSend"
460
+ }
461
+ }
462
+ }
463
+ },
464
+ "default": {
465
+ "$ref": "#/components/responses/ApiError"
466
+ }
467
+ }
468
+ }
469
+ },
470
+ "/api/v1/contacts": {
471
+ "get": {
472
+ "tags": [
473
+ "Contacts"
474
+ ],
475
+ "operationId": "listContacts",
476
+ "summary": "List contacts",
477
+ "parameters": [
478
+ {
479
+ "$ref": "#/components/parameters/Limit"
480
+ },
481
+ {
482
+ "$ref": "#/components/parameters/Cursor"
483
+ },
484
+ {
485
+ "name": "status",
486
+ "in": "query",
487
+ "schema": {
488
+ "$ref": "#/components/schemas/ContactStatus"
489
+ }
490
+ },
491
+ {
492
+ "name": "email_status",
493
+ "in": "query",
494
+ "schema": {
495
+ "$ref": "#/components/schemas/EmailStatus"
496
+ }
497
+ },
498
+ {
499
+ "name": "label_ids",
500
+ "in": "query",
501
+ "schema": {
502
+ "type": "string"
503
+ },
504
+ "description": "Comma-separated label IDs."
505
+ },
506
+ {
507
+ "name": "search",
508
+ "in": "query",
509
+ "schema": {
510
+ "type": "string"
511
+ }
512
+ }
513
+ ],
514
+ "responses": {
515
+ "200": {
516
+ "description": "Contacts page.",
517
+ "content": {
518
+ "application/json": {
519
+ "schema": {
520
+ "$ref": "#/components/schemas/PaginatedResponse_Contact"
521
+ }
522
+ }
523
+ }
524
+ },
525
+ "default": {
526
+ "$ref": "#/components/responses/ApiError"
527
+ }
528
+ }
529
+ },
530
+ "post": {
531
+ "tags": [
532
+ "Contacts"
533
+ ],
534
+ "operationId": "createContact",
535
+ "summary": "Create a contact",
536
+ "requestBody": {
537
+ "required": true,
538
+ "content": {
539
+ "application/json": {
540
+ "schema": {
541
+ "$ref": "#/components/schemas/CreateContactInput"
542
+ }
543
+ }
544
+ }
545
+ },
546
+ "responses": {
547
+ "200": {
548
+ "description": "Created contact reference.",
549
+ "content": {
550
+ "application/json": {
551
+ "schema": {
552
+ "$ref": "#/components/schemas/Envelope_ContactCreateResult"
553
+ }
554
+ }
555
+ }
556
+ },
557
+ "default": {
558
+ "$ref": "#/components/responses/ApiError"
559
+ }
560
+ }
561
+ }
562
+ },
563
+ "/api/v1/contacts/import": {
564
+ "post": {
565
+ "tags": [
566
+ "Contacts"
567
+ ],
568
+ "operationId": "importContacts",
569
+ "summary": "Import contacts",
570
+ "requestBody": {
571
+ "required": true,
572
+ "content": {
573
+ "application/json": {
574
+ "schema": {
575
+ "type": "object",
576
+ "required": [
577
+ "contacts"
578
+ ],
579
+ "properties": {
580
+ "contacts": {
581
+ "type": "array",
582
+ "maxItems": 500,
583
+ "items": {
584
+ "$ref": "#/components/schemas/ImportContactInput"
585
+ }
586
+ }
587
+ }
588
+ }
589
+ }
590
+ }
591
+ },
592
+ "responses": {
593
+ "200": {
594
+ "description": "Import summary.",
595
+ "content": {
596
+ "application/json": {
597
+ "schema": {
598
+ "$ref": "#/components/schemas/Envelope_ImportContactsResult"
599
+ }
600
+ }
601
+ }
602
+ },
603
+ "default": {
604
+ "$ref": "#/components/responses/ApiError"
605
+ }
606
+ }
607
+ }
608
+ },
609
+ "/api/v1/contacts/{id}": {
610
+ "parameters": [
611
+ {
612
+ "$ref": "#/components/parameters/Id"
613
+ }
614
+ ],
615
+ "get": {
616
+ "tags": [
617
+ "Contacts"
618
+ ],
619
+ "operationId": "getContact",
620
+ "summary": "Get a contact",
621
+ "responses": {
622
+ "200": {
623
+ "description": "Contact.",
624
+ "content": {
625
+ "application/json": {
626
+ "schema": {
627
+ "$ref": "#/components/schemas/Envelope_Contact"
628
+ }
629
+ }
630
+ }
631
+ },
632
+ "default": {
633
+ "$ref": "#/components/responses/ApiError"
634
+ }
635
+ }
636
+ },
637
+ "patch": {
638
+ "tags": [
639
+ "Contacts"
640
+ ],
641
+ "operationId": "updateContact",
642
+ "summary": "Update a contact",
643
+ "requestBody": {
644
+ "required": true,
645
+ "content": {
646
+ "application/json": {
647
+ "schema": {
648
+ "$ref": "#/components/schemas/UpdateContactInput"
649
+ }
650
+ }
651
+ }
652
+ },
653
+ "responses": {
654
+ "200": {
655
+ "description": "Update result.",
656
+ "content": {
657
+ "application/json": {
658
+ "schema": {
659
+ "$ref": "#/components/schemas/Envelope_ContactUpdateResult"
660
+ }
661
+ }
662
+ }
663
+ },
664
+ "default": {
665
+ "$ref": "#/components/responses/ApiError"
666
+ }
667
+ }
668
+ },
669
+ "delete": {
670
+ "tags": [
671
+ "Contacts"
672
+ ],
673
+ "operationId": "deleteContact",
674
+ "summary": "Delete a contact",
675
+ "responses": {
676
+ "200": {
677
+ "description": "Delete result.",
678
+ "content": {
679
+ "application/json": {
680
+ "schema": {
681
+ "$ref": "#/components/schemas/Envelope_ContactRemoveResult"
682
+ }
683
+ }
684
+ }
685
+ },
686
+ "default": {
687
+ "$ref": "#/components/responses/ApiError"
688
+ }
689
+ }
690
+ }
691
+ },
692
+ "/api/v1/contacts/{id}/activities": {
693
+ "parameters": [
694
+ {
695
+ "$ref": "#/components/parameters/Id"
696
+ }
697
+ ],
698
+ "get": {
699
+ "tags": [
700
+ "Contacts"
701
+ ],
702
+ "operationId": "listContactActivities",
703
+ "summary": "List contact activities",
704
+ "parameters": [
705
+ {
706
+ "$ref": "#/components/parameters/Limit"
707
+ },
708
+ {
709
+ "$ref": "#/components/parameters/Cursor"
710
+ }
711
+ ],
712
+ "responses": {
713
+ "200": {
714
+ "description": "Contact activities page.",
715
+ "content": {
716
+ "application/json": {
717
+ "schema": {
718
+ "$ref": "#/components/schemas/PaginatedResponse_Activity"
719
+ }
720
+ }
721
+ }
722
+ },
723
+ "default": {
724
+ "$ref": "#/components/responses/ApiError"
725
+ }
726
+ }
727
+ }
728
+ },
729
+ "/api/v1/contacts/{id}/notes": {
730
+ "parameters": [
731
+ {
732
+ "$ref": "#/components/parameters/Id"
733
+ }
734
+ ],
735
+ "post": {
736
+ "tags": [
737
+ "Contacts"
738
+ ],
739
+ "operationId": "addContactNote",
740
+ "summary": "Add a contact note",
741
+ "requestBody": {
742
+ "required": true,
743
+ "content": {
744
+ "application/json": {
745
+ "schema": {
746
+ "$ref": "#/components/schemas/AddNoteInput"
747
+ }
748
+ }
749
+ }
750
+ },
751
+ "responses": {
752
+ "200": {
753
+ "description": "Created note reference.",
754
+ "content": {
755
+ "application/json": {
756
+ "schema": {
757
+ "$ref": "#/components/schemas/Envelope_ContactNoteResult"
758
+ }
759
+ }
760
+ }
761
+ },
762
+ "default": {
763
+ "$ref": "#/components/responses/ApiError"
764
+ }
765
+ }
766
+ }
767
+ },
768
+ "/api/v1/deals": {
769
+ "get": {
770
+ "tags": [
771
+ "Deals"
772
+ ],
773
+ "operationId": "listDeals",
774
+ "summary": "List deals",
775
+ "parameters": [
776
+ {
777
+ "$ref": "#/components/parameters/Limit"
778
+ },
779
+ {
780
+ "$ref": "#/components/parameters/Cursor"
781
+ },
782
+ {
783
+ "name": "status",
784
+ "in": "query",
785
+ "schema": {
786
+ "$ref": "#/components/schemas/DealStatus"
787
+ }
788
+ },
789
+ {
790
+ "name": "search",
791
+ "in": "query",
792
+ "schema": {
793
+ "type": "string"
794
+ }
795
+ }
796
+ ],
797
+ "responses": {
798
+ "200": {
799
+ "description": "Deals page.",
800
+ "content": {
801
+ "application/json": {
802
+ "schema": {
803
+ "$ref": "#/components/schemas/PaginatedResponse_Deal"
804
+ }
805
+ }
806
+ }
807
+ },
808
+ "default": {
809
+ "$ref": "#/components/responses/ApiError"
810
+ }
811
+ }
812
+ },
813
+ "post": {
814
+ "tags": [
815
+ "Deals"
816
+ ],
817
+ "operationId": "createDeal",
818
+ "summary": "Create a deal",
819
+ "requestBody": {
820
+ "required": true,
821
+ "content": {
822
+ "application/json": {
823
+ "schema": {
824
+ "$ref": "#/components/schemas/CreateDealInput"
825
+ }
826
+ }
827
+ }
828
+ },
829
+ "responses": {
830
+ "200": {
831
+ "description": "Created deal reference.",
832
+ "content": {
833
+ "application/json": {
834
+ "schema": {
835
+ "$ref": "#/components/schemas/Envelope_DealCreateResult"
836
+ }
837
+ }
838
+ }
839
+ },
840
+ "default": {
841
+ "$ref": "#/components/responses/ApiError"
842
+ }
843
+ }
844
+ }
845
+ },
846
+ "/api/v1/deals/{id}": {
847
+ "parameters": [
848
+ {
849
+ "$ref": "#/components/parameters/Id"
850
+ }
851
+ ],
852
+ "get": {
853
+ "tags": [
854
+ "Deals"
855
+ ],
856
+ "operationId": "getDeal",
857
+ "summary": "Get a deal",
858
+ "responses": {
859
+ "200": {
860
+ "description": "Deal.",
861
+ "content": {
862
+ "application/json": {
863
+ "schema": {
864
+ "$ref": "#/components/schemas/Envelope_Deal"
865
+ }
866
+ }
867
+ }
868
+ },
869
+ "default": {
870
+ "$ref": "#/components/responses/ApiError"
871
+ }
872
+ }
873
+ },
874
+ "patch": {
875
+ "tags": [
876
+ "Deals"
877
+ ],
878
+ "operationId": "updateDeal",
879
+ "summary": "Update a deal",
880
+ "requestBody": {
881
+ "required": true,
882
+ "content": {
883
+ "application/json": {
884
+ "schema": {
885
+ "$ref": "#/components/schemas/UpdateDealInput"
886
+ }
887
+ }
888
+ }
889
+ },
890
+ "responses": {
891
+ "200": {
892
+ "description": "Update result.",
893
+ "content": {
894
+ "application/json": {
895
+ "schema": {
896
+ "$ref": "#/components/schemas/Envelope_DealUpdateResult"
897
+ }
898
+ }
899
+ }
900
+ },
901
+ "default": {
902
+ "$ref": "#/components/responses/ApiError"
903
+ }
904
+ }
905
+ },
906
+ "delete": {
907
+ "tags": [
908
+ "Deals"
909
+ ],
910
+ "operationId": "deleteDeal",
911
+ "summary": "Delete a deal",
912
+ "responses": {
913
+ "200": {
914
+ "description": "Delete result.",
915
+ "content": {
916
+ "application/json": {
917
+ "schema": {
918
+ "$ref": "#/components/schemas/Envelope_DealRemoveResult"
919
+ }
920
+ }
921
+ }
922
+ },
923
+ "default": {
924
+ "$ref": "#/components/responses/ApiError"
925
+ }
926
+ }
927
+ }
928
+ },
929
+ "/api/v1/gdpr/export": {
930
+ "post": {
931
+ "tags": [
932
+ "GDPR"
933
+ ],
934
+ "operationId": "requestGdprExport",
935
+ "summary": "Request a GDPR export",
936
+ "responses": {
937
+ "200": {
938
+ "description": "Export request reference.",
939
+ "content": {
940
+ "application/json": {
941
+ "schema": {
942
+ "$ref": "#/components/schemas/Envelope_GdprExportRequest"
943
+ }
944
+ }
945
+ }
946
+ },
947
+ "default": {
948
+ "$ref": "#/components/responses/ApiError"
949
+ }
950
+ }
951
+ }
952
+ },
953
+ "/api/v1/gdpr/exports": {
954
+ "get": {
955
+ "tags": [
956
+ "GDPR"
957
+ ],
958
+ "operationId": "listGdprExports",
959
+ "summary": "List GDPR exports",
960
+ "responses": {
961
+ "200": {
962
+ "description": "Export requests.",
963
+ "content": {
964
+ "application/json": {
965
+ "schema": {
966
+ "$ref": "#/components/schemas/Envelope_GdprExportArray"
967
+ }
968
+ }
969
+ }
970
+ },
971
+ "default": {
972
+ "$ref": "#/components/responses/ApiError"
973
+ }
974
+ }
975
+ }
976
+ },
977
+ "/api/v1/gdpr/exports/{id}": {
978
+ "parameters": [
979
+ {
980
+ "$ref": "#/components/parameters/Id"
981
+ }
982
+ ],
983
+ "get": {
984
+ "tags": [
985
+ "GDPR"
986
+ ],
987
+ "operationId": "getGdprExport",
988
+ "summary": "Get a GDPR export",
989
+ "responses": {
990
+ "200": {
991
+ "description": "Export request.",
992
+ "content": {
993
+ "application/json": {
994
+ "schema": {
995
+ "$ref": "#/components/schemas/Envelope_GdprExport"
996
+ }
997
+ }
998
+ }
999
+ },
1000
+ "default": {
1001
+ "$ref": "#/components/responses/ApiError"
1002
+ }
1003
+ }
1004
+ }
1005
+ },
1006
+ "/api/v1/gdpr/consent": {
1007
+ "post": {
1008
+ "tags": [
1009
+ "GDPR"
1010
+ ],
1011
+ "operationId": "recordGdprConsent",
1012
+ "summary": "Record GDPR consent",
1013
+ "requestBody": {
1014
+ "required": true,
1015
+ "content": {
1016
+ "application/json": {
1017
+ "schema": {
1018
+ "$ref": "#/components/schemas/RecordConsentInput"
1019
+ }
1020
+ }
1021
+ }
1022
+ },
1023
+ "responses": {
1024
+ "200": {
1025
+ "description": "Consent reference.",
1026
+ "content": {
1027
+ "application/json": {
1028
+ "schema": {
1029
+ "$ref": "#/components/schemas/Envelope_ConsentResult"
1030
+ }
1031
+ }
1032
+ }
1033
+ },
1034
+ "default": {
1035
+ "$ref": "#/components/responses/ApiError"
1036
+ }
1037
+ }
1038
+ }
1039
+ },
1040
+ "/api/v1/gdpr/consent/{email}": {
1041
+ "parameters": [
1042
+ {
1043
+ "name": "email",
1044
+ "in": "path",
1045
+ "required": true,
1046
+ "schema": {
1047
+ "type": "string",
1048
+ "format": "email"
1049
+ }
1050
+ }
1051
+ ],
1052
+ "get": {
1053
+ "tags": [
1054
+ "GDPR"
1055
+ ],
1056
+ "operationId": "getGdprConsent",
1057
+ "summary": "Get GDPR consent records",
1058
+ "responses": {
1059
+ "200": {
1060
+ "description": "Consent records.",
1061
+ "content": {
1062
+ "application/json": {
1063
+ "schema": {
1064
+ "$ref": "#/components/schemas/Envelope_ConsentRecordArray"
1065
+ }
1066
+ }
1067
+ }
1068
+ },
1069
+ "default": {
1070
+ "$ref": "#/components/responses/ApiError"
1071
+ }
1072
+ }
1073
+ }
1074
+ },
1075
+ "/api/cookie-consent": {
1076
+ "post": {
1077
+ "tags": [
1078
+ "GDPR"
1079
+ ],
1080
+ "operationId": "recordCookieConsent",
1081
+ "summary": "Record cookie consent",
1082
+ "requestBody": {
1083
+ "required": true,
1084
+ "content": {
1085
+ "application/json": {
1086
+ "schema": {
1087
+ "$ref": "#/components/schemas/CookieConsentInput"
1088
+ }
1089
+ }
1090
+ }
1091
+ },
1092
+ "responses": {
1093
+ "200": {
1094
+ "description": "Cookie consent result.",
1095
+ "content": {
1096
+ "application/json": {
1097
+ "schema": {
1098
+ "$ref": "#/components/schemas/CookieConsentResult"
1099
+ }
1100
+ }
1101
+ }
1102
+ },
1103
+ "default": {
1104
+ "$ref": "#/components/responses/ApiError"
1105
+ }
1106
+ }
1107
+ }
1108
+ },
1109
+ "/api/v1/me/workspaces": {
1110
+ "get": {
1111
+ "tags": [
1112
+ "Workspaces"
1113
+ ],
1114
+ "operationId": "listWorkspaces",
1115
+ "summary": "List accessible workspaces",
1116
+ "responses": {
1117
+ "200": {
1118
+ "description": "Workspaces.",
1119
+ "content": {
1120
+ "application/json": {
1121
+ "schema": {
1122
+ "$ref": "#/components/schemas/Envelope_WorkspaceArray"
1123
+ }
1124
+ }
1125
+ }
1126
+ },
1127
+ "default": {
1128
+ "$ref": "#/components/responses/ApiError"
1129
+ }
1130
+ }
1131
+ }
1132
+ }
1133
+ },
1134
+ "components": {
1135
+ "securitySchemes": {
1136
+ "bearerAuth": {
1137
+ "type": "http",
1138
+ "scheme": "bearer"
1139
+ }
1140
+ },
1141
+ "parameters": {
1142
+ "Id": {
1143
+ "name": "id",
1144
+ "in": "path",
1145
+ "required": true,
1146
+ "schema": {
1147
+ "type": "string"
1148
+ }
1149
+ },
1150
+ "Slug": {
1151
+ "name": "slug",
1152
+ "in": "path",
1153
+ "required": true,
1154
+ "schema": {
1155
+ "type": "string"
1156
+ }
1157
+ },
1158
+ "Cursor": {
1159
+ "name": "cursor",
1160
+ "in": "query",
1161
+ "schema": {
1162
+ "type": "string"
1163
+ }
1164
+ },
1165
+ "Limit": {
1166
+ "name": "limit",
1167
+ "in": "query",
1168
+ "schema": {
1169
+ "type": "integer",
1170
+ "minimum": 1,
1171
+ "maximum": 500
1172
+ }
1173
+ }
1174
+ },
1175
+ "responses": {
1176
+ "ApiError": {
1177
+ "description": "API error.",
1178
+ "content": {
1179
+ "application/json": {
1180
+ "schema": {
1181
+ "$ref": "#/components/schemas/ApiError"
1182
+ }
1183
+ }
1184
+ }
1185
+ }
1186
+ },
1187
+ "schemas": {
1188
+ "ApiError": {
1189
+ "type": "object",
1190
+ "required": [
1191
+ "error"
1192
+ ],
1193
+ "properties": {
1194
+ "error": {
1195
+ "type": "object",
1196
+ "required": [
1197
+ "code",
1198
+ "message"
1199
+ ],
1200
+ "properties": {
1201
+ "code": {
1202
+ "type": "string"
1203
+ },
1204
+ "message": {
1205
+ "type": "string"
1206
+ },
1207
+ "details": true
1208
+ }
1209
+ }
1210
+ }
1211
+ },
1212
+ "Pagination": {
1213
+ "type": "object",
1214
+ "required": [
1215
+ "has_more",
1216
+ "next_cursor"
1217
+ ],
1218
+ "properties": {
1219
+ "has_more": {
1220
+ "type": "boolean"
1221
+ },
1222
+ "next_cursor": {
1223
+ "type": [
1224
+ "string",
1225
+ "null"
1226
+ ]
1227
+ }
1228
+ }
1229
+ },
1230
+ "Success": {
1231
+ "type": "object",
1232
+ "required": [
1233
+ "success"
1234
+ ],
1235
+ "properties": {
1236
+ "success": {
1237
+ "type": "boolean"
1238
+ }
1239
+ }
1240
+ },
1241
+ "PostCreateResult": {
1242
+ "type": "object",
1243
+ "required": [
1244
+ "id"
1245
+ ],
1246
+ "properties": {
1247
+ "id": {
1248
+ "type": "string"
1249
+ }
1250
+ }
1251
+ },
1252
+ "Post": {
1253
+ "type": "object",
1254
+ "required": [
1255
+ "id",
1256
+ "type",
1257
+ "title",
1258
+ "content",
1259
+ "status",
1260
+ "channel_ids",
1261
+ "variant_count",
1262
+ "published_count",
1263
+ "failed_count",
1264
+ "scheduled_at",
1265
+ "published_at",
1266
+ "created_at",
1267
+ "updated_at"
1268
+ ],
1269
+ "properties": {
1270
+ "id": {
1271
+ "type": "string"
1272
+ },
1273
+ "type": {
1274
+ "$ref": "#/components/schemas/PostType"
1275
+ },
1276
+ "title": {
1277
+ "type": [
1278
+ "string",
1279
+ "null"
1280
+ ]
1281
+ },
1282
+ "content": {
1283
+ "type": "string"
1284
+ },
1285
+ "status": {
1286
+ "type": "string"
1287
+ },
1288
+ "channel_ids": {
1289
+ "type": "array",
1290
+ "items": {
1291
+ "type": "string"
1292
+ }
1293
+ },
1294
+ "variant_count": {
1295
+ "type": "integer"
1296
+ },
1297
+ "published_count": {
1298
+ "type": "integer"
1299
+ },
1300
+ "failed_count": {
1301
+ "type": "integer"
1302
+ },
1303
+ "scheduled_at": {
1304
+ "type": [
1305
+ "string",
1306
+ "null"
1307
+ ],
1308
+ "format": "date-time"
1309
+ },
1310
+ "published_at": {
1311
+ "type": [
1312
+ "string",
1313
+ "null"
1314
+ ],
1315
+ "format": "date-time"
1316
+ },
1317
+ "created_at": {
1318
+ "type": [
1319
+ "string",
1320
+ "null"
1321
+ ],
1322
+ "format": "date-time"
1323
+ },
1324
+ "updated_at": {
1325
+ "type": [
1326
+ "string",
1327
+ "null"
1328
+ ],
1329
+ "format": "date-time"
1330
+ }
1331
+ }
1332
+ },
1333
+ "PostType": {
1334
+ "type": "string",
1335
+ "enum": [
1336
+ "social",
1337
+ "newsletter",
1338
+ "blog"
1339
+ ]
1340
+ },
1341
+ "PostVariant": {
1342
+ "type": "object",
1343
+ "required": [
1344
+ "id",
1345
+ "channel_id",
1346
+ "content",
1347
+ "status",
1348
+ "platform",
1349
+ "channel_display_name",
1350
+ "scheduled_at",
1351
+ "published_at",
1352
+ "platform_post_id",
1353
+ "permalink",
1354
+ "error"
1355
+ ],
1356
+ "properties": {
1357
+ "id": {
1358
+ "type": "string"
1359
+ },
1360
+ "channel_id": {
1361
+ "type": "string"
1362
+ },
1363
+ "content": {
1364
+ "type": "string"
1365
+ },
1366
+ "status": {
1367
+ "type": "string"
1368
+ },
1369
+ "platform": {
1370
+ "type": [
1371
+ "string",
1372
+ "null"
1373
+ ]
1374
+ },
1375
+ "channel_display_name": {
1376
+ "type": [
1377
+ "string",
1378
+ "null"
1379
+ ]
1380
+ },
1381
+ "scheduled_at": {
1382
+ "type": [
1383
+ "string",
1384
+ "null"
1385
+ ],
1386
+ "format": "date-time"
1387
+ },
1388
+ "published_at": {
1389
+ "type": [
1390
+ "string",
1391
+ "null"
1392
+ ],
1393
+ "format": "date-time"
1394
+ },
1395
+ "platform_post_id": {
1396
+ "type": [
1397
+ "string",
1398
+ "null"
1399
+ ]
1400
+ },
1401
+ "permalink": {
1402
+ "type": [
1403
+ "string",
1404
+ "null"
1405
+ ],
1406
+ "format": "uri"
1407
+ },
1408
+ "error": {
1409
+ "type": [
1410
+ "string",
1411
+ "null"
1412
+ ]
1413
+ }
1414
+ }
1415
+ },
1416
+ "PostDetail": {
1417
+ "allOf": [
1418
+ {
1419
+ "$ref": "#/components/schemas/Post"
1420
+ },
1421
+ {
1422
+ "type": "object",
1423
+ "required": [
1424
+ "variants"
1425
+ ],
1426
+ "properties": {
1427
+ "variants": {
1428
+ "type": "array",
1429
+ "items": {
1430
+ "$ref": "#/components/schemas/PostVariant"
1431
+ }
1432
+ }
1433
+ }
1434
+ }
1435
+ ]
1436
+ },
1437
+ "Channel": {
1438
+ "type": "object",
1439
+ "required": [
1440
+ "id",
1441
+ "platform",
1442
+ "display_name",
1443
+ "platform_username",
1444
+ "state",
1445
+ "connected_at"
1446
+ ],
1447
+ "properties": {
1448
+ "id": {
1449
+ "type": "string"
1450
+ },
1451
+ "platform": {
1452
+ "type": [
1453
+ "string",
1454
+ "null"
1455
+ ]
1456
+ },
1457
+ "display_name": {
1458
+ "type": [
1459
+ "string",
1460
+ "null"
1461
+ ]
1462
+ },
1463
+ "platform_username": {
1464
+ "type": [
1465
+ "string",
1466
+ "null"
1467
+ ]
1468
+ },
1469
+ "state": {
1470
+ "type": "string"
1471
+ },
1472
+ "connected_at": {
1473
+ "type": [
1474
+ "string",
1475
+ "null"
1476
+ ],
1477
+ "format": "date-time"
1478
+ }
1479
+ }
1480
+ },
1481
+ "CreatePostInput": {
1482
+ "type": "object",
1483
+ "required": [
1484
+ "content",
1485
+ "channel_ids"
1486
+ ],
1487
+ "properties": {
1488
+ "type": {
1489
+ "$ref": "#/components/schemas/PostType"
1490
+ },
1491
+ "title": {
1492
+ "type": "string"
1493
+ },
1494
+ "content": {
1495
+ "type": "string"
1496
+ },
1497
+ "channel_ids": {
1498
+ "type": "array",
1499
+ "items": {
1500
+ "type": "string"
1501
+ }
1502
+ }
1503
+ }
1504
+ },
1505
+ "UpdatePostInput": {
1506
+ "type": "object",
1507
+ "properties": {
1508
+ "title": {
1509
+ "type": "string"
1510
+ },
1511
+ "content": {
1512
+ "type": "string"
1513
+ }
1514
+ }
1515
+ },
1516
+ "SchedulePostInput": {
1517
+ "type": "object",
1518
+ "required": [
1519
+ "scheduled_at"
1520
+ ],
1521
+ "properties": {
1522
+ "scheduled_at": {
1523
+ "oneOf": [
1524
+ {
1525
+ "type": "integer"
1526
+ },
1527
+ {
1528
+ "type": "string",
1529
+ "format": "date-time"
1530
+ }
1531
+ ]
1532
+ }
1533
+ }
1534
+ },
1535
+ "ScheduleResult": {
1536
+ "type": "object",
1537
+ "required": [
1538
+ "success",
1539
+ "workflow_id"
1540
+ ],
1541
+ "properties": {
1542
+ "success": {
1543
+ "type": "boolean"
1544
+ },
1545
+ "workflow_id": {
1546
+ "type": "string"
1547
+ }
1548
+ }
1549
+ },
1550
+ "PublishResult": {
1551
+ "type": "object",
1552
+ "required": [
1553
+ "success",
1554
+ "workflow_id"
1555
+ ],
1556
+ "properties": {
1557
+ "success": {
1558
+ "type": "boolean"
1559
+ },
1560
+ "workflow_id": {
1561
+ "type": "string"
1562
+ }
1563
+ }
1564
+ },
1565
+ "SendEmailInput": {
1566
+ "type": "object",
1567
+ "required": [
1568
+ "template_slug",
1569
+ "to"
1570
+ ],
1571
+ "properties": {
1572
+ "template_slug": {
1573
+ "type": "string"
1574
+ },
1575
+ "to": {
1576
+ "type": "string",
1577
+ "format": "email"
1578
+ },
1579
+ "name": {
1580
+ "type": "string"
1581
+ },
1582
+ "locale": {
1583
+ "type": "string"
1584
+ },
1585
+ "fallback_locale": {
1586
+ "type": "string"
1587
+ },
1588
+ "variables": {
1589
+ "type": "object",
1590
+ "additionalProperties": {
1591
+ "type": "string"
1592
+ }
1593
+ },
1594
+ "contact_id": {
1595
+ "type": "string"
1596
+ }
1597
+ }
1598
+ },
1599
+ "EmailSendResult": {
1600
+ "type": "object",
1601
+ "required": [
1602
+ "id",
1603
+ "status"
1604
+ ],
1605
+ "properties": {
1606
+ "id": {
1607
+ "type": "string"
1608
+ },
1609
+ "status": {
1610
+ "type": "string"
1611
+ }
1612
+ }
1613
+ },
1614
+ "EmailSend": {
1615
+ "type": "object",
1616
+ "required": [
1617
+ "id",
1618
+ "status",
1619
+ "recipient_email",
1620
+ "recipient_name",
1621
+ "subject",
1622
+ "template_id",
1623
+ "contact_id",
1624
+ "queued_at",
1625
+ "sent_at",
1626
+ "delivered_at",
1627
+ "opened_at",
1628
+ "clicked_at",
1629
+ "error_message"
1630
+ ],
1631
+ "properties": {
1632
+ "id": {
1633
+ "type": "string"
1634
+ },
1635
+ "status": {
1636
+ "type": "string"
1637
+ },
1638
+ "recipient_email": {
1639
+ "type": "string",
1640
+ "format": "email"
1641
+ },
1642
+ "recipient_name": {
1643
+ "type": [
1644
+ "string",
1645
+ "null"
1646
+ ]
1647
+ },
1648
+ "subject": {
1649
+ "type": [
1650
+ "string",
1651
+ "null"
1652
+ ]
1653
+ },
1654
+ "template_id": {
1655
+ "type": [
1656
+ "string",
1657
+ "null"
1658
+ ]
1659
+ },
1660
+ "contact_id": {
1661
+ "type": [
1662
+ "string",
1663
+ "null"
1664
+ ]
1665
+ },
1666
+ "queued_at": {
1667
+ "type": [
1668
+ "string",
1669
+ "null"
1670
+ ],
1671
+ "format": "date-time"
1672
+ },
1673
+ "sent_at": {
1674
+ "type": [
1675
+ "string",
1676
+ "null"
1677
+ ],
1678
+ "format": "date-time"
1679
+ },
1680
+ "delivered_at": {
1681
+ "type": [
1682
+ "string",
1683
+ "null"
1684
+ ],
1685
+ "format": "date-time"
1686
+ },
1687
+ "opened_at": {
1688
+ "type": [
1689
+ "string",
1690
+ "null"
1691
+ ],
1692
+ "format": "date-time"
1693
+ },
1694
+ "clicked_at": {
1695
+ "type": [
1696
+ "string",
1697
+ "null"
1698
+ ],
1699
+ "format": "date-time"
1700
+ },
1701
+ "error_message": {
1702
+ "type": [
1703
+ "string",
1704
+ "null"
1705
+ ]
1706
+ }
1707
+ }
1708
+ },
1709
+ "BatchSendInput": {
1710
+ "type": "object",
1711
+ "required": [
1712
+ "template_slug",
1713
+ "recipients"
1714
+ ],
1715
+ "properties": {
1716
+ "template_slug": {
1717
+ "type": "string"
1718
+ },
1719
+ "default_locale": {
1720
+ "type": "string"
1721
+ },
1722
+ "recipients": {
1723
+ "type": "array",
1724
+ "maxItems": 100,
1725
+ "items": {
1726
+ "type": "object",
1727
+ "required": [
1728
+ "email"
1729
+ ],
1730
+ "properties": {
1731
+ "email": {
1732
+ "type": "string",
1733
+ "format": "email"
1734
+ },
1735
+ "name": {
1736
+ "type": "string"
1737
+ },
1738
+ "locale": {
1739
+ "type": "string"
1740
+ },
1741
+ "variables": {
1742
+ "type": "object",
1743
+ "additionalProperties": {
1744
+ "type": "string"
1745
+ }
1746
+ }
1747
+ }
1748
+ }
1749
+ }
1750
+ }
1751
+ },
1752
+ "BatchSendSummary": {
1753
+ "type": "object",
1754
+ "required": [
1755
+ "batch_id",
1756
+ "total",
1757
+ "queued",
1758
+ "failed"
1759
+ ],
1760
+ "properties": {
1761
+ "batch_id": {
1762
+ "type": "string"
1763
+ },
1764
+ "total": {
1765
+ "type": "integer"
1766
+ },
1767
+ "queued": {
1768
+ "type": "integer"
1769
+ },
1770
+ "failed": {
1771
+ "type": "integer"
1772
+ }
1773
+ }
1774
+ },
1775
+ "EmailTemplate": {
1776
+ "type": "object",
1777
+ "required": [
1778
+ "id",
1779
+ "name",
1780
+ "slug",
1781
+ "type",
1782
+ "subject",
1783
+ "default_locale",
1784
+ "available_locales",
1785
+ "description",
1786
+ "category",
1787
+ "label_ids",
1788
+ "is_active",
1789
+ "is_archived",
1790
+ "version",
1791
+ "created_at",
1792
+ "updated_at"
1793
+ ],
1794
+ "properties": {
1795
+ "id": {
1796
+ "type": "string"
1797
+ },
1798
+ "name": {
1799
+ "type": "string"
1800
+ },
1801
+ "slug": {
1802
+ "type": "string"
1803
+ },
1804
+ "type": {
1805
+ "type": [
1806
+ "string",
1807
+ "null"
1808
+ ]
1809
+ },
1810
+ "subject": {
1811
+ "type": [
1812
+ "string",
1813
+ "null"
1814
+ ]
1815
+ },
1816
+ "default_locale": {
1817
+ "type": "string"
1818
+ },
1819
+ "available_locales": {
1820
+ "type": "array",
1821
+ "items": {
1822
+ "type": "string"
1823
+ }
1824
+ },
1825
+ "description": {
1826
+ "type": [
1827
+ "string",
1828
+ "null"
1829
+ ]
1830
+ },
1831
+ "category": {
1832
+ "type": [
1833
+ "string",
1834
+ "null"
1835
+ ]
1836
+ },
1837
+ "label_ids": {
1838
+ "type": "array",
1839
+ "items": {
1840
+ "type": "string"
1841
+ }
1842
+ },
1843
+ "is_active": {
1844
+ "type": "boolean"
1845
+ },
1846
+ "is_archived": {
1847
+ "type": "boolean"
1848
+ },
1849
+ "version": {
1850
+ "type": "integer"
1851
+ },
1852
+ "created_at": {
1853
+ "type": [
1854
+ "string",
1855
+ "null"
1856
+ ],
1857
+ "format": "date-time"
1858
+ },
1859
+ "updated_at": {
1860
+ "type": [
1861
+ "string",
1862
+ "null"
1863
+ ],
1864
+ "format": "date-time"
1865
+ }
1866
+ }
1867
+ },
1868
+ "EmailTemplateDetail": {
1869
+ "allOf": [
1870
+ {
1871
+ "$ref": "#/components/schemas/EmailTemplate"
1872
+ },
1873
+ {
1874
+ "type": "object",
1875
+ "required": [
1876
+ "html_content",
1877
+ "text_content",
1878
+ "preview_text",
1879
+ "from_name",
1880
+ "from_email",
1881
+ "reply_to",
1882
+ "requested_locale",
1883
+ "resolved_locale",
1884
+ "content_source",
1885
+ "localizations"
1886
+ ],
1887
+ "properties": {
1888
+ "html_content": {
1889
+ "type": [
1890
+ "string",
1891
+ "null"
1892
+ ]
1893
+ },
1894
+ "text_content": {
1895
+ "type": [
1896
+ "string",
1897
+ "null"
1898
+ ]
1899
+ },
1900
+ "preview_text": {
1901
+ "type": [
1902
+ "string",
1903
+ "null"
1904
+ ]
1905
+ },
1906
+ "from_name": {
1907
+ "type": [
1908
+ "string",
1909
+ "null"
1910
+ ]
1911
+ },
1912
+ "from_email": {
1913
+ "type": [
1914
+ "string",
1915
+ "null"
1916
+ ],
1917
+ "format": "email"
1918
+ },
1919
+ "reply_to": {
1920
+ "type": [
1921
+ "string",
1922
+ "null"
1923
+ ],
1924
+ "format": "email"
1925
+ },
1926
+ "requested_locale": {
1927
+ "type": [
1928
+ "string",
1929
+ "null"
1930
+ ]
1931
+ },
1932
+ "resolved_locale": {
1933
+ "type": "string"
1934
+ },
1935
+ "content_source": {
1936
+ "type": "string"
1937
+ },
1938
+ "localizations": {
1939
+ "type": "array",
1940
+ "items": {
1941
+ "type": "object",
1942
+ "required": [
1943
+ "locale",
1944
+ "subject",
1945
+ "html_content",
1946
+ "text_content",
1947
+ "preview_text"
1948
+ ],
1949
+ "properties": {
1950
+ "locale": {
1951
+ "type": [
1952
+ "string",
1953
+ "null"
1954
+ ]
1955
+ },
1956
+ "subject": {
1957
+ "type": [
1958
+ "string",
1959
+ "null"
1960
+ ]
1961
+ },
1962
+ "html_content": {
1963
+ "type": [
1964
+ "string",
1965
+ "null"
1966
+ ]
1967
+ },
1968
+ "text_content": {
1969
+ "type": [
1970
+ "string",
1971
+ "null"
1972
+ ]
1973
+ },
1974
+ "preview_text": {
1975
+ "type": [
1976
+ "string",
1977
+ "null"
1978
+ ]
1979
+ }
1980
+ }
1981
+ }
1982
+ }
1983
+ }
1984
+ }
1985
+ ]
1986
+ },
1987
+ "Contact": {
1988
+ "type": "object",
1989
+ "required": [
1990
+ "id",
1991
+ "email",
1992
+ "first_name",
1993
+ "last_name",
1994
+ "phone",
1995
+ "company",
1996
+ "job_title",
1997
+ "address",
1998
+ "status",
1999
+ "email_status",
2000
+ "label_ids",
2001
+ "source",
2002
+ "custom_fields",
2003
+ "created_at",
2004
+ "updated_at"
2005
+ ],
2006
+ "properties": {
2007
+ "id": {
2008
+ "type": "string"
2009
+ },
2010
+ "email": {
2011
+ "type": "string",
2012
+ "format": "email"
2013
+ },
2014
+ "first_name": {
2015
+ "type": [
2016
+ "string",
2017
+ "null"
2018
+ ]
2019
+ },
2020
+ "last_name": {
2021
+ "type": [
2022
+ "string",
2023
+ "null"
2024
+ ]
2025
+ },
2026
+ "phone": {
2027
+ "type": [
2028
+ "string",
2029
+ "null"
2030
+ ]
2031
+ },
2032
+ "company": {
2033
+ "type": [
2034
+ "string",
2035
+ "null"
2036
+ ]
2037
+ },
2038
+ "job_title": {
2039
+ "type": [
2040
+ "string",
2041
+ "null"
2042
+ ]
2043
+ },
2044
+ "address": {
2045
+ "anyOf": [
2046
+ {
2047
+ "type": "object",
2048
+ "additionalProperties": {
2049
+ "type": "string"
2050
+ }
2051
+ },
2052
+ {
2053
+ "type": "null"
2054
+ }
2055
+ ]
2056
+ },
2057
+ "status": {
2058
+ "$ref": "#/components/schemas/ContactStatus"
2059
+ },
2060
+ "email_status": {
2061
+ "$ref": "#/components/schemas/EmailStatus"
2062
+ },
2063
+ "label_ids": {
2064
+ "type": "array",
2065
+ "items": {
2066
+ "type": "string"
2067
+ }
2068
+ },
2069
+ "source": {
2070
+ "type": [
2071
+ "string",
2072
+ "null"
2073
+ ]
2074
+ },
2075
+ "custom_fields": {
2076
+ "anyOf": [
2077
+ {
2078
+ "type": "object",
2079
+ "additionalProperties": true
2080
+ },
2081
+ {
2082
+ "type": "null"
2083
+ }
2084
+ ]
2085
+ },
2086
+ "created_at": {
2087
+ "type": [
2088
+ "string",
2089
+ "null"
2090
+ ],
2091
+ "format": "date-time"
2092
+ },
2093
+ "updated_at": {
2094
+ "type": [
2095
+ "string",
2096
+ "null"
2097
+ ],
2098
+ "format": "date-time"
2099
+ }
2100
+ }
2101
+ },
2102
+ "ContactCreateResult": {
2103
+ "type": "object",
2104
+ "required": [
2105
+ "id"
2106
+ ],
2107
+ "properties": {
2108
+ "id": {
2109
+ "type": "string"
2110
+ }
2111
+ }
2112
+ },
2113
+ "ContactUpdateResult": {
2114
+ "type": "object",
2115
+ "required": [
2116
+ "success"
2117
+ ],
2118
+ "properties": {
2119
+ "success": {
2120
+ "type": "boolean",
2121
+ "const": true
2122
+ }
2123
+ }
2124
+ },
2125
+ "ContactRemoveResult": {
2126
+ "type": "object",
2127
+ "required": [
2128
+ "success"
2129
+ ],
2130
+ "properties": {
2131
+ "success": {
2132
+ "type": "boolean",
2133
+ "const": true
2134
+ }
2135
+ }
2136
+ },
2137
+ "ContactNoteResult": {
2138
+ "type": "object",
2139
+ "required": [
2140
+ "id"
2141
+ ],
2142
+ "properties": {
2143
+ "id": {
2144
+ "type": "string"
2145
+ }
2146
+ }
2147
+ },
2148
+ "ContactStatus": {
2149
+ "type": "string",
2150
+ "enum": [
2151
+ "lead",
2152
+ "prospect",
2153
+ "customer",
2154
+ "churned",
2155
+ "archived"
2156
+ ]
2157
+ },
2158
+ "EmailStatus": {
2159
+ "type": "string",
2160
+ "enum": [
2161
+ "subscribed",
2162
+ "unsubscribed",
2163
+ "bounced",
2164
+ "complained"
2165
+ ]
2166
+ },
2167
+ "CreateContactInput": {
2168
+ "type": "object",
2169
+ "required": [
2170
+ "email"
2171
+ ],
2172
+ "properties": {
2173
+ "email": {
2174
+ "type": "string",
2175
+ "format": "email"
2176
+ },
2177
+ "first_name": {
2178
+ "type": "string"
2179
+ },
2180
+ "last_name": {
2181
+ "type": "string"
2182
+ },
2183
+ "phone": {
2184
+ "type": "string"
2185
+ },
2186
+ "company": {
2187
+ "type": "string"
2188
+ },
2189
+ "job_title": {
2190
+ "type": "string"
2191
+ },
2192
+ "address": {
2193
+ "type": "object",
2194
+ "additionalProperties": {
2195
+ "type": "string"
2196
+ }
2197
+ },
2198
+ "status": {
2199
+ "$ref": "#/components/schemas/ContactStatus"
2200
+ },
2201
+ "email_status": {
2202
+ "$ref": "#/components/schemas/EmailStatus"
2203
+ },
2204
+ "label_ids": {
2205
+ "type": "array",
2206
+ "items": {
2207
+ "type": "string"
2208
+ }
2209
+ },
2210
+ "labels": {
2211
+ "type": "array",
2212
+ "items": {
2213
+ "type": "string"
2214
+ }
2215
+ },
2216
+ "custom_fields": {
2217
+ "type": "object",
2218
+ "additionalProperties": true
2219
+ },
2220
+ "notes": {
2221
+ "oneOf": [
2222
+ {
2223
+ "type": "string"
2224
+ },
2225
+ {
2226
+ "$ref": "#/components/schemas/ContactNoteInput"
2227
+ }
2228
+ ]
2229
+ }
2230
+ }
2231
+ },
2232
+ "UpdateContactInput": {
2233
+ "type": "object",
2234
+ "properties": {
2235
+ "email": {
2236
+ "type": "string",
2237
+ "format": "email"
2238
+ },
2239
+ "first_name": {
2240
+ "type": "string"
2241
+ },
2242
+ "last_name": {
2243
+ "type": "string"
2244
+ },
2245
+ "phone": {
2246
+ "type": "string"
2247
+ },
2248
+ "company": {
2249
+ "type": "string"
2250
+ },
2251
+ "job_title": {
2252
+ "type": "string"
2253
+ },
2254
+ "status": {
2255
+ "$ref": "#/components/schemas/ContactStatus"
2256
+ },
2257
+ "email_status": {
2258
+ "$ref": "#/components/schemas/EmailStatus"
2259
+ },
2260
+ "label_ids": {
2261
+ "type": "array",
2262
+ "items": {
2263
+ "type": "string"
2264
+ }
2265
+ },
2266
+ "labels": {
2267
+ "type": "array",
2268
+ "items": {
2269
+ "type": "string"
2270
+ }
2271
+ },
2272
+ "custom_fields": {
2273
+ "type": "object",
2274
+ "additionalProperties": true
2275
+ }
2276
+ }
2277
+ },
2278
+ "ContactNoteInput": {
2279
+ "type": "object",
2280
+ "required": [
2281
+ "content"
2282
+ ],
2283
+ "properties": {
2284
+ "content": {
2285
+ "type": "string"
2286
+ },
2287
+ "attachments": {
2288
+ "type": "array",
2289
+ "items": {
2290
+ "type": "object",
2291
+ "required": [
2292
+ "url",
2293
+ "name"
2294
+ ],
2295
+ "properties": {
2296
+ "url": {
2297
+ "type": "string",
2298
+ "format": "uri"
2299
+ },
2300
+ "name": {
2301
+ "type": "string"
2302
+ },
2303
+ "type": {
2304
+ "type": "string"
2305
+ },
2306
+ "size": {
2307
+ "type": "number"
2308
+ }
2309
+ }
2310
+ }
2311
+ }
2312
+ }
2313
+ },
2314
+ "ImportContactInput": {
2315
+ "type": "object",
2316
+ "required": [
2317
+ "email"
2318
+ ],
2319
+ "properties": {
2320
+ "email": {
2321
+ "type": "string",
2322
+ "format": "email"
2323
+ },
2324
+ "first_name": {
2325
+ "type": "string"
2326
+ },
2327
+ "last_name": {
2328
+ "type": "string"
2329
+ },
2330
+ "phone": {
2331
+ "type": "string"
2332
+ },
2333
+ "company": {
2334
+ "type": "string"
2335
+ },
2336
+ "job_title": {
2337
+ "type": "string"
2338
+ },
2339
+ "label_ids": {
2340
+ "type": "array",
2341
+ "items": {
2342
+ "type": "string"
2343
+ }
2344
+ },
2345
+ "status": {
2346
+ "type": "string"
2347
+ }
2348
+ }
2349
+ },
2350
+ "ImportContactsResult": {
2351
+ "type": "object",
2352
+ "required": [
2353
+ "added",
2354
+ "skipped",
2355
+ "total"
2356
+ ],
2357
+ "properties": {
2358
+ "added": {
2359
+ "type": "integer"
2360
+ },
2361
+ "skipped": {
2362
+ "type": "integer"
2363
+ },
2364
+ "total": {
2365
+ "type": "integer"
2366
+ }
2367
+ }
2368
+ },
2369
+ "Activity": {
2370
+ "type": "object",
2371
+ "required": [
2372
+ "id",
2373
+ "type",
2374
+ "title",
2375
+ "content",
2376
+ "actor_name",
2377
+ "actor_type",
2378
+ "metadata",
2379
+ "created_at"
2380
+ ],
2381
+ "properties": {
2382
+ "id": {
2383
+ "type": "string"
2384
+ },
2385
+ "type": {
2386
+ "type": "string"
2387
+ },
2388
+ "title": {
2389
+ "type": [
2390
+ "string",
2391
+ "null"
2392
+ ]
2393
+ },
2394
+ "content": {
2395
+ "type": [
2396
+ "string",
2397
+ "null"
2398
+ ]
2399
+ },
2400
+ "actor_name": {
2401
+ "type": [
2402
+ "string",
2403
+ "null"
2404
+ ]
2405
+ },
2406
+ "actor_type": {
2407
+ "type": [
2408
+ "string",
2409
+ "null"
2410
+ ]
2411
+ },
2412
+ "metadata": true,
2413
+ "created_at": {
2414
+ "type": [
2415
+ "string",
2416
+ "null"
2417
+ ],
2418
+ "format": "date-time"
2419
+ }
2420
+ }
2421
+ },
2422
+ "AddNoteInput": {
2423
+ "type": "object",
2424
+ "required": [
2425
+ "content"
2426
+ ],
2427
+ "properties": {
2428
+ "content": {
2429
+ "type": "string"
2430
+ }
2431
+ }
2432
+ },
2433
+ "Deal": {
2434
+ "type": "object",
2435
+ "required": [
2436
+ "id",
2437
+ "title",
2438
+ "description",
2439
+ "value",
2440
+ "currency",
2441
+ "status",
2442
+ "brand_name",
2443
+ "brand_website",
2444
+ "contact_id",
2445
+ "contact_name",
2446
+ "contact_email",
2447
+ "start_date",
2448
+ "end_date",
2449
+ "notes",
2450
+ "created_at",
2451
+ "updated_at"
2452
+ ],
2453
+ "properties": {
2454
+ "id": {
2455
+ "type": "string"
2456
+ },
2457
+ "title": {
2458
+ "type": "string"
2459
+ },
2460
+ "description": {
2461
+ "type": [
2462
+ "string",
2463
+ "null"
2464
+ ]
2465
+ },
2466
+ "value": {
2467
+ "type": [
2468
+ "number",
2469
+ "null"
2470
+ ]
2471
+ },
2472
+ "currency": {
2473
+ "type": [
2474
+ "string",
2475
+ "null"
2476
+ ]
2477
+ },
2478
+ "status": {
2479
+ "$ref": "#/components/schemas/DealStatus"
2480
+ },
2481
+ "brand_name": {
2482
+ "type": [
2483
+ "string",
2484
+ "null"
2485
+ ]
2486
+ },
2487
+ "brand_website": {
2488
+ "type": [
2489
+ "string",
2490
+ "null"
2491
+ ],
2492
+ "format": "uri"
2493
+ },
2494
+ "contact_id": {
2495
+ "type": [
2496
+ "string",
2497
+ "null"
2498
+ ]
2499
+ },
2500
+ "contact_name": {
2501
+ "type": [
2502
+ "string",
2503
+ "null"
2504
+ ]
2505
+ },
2506
+ "contact_email": {
2507
+ "type": [
2508
+ "string",
2509
+ "null"
2510
+ ],
2511
+ "format": "email"
2512
+ },
2513
+ "start_date": {
2514
+ "type": [
2515
+ "string",
2516
+ "null"
2517
+ ],
2518
+ "format": "date"
2519
+ },
2520
+ "end_date": {
2521
+ "type": [
2522
+ "string",
2523
+ "null"
2524
+ ],
2525
+ "format": "date"
2526
+ },
2527
+ "notes": {
2528
+ "type": [
2529
+ "string",
2530
+ "null"
2531
+ ]
2532
+ },
2533
+ "created_at": {
2534
+ "type": [
2535
+ "string",
2536
+ "null"
2537
+ ],
2538
+ "format": "date-time"
2539
+ },
2540
+ "updated_at": {
2541
+ "type": [
2542
+ "string",
2543
+ "null"
2544
+ ],
2545
+ "format": "date-time"
2546
+ }
2547
+ }
2548
+ },
2549
+ "DealCreateResult": {
2550
+ "type": "object",
2551
+ "required": [
2552
+ "id"
2553
+ ],
2554
+ "properties": {
2555
+ "id": {
2556
+ "type": "string"
2557
+ }
2558
+ }
2559
+ },
2560
+ "DealUpdateResult": {
2561
+ "type": "object",
2562
+ "required": [
2563
+ "success"
2564
+ ],
2565
+ "properties": {
2566
+ "success": {
2567
+ "type": "boolean",
2568
+ "const": true
2569
+ }
2570
+ }
2571
+ },
2572
+ "DealRemoveResult": {
2573
+ "type": "object",
2574
+ "required": [
2575
+ "success"
2576
+ ],
2577
+ "properties": {
2578
+ "success": {
2579
+ "type": "boolean",
2580
+ "const": true
2581
+ }
2582
+ }
2583
+ },
2584
+ "DealStatus": {
2585
+ "type": "string",
2586
+ "enum": [
2587
+ "draft",
2588
+ "open",
2589
+ "won",
2590
+ "lost",
2591
+ "negotiating",
2592
+ "proposal_sent",
2593
+ "on_hold",
2594
+ "churned"
2595
+ ]
2596
+ },
2597
+ "CreateDealInput": {
2598
+ "type": "object",
2599
+ "required": [
2600
+ "title"
2601
+ ],
2602
+ "properties": {
2603
+ "title": {
2604
+ "type": "string"
2605
+ },
2606
+ "description": {
2607
+ "type": "string"
2608
+ },
2609
+ "value": {
2610
+ "type": "number"
2611
+ },
2612
+ "currency": {
2613
+ "type": "string"
2614
+ },
2615
+ "brand_name": {
2616
+ "type": "string"
2617
+ },
2618
+ "brand_website": {
2619
+ "type": "string",
2620
+ "format": "uri"
2621
+ },
2622
+ "contact_id": {
2623
+ "type": "string"
2624
+ },
2625
+ "contact_name": {
2626
+ "type": "string"
2627
+ },
2628
+ "contact_email": {
2629
+ "type": "string",
2630
+ "format": "email"
2631
+ },
2632
+ "start_date": {
2633
+ "type": "string",
2634
+ "format": "date"
2635
+ },
2636
+ "end_date": {
2637
+ "type": "string",
2638
+ "format": "date"
2639
+ },
2640
+ "notes": {
2641
+ "type": "string"
2642
+ }
2643
+ }
2644
+ },
2645
+ "UpdateDealInput": {
2646
+ "type": "object",
2647
+ "properties": {
2648
+ "title": {
2649
+ "type": "string"
2650
+ },
2651
+ "description": {
2652
+ "type": "string"
2653
+ },
2654
+ "value": {
2655
+ "type": "number"
2656
+ },
2657
+ "currency": {
2658
+ "type": "string"
2659
+ },
2660
+ "status": {
2661
+ "$ref": "#/components/schemas/DealStatus"
2662
+ },
2663
+ "brand_name": {
2664
+ "type": "string"
2665
+ },
2666
+ "brand_website": {
2667
+ "type": "string",
2668
+ "format": "uri"
2669
+ },
2670
+ "contact_id": {
2671
+ "type": [
2672
+ "string",
2673
+ "null"
2674
+ ]
2675
+ },
2676
+ "contact_name": {
2677
+ "type": "string"
2678
+ },
2679
+ "contact_email": {
2680
+ "type": "string",
2681
+ "format": "email"
2682
+ },
2683
+ "start_date": {
2684
+ "type": "string",
2685
+ "format": "date"
2686
+ },
2687
+ "end_date": {
2688
+ "type": "string",
2689
+ "format": "date"
2690
+ },
2691
+ "notes": {
2692
+ "type": "string"
2693
+ }
2694
+ }
2695
+ },
2696
+ "GdprExport": {
2697
+ "type": "object",
2698
+ "required": [
2699
+ "id",
2700
+ "request_type",
2701
+ "status",
2702
+ "submitted_at",
2703
+ "completed_at"
2704
+ ],
2705
+ "properties": {
2706
+ "id": {
2707
+ "type": "string"
2708
+ },
2709
+ "request_type": {
2710
+ "type": "string"
2711
+ },
2712
+ "status": {
2713
+ "type": "string"
2714
+ },
2715
+ "submitted_at": {
2716
+ "type": [
2717
+ "string",
2718
+ "null"
2719
+ ],
2720
+ "format": "date-time"
2721
+ },
2722
+ "completed_at": {
2723
+ "type": [
2724
+ "string",
2725
+ "null"
2726
+ ],
2727
+ "format": "date-time"
2728
+ },
2729
+ "due_date": {
2730
+ "type": [
2731
+ "string",
2732
+ "null"
2733
+ ],
2734
+ "format": "date-time"
2735
+ },
2736
+ "download_url": {
2737
+ "type": [
2738
+ "string",
2739
+ "null"
2740
+ ],
2741
+ "format": "uri"
2742
+ },
2743
+ "expires_at": {
2744
+ "type": [
2745
+ "string",
2746
+ "null"
2747
+ ],
2748
+ "format": "date-time"
2749
+ }
2750
+ }
2751
+ },
2752
+ "GdprExportRequest": {
2753
+ "type": "object",
2754
+ "required": [
2755
+ "request_id",
2756
+ "status"
2757
+ ],
2758
+ "properties": {
2759
+ "request_id": {
2760
+ "type": "string"
2761
+ },
2762
+ "status": {
2763
+ "type": "string"
2764
+ }
2765
+ }
2766
+ },
2767
+ "ConsentType": {
2768
+ "type": "string",
2769
+ "enum": [
2770
+ "marketing_email",
2771
+ "analytics_tracking",
2772
+ "third_party_sharing"
2773
+ ]
2774
+ },
2775
+ "RecordConsentInput": {
2776
+ "type": "object",
2777
+ "required": [
2778
+ "email",
2779
+ "consent_type",
2780
+ "granted"
2781
+ ],
2782
+ "properties": {
2783
+ "email": {
2784
+ "type": "string",
2785
+ "format": "email"
2786
+ },
2787
+ "consent_type": {
2788
+ "$ref": "#/components/schemas/ConsentType"
2789
+ },
2790
+ "granted": {
2791
+ "type": "boolean"
2792
+ },
2793
+ "source": {
2794
+ "type": "string"
2795
+ },
2796
+ "ip_address": {
2797
+ "type": "string"
2798
+ },
2799
+ "consent_text": {
2800
+ "type": "string"
2801
+ },
2802
+ "version": {
2803
+ "type": "string"
2804
+ }
2805
+ }
2806
+ },
2807
+ "ConsentRecord": {
2808
+ "type": "object",
2809
+ "required": [
2810
+ "id",
2811
+ "email",
2812
+ "consent_type",
2813
+ "granted",
2814
+ "granted_at",
2815
+ "revoked_at"
2816
+ ],
2817
+ "properties": {
2818
+ "id": {
2819
+ "type": "string"
2820
+ },
2821
+ "email": {
2822
+ "type": "string",
2823
+ "format": "email"
2824
+ },
2825
+ "consent_type": {
2826
+ "$ref": "#/components/schemas/ConsentType"
2827
+ },
2828
+ "granted": {
2829
+ "type": "boolean"
2830
+ },
2831
+ "granted_at": {
2832
+ "type": [
2833
+ "string",
2834
+ "null"
2835
+ ],
2836
+ "format": "date-time"
2837
+ },
2838
+ "revoked_at": {
2839
+ "type": [
2840
+ "string",
2841
+ "null"
2842
+ ],
2843
+ "format": "date-time"
2844
+ },
2845
+ "source": {
2846
+ "type": "string"
2847
+ },
2848
+ "version": {
2849
+ "type": "string"
2850
+ }
2851
+ }
2852
+ },
2853
+ "ConsentResult": {
2854
+ "type": "object",
2855
+ "required": [
2856
+ "id"
2857
+ ],
2858
+ "properties": {
2859
+ "id": {
2860
+ "type": "string"
2861
+ }
2862
+ }
2863
+ },
2864
+ "CookieConsentInput": {
2865
+ "type": "object",
2866
+ "required": [
2867
+ "domain",
2868
+ "consentStatus",
2869
+ "consentTimestamp",
2870
+ "cookiePreferences"
2871
+ ],
2872
+ "properties": {
2873
+ "domain": {
2874
+ "type": "string"
2875
+ },
2876
+ "consentStatus": {
2877
+ "type": "string"
2878
+ },
2879
+ "consentTimestamp": {
2880
+ "type": "string",
2881
+ "format": "date-time"
2882
+ },
2883
+ "ipAddress": {
2884
+ "type": "string"
2885
+ },
2886
+ "userAgent": {
2887
+ "type": "string"
2888
+ },
2889
+ "cookiePreferences": {
2890
+ "type": "object",
2891
+ "additionalProperties": {
2892
+ "$ref": "#/components/schemas/CookieCategoryConsent"
2893
+ }
2894
+ }
2895
+ }
2896
+ },
2897
+ "CookieCategoryConsent": {
2898
+ "type": "object",
2899
+ "required": [
2900
+ "allowed"
2901
+ ],
2902
+ "properties": {
2903
+ "allowed": {
2904
+ "type": "boolean"
2905
+ },
2906
+ "cookieRecords": {
2907
+ "type": "array",
2908
+ "items": {
2909
+ "type": "object",
2910
+ "required": [
2911
+ "cookie",
2912
+ "duration",
2913
+ "description"
2914
+ ],
2915
+ "properties": {
2916
+ "cookie": {
2917
+ "type": "string"
2918
+ },
2919
+ "duration": {
2920
+ "type": "string"
2921
+ },
2922
+ "description": {
2923
+ "type": "string"
2924
+ }
2925
+ }
2926
+ }
2927
+ }
2928
+ }
2929
+ },
2930
+ "CookieConsentResult": {
2931
+ "type": "object",
2932
+ "required": [
2933
+ "success"
2934
+ ],
2935
+ "properties": {
2936
+ "success": {
2937
+ "type": "boolean"
2938
+ },
2939
+ "logId": {
2940
+ "type": "string"
2941
+ }
2942
+ }
2943
+ },
2944
+ "Workspace": {
2945
+ "type": "object",
2946
+ "required": [
2947
+ "id",
2948
+ "name",
2949
+ "slug"
2950
+ ],
2951
+ "properties": {
2952
+ "id": {
2953
+ "type": "string"
2954
+ },
2955
+ "name": {
2956
+ "type": "string"
2957
+ },
2958
+ "slug": {
2959
+ "type": "string"
2960
+ }
2961
+ },
2962
+ "additionalProperties": true
2963
+ },
2964
+ "ApiResponse_PostCreateResult": {
2965
+ "$ref": "#/components/schemas/Envelope_PostCreateResult"
2966
+ },
2967
+ "ApiResponse_PostDetail": {
2968
+ "$ref": "#/components/schemas/Envelope_PostDetail"
2969
+ },
2970
+ "ApiResponse_Success": {
2971
+ "$ref": "#/components/schemas/Envelope_Success"
2972
+ },
2973
+ "ApiResponse_ScheduleResult": {
2974
+ "$ref": "#/components/schemas/Envelope_ScheduleResult"
2975
+ },
2976
+ "ApiResponse_PublishResult": {
2977
+ "$ref": "#/components/schemas/Envelope_PublishResult"
2978
+ },
2979
+ "ApiResponse_ChannelArray": {
2980
+ "$ref": "#/components/schemas/Envelope_ChannelArray"
2981
+ },
2982
+ "ApiResponse_EmailSendResult": {
2983
+ "$ref": "#/components/schemas/Envelope_EmailSendResult"
2984
+ },
2985
+ "ApiResponse_EmailSend": {
2986
+ "$ref": "#/components/schemas/Envelope_EmailSend"
2987
+ },
2988
+ "ApiResponse_BatchSendSummary": {
2989
+ "$ref": "#/components/schemas/Envelope_BatchSendSummary"
2990
+ },
2991
+ "ApiResponse_EmailTemplateArray": {
2992
+ "$ref": "#/components/schemas/Envelope_EmailTemplateArray"
2993
+ },
2994
+ "ApiResponse_EmailTemplateDetail": {
2995
+ "$ref": "#/components/schemas/Envelope_EmailTemplateDetail"
2996
+ },
2997
+ "ApiResponse_Contact": {
2998
+ "$ref": "#/components/schemas/Envelope_Contact"
2999
+ },
3000
+ "ApiResponse_ContactCreateResult": {
3001
+ "$ref": "#/components/schemas/Envelope_ContactCreateResult"
3002
+ },
3003
+ "ApiResponse_ContactUpdateResult": {
3004
+ "$ref": "#/components/schemas/Envelope_ContactUpdateResult"
3005
+ },
3006
+ "ApiResponse_ContactRemoveResult": {
3007
+ "$ref": "#/components/schemas/Envelope_ContactRemoveResult"
3008
+ },
3009
+ "ApiResponse_ContactNoteResult": {
3010
+ "$ref": "#/components/schemas/Envelope_ContactNoteResult"
3011
+ },
3012
+ "ApiResponse_ImportContactsResult": {
3013
+ "$ref": "#/components/schemas/Envelope_ImportContactsResult"
3014
+ },
3015
+ "ApiResponse_Deal": {
3016
+ "$ref": "#/components/schemas/Envelope_Deal"
3017
+ },
3018
+ "ApiResponse_DealCreateResult": {
3019
+ "$ref": "#/components/schemas/Envelope_DealCreateResult"
3020
+ },
3021
+ "ApiResponse_DealUpdateResult": {
3022
+ "$ref": "#/components/schemas/Envelope_DealUpdateResult"
3023
+ },
3024
+ "ApiResponse_DealRemoveResult": {
3025
+ "$ref": "#/components/schemas/Envelope_DealRemoveResult"
3026
+ },
3027
+ "ApiResponse_GdprExportRequest": {
3028
+ "$ref": "#/components/schemas/Envelope_GdprExportRequest"
3029
+ },
3030
+ "ApiResponse_GdprExportArray": {
3031
+ "$ref": "#/components/schemas/Envelope_GdprExportArray"
3032
+ },
3033
+ "ApiResponse_GdprExport": {
3034
+ "$ref": "#/components/schemas/Envelope_GdprExport"
3035
+ },
3036
+ "ApiResponse_ConsentResult": {
3037
+ "$ref": "#/components/schemas/Envelope_ConsentResult"
3038
+ },
3039
+ "ApiResponse_ConsentRecordArray": {
3040
+ "$ref": "#/components/schemas/Envelope_ConsentRecordArray"
3041
+ },
3042
+ "ApiResponse_WorkspaceArray": {
3043
+ "$ref": "#/components/schemas/Envelope_WorkspaceArray"
3044
+ },
3045
+ "PaginatedResponse_Post": {
3046
+ "type": "object",
3047
+ "required": [
3048
+ "data",
3049
+ "pagination"
3050
+ ],
3051
+ "properties": {
3052
+ "data": {
3053
+ "type": "array",
3054
+ "items": {
3055
+ "$ref": "#/components/schemas/Post"
3056
+ }
3057
+ },
3058
+ "pagination": {
3059
+ "$ref": "#/components/schemas/Pagination"
3060
+ }
3061
+ }
3062
+ },
3063
+ "PaginatedResponse_Contact": {
3064
+ "type": "object",
3065
+ "required": [
3066
+ "data",
3067
+ "pagination"
3068
+ ],
3069
+ "properties": {
3070
+ "data": {
3071
+ "type": "array",
3072
+ "items": {
3073
+ "$ref": "#/components/schemas/Contact"
3074
+ }
3075
+ },
3076
+ "pagination": {
3077
+ "$ref": "#/components/schemas/Pagination"
3078
+ }
3079
+ }
3080
+ },
3081
+ "PaginatedResponse_Activity": {
3082
+ "type": "object",
3083
+ "required": [
3084
+ "data",
3085
+ "pagination"
3086
+ ],
3087
+ "properties": {
3088
+ "data": {
3089
+ "type": "array",
3090
+ "items": {
3091
+ "$ref": "#/components/schemas/Activity"
3092
+ }
3093
+ },
3094
+ "pagination": {
3095
+ "$ref": "#/components/schemas/Pagination"
3096
+ }
3097
+ }
3098
+ },
3099
+ "PaginatedResponse_Deal": {
3100
+ "type": "object",
3101
+ "required": [
3102
+ "data",
3103
+ "pagination"
3104
+ ],
3105
+ "properties": {
3106
+ "data": {
3107
+ "type": "array",
3108
+ "items": {
3109
+ "$ref": "#/components/schemas/Deal"
3110
+ }
3111
+ },
3112
+ "pagination": {
3113
+ "$ref": "#/components/schemas/Pagination"
3114
+ }
3115
+ }
3116
+ },
3117
+ "Envelope_PostCreateResult": {
3118
+ "type": "object",
3119
+ "required": [
3120
+ "data"
3121
+ ],
3122
+ "properties": {
3123
+ "data": {
3124
+ "$ref": "#/components/schemas/PostCreateResult"
3125
+ }
3126
+ }
3127
+ },
3128
+ "Envelope_PostDetail": {
3129
+ "type": "object",
3130
+ "required": [
3131
+ "data"
3132
+ ],
3133
+ "properties": {
3134
+ "data": {
3135
+ "$ref": "#/components/schemas/PostDetail"
3136
+ }
3137
+ }
3138
+ },
3139
+ "Envelope_Success": {
3140
+ "type": "object",
3141
+ "required": [
3142
+ "data"
3143
+ ],
3144
+ "properties": {
3145
+ "data": {
3146
+ "$ref": "#/components/schemas/Success"
3147
+ }
3148
+ }
3149
+ },
3150
+ "Envelope_ScheduleResult": {
3151
+ "type": "object",
3152
+ "required": [
3153
+ "data"
3154
+ ],
3155
+ "properties": {
3156
+ "data": {
3157
+ "$ref": "#/components/schemas/ScheduleResult"
3158
+ }
3159
+ }
3160
+ },
3161
+ "Envelope_PublishResult": {
3162
+ "type": "object",
3163
+ "required": [
3164
+ "data"
3165
+ ],
3166
+ "properties": {
3167
+ "data": {
3168
+ "$ref": "#/components/schemas/PublishResult"
3169
+ }
3170
+ }
3171
+ },
3172
+ "Envelope_ChannelArray": {
3173
+ "type": "object",
3174
+ "required": [
3175
+ "data"
3176
+ ],
3177
+ "properties": {
3178
+ "data": {
3179
+ "type": "array",
3180
+ "items": {
3181
+ "$ref": "#/components/schemas/Channel"
3182
+ }
3183
+ }
3184
+ }
3185
+ },
3186
+ "Envelope_EmailSendResult": {
3187
+ "type": "object",
3188
+ "required": [
3189
+ "data"
3190
+ ],
3191
+ "properties": {
3192
+ "data": {
3193
+ "$ref": "#/components/schemas/EmailSendResult"
3194
+ }
3195
+ }
3196
+ },
3197
+ "Envelope_EmailSend": {
3198
+ "type": "object",
3199
+ "required": [
3200
+ "data"
3201
+ ],
3202
+ "properties": {
3203
+ "data": {
3204
+ "$ref": "#/components/schemas/EmailSend"
3205
+ }
3206
+ }
3207
+ },
3208
+ "Envelope_BatchSendSummary": {
3209
+ "type": "object",
3210
+ "required": [
3211
+ "data"
3212
+ ],
3213
+ "properties": {
3214
+ "data": {
3215
+ "$ref": "#/components/schemas/BatchSendSummary"
3216
+ }
3217
+ }
3218
+ },
3219
+ "Envelope_EmailTemplateArray": {
3220
+ "type": "object",
3221
+ "required": [
3222
+ "data"
3223
+ ],
3224
+ "properties": {
3225
+ "data": {
3226
+ "type": "array",
3227
+ "items": {
3228
+ "$ref": "#/components/schemas/EmailTemplate"
3229
+ }
3230
+ }
3231
+ }
3232
+ },
3233
+ "Envelope_EmailTemplateDetail": {
3234
+ "type": "object",
3235
+ "required": [
3236
+ "data"
3237
+ ],
3238
+ "properties": {
3239
+ "data": {
3240
+ "$ref": "#/components/schemas/EmailTemplateDetail"
3241
+ }
3242
+ }
3243
+ },
3244
+ "Envelope_Contact": {
3245
+ "type": "object",
3246
+ "required": [
3247
+ "data"
3248
+ ],
3249
+ "properties": {
3250
+ "data": {
3251
+ "$ref": "#/components/schemas/Contact"
3252
+ }
3253
+ }
3254
+ },
3255
+ "Envelope_ContactCreateResult": {
3256
+ "type": "object",
3257
+ "required": [
3258
+ "data"
3259
+ ],
3260
+ "properties": {
3261
+ "data": {
3262
+ "$ref": "#/components/schemas/ContactCreateResult"
3263
+ }
3264
+ }
3265
+ },
3266
+ "Envelope_ContactUpdateResult": {
3267
+ "type": "object",
3268
+ "required": [
3269
+ "data"
3270
+ ],
3271
+ "properties": {
3272
+ "data": {
3273
+ "$ref": "#/components/schemas/ContactUpdateResult"
3274
+ }
3275
+ }
3276
+ },
3277
+ "Envelope_ContactRemoveResult": {
3278
+ "type": "object",
3279
+ "required": [
3280
+ "data"
3281
+ ],
3282
+ "properties": {
3283
+ "data": {
3284
+ "$ref": "#/components/schemas/ContactRemoveResult"
3285
+ }
3286
+ }
3287
+ },
3288
+ "Envelope_ContactNoteResult": {
3289
+ "type": "object",
3290
+ "required": [
3291
+ "data"
3292
+ ],
3293
+ "properties": {
3294
+ "data": {
3295
+ "$ref": "#/components/schemas/ContactNoteResult"
3296
+ }
3297
+ }
3298
+ },
3299
+ "Envelope_ImportContactsResult": {
3300
+ "type": "object",
3301
+ "required": [
3302
+ "data"
3303
+ ],
3304
+ "properties": {
3305
+ "data": {
3306
+ "$ref": "#/components/schemas/ImportContactsResult"
3307
+ }
3308
+ }
3309
+ },
3310
+ "Envelope_Deal": {
3311
+ "type": "object",
3312
+ "required": [
3313
+ "data"
3314
+ ],
3315
+ "properties": {
3316
+ "data": {
3317
+ "$ref": "#/components/schemas/Deal"
3318
+ }
3319
+ }
3320
+ },
3321
+ "Envelope_DealCreateResult": {
3322
+ "type": "object",
3323
+ "required": [
3324
+ "data"
3325
+ ],
3326
+ "properties": {
3327
+ "data": {
3328
+ "$ref": "#/components/schemas/DealCreateResult"
3329
+ }
3330
+ }
3331
+ },
3332
+ "Envelope_DealUpdateResult": {
3333
+ "type": "object",
3334
+ "required": [
3335
+ "data"
3336
+ ],
3337
+ "properties": {
3338
+ "data": {
3339
+ "$ref": "#/components/schemas/DealUpdateResult"
3340
+ }
3341
+ }
3342
+ },
3343
+ "Envelope_DealRemoveResult": {
3344
+ "type": "object",
3345
+ "required": [
3346
+ "data"
3347
+ ],
3348
+ "properties": {
3349
+ "data": {
3350
+ "$ref": "#/components/schemas/DealRemoveResult"
3351
+ }
3352
+ }
3353
+ },
3354
+ "Envelope_GdprExportRequest": {
3355
+ "type": "object",
3356
+ "required": [
3357
+ "data"
3358
+ ],
3359
+ "properties": {
3360
+ "data": {
3361
+ "$ref": "#/components/schemas/GdprExportRequest"
3362
+ }
3363
+ }
3364
+ },
3365
+ "Envelope_GdprExportArray": {
3366
+ "type": "object",
3367
+ "required": [
3368
+ "data"
3369
+ ],
3370
+ "properties": {
3371
+ "data": {
3372
+ "type": "array",
3373
+ "items": {
3374
+ "$ref": "#/components/schemas/GdprExport"
3375
+ }
3376
+ }
3377
+ }
3378
+ },
3379
+ "Envelope_GdprExport": {
3380
+ "type": "object",
3381
+ "required": [
3382
+ "data"
3383
+ ],
3384
+ "properties": {
3385
+ "data": {
3386
+ "$ref": "#/components/schemas/GdprExport"
3387
+ }
3388
+ }
3389
+ },
3390
+ "Envelope_ConsentResult": {
3391
+ "type": "object",
3392
+ "required": [
3393
+ "data"
3394
+ ],
3395
+ "properties": {
3396
+ "data": {
3397
+ "$ref": "#/components/schemas/ConsentResult"
3398
+ }
3399
+ }
3400
+ },
3401
+ "Envelope_ConsentRecordArray": {
3402
+ "type": "object",
3403
+ "required": [
3404
+ "data"
3405
+ ],
3406
+ "properties": {
3407
+ "data": {
3408
+ "type": "array",
3409
+ "items": {
3410
+ "$ref": "#/components/schemas/ConsentRecord"
3411
+ }
3412
+ }
3413
+ }
3414
+ },
3415
+ "Envelope_WorkspaceArray": {
3416
+ "type": "object",
3417
+ "required": [
3418
+ "data"
3419
+ ],
3420
+ "properties": {
3421
+ "data": {
3422
+ "type": "array",
3423
+ "items": {
3424
+ "$ref": "#/components/schemas/Workspace"
3425
+ }
3426
+ }
3427
+ }
3428
+ }
3429
+ }
3430
+ }
3431
+ }