@medalsocial/sdk 1.3.0 → 1.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.
Files changed (18) hide show
  1. package/dist/openapi/medal-social.openapi.json +114 -40
  2. package/dist/pilot/index.d.mts +64 -324
  3. package/dist/pilot/index.d.ts +64 -324
  4. package/dist/pilot/index.js +5 -5
  5. package/dist/pilot/index.js.map +1 -1
  6. package/dist/pilot/index.mjs +5 -5
  7. package/dist/pilot/index.mjs.map +1 -1
  8. package/dist/src/index.d.mts +31 -3
  9. package/dist/src/index.d.ts +31 -3
  10. package/dist/src/index.js +8 -2
  11. package/dist/src/index.js.map +1 -1
  12. package/dist/src/index.mjs +8 -2
  13. package/dist/src/index.mjs.map +1 -1
  14. package/dist/src/openapi.generated.d.mts +22 -1
  15. package/dist/src/openapi.generated.d.ts +22 -1
  16. package/dist/src/openapi.generated.js.map +1 -1
  17. package/openapi/medal-social.openapi.yaml +38 -3
  18. package/package.json +14 -14
package/dist/openapi/medal-social.openapi.json CHANGED
@@ -123,7 +123,7 @@
123
123
  "content": {
124
124
  "application/json": {
125
125
  "schema": {
126
- "$ref": "#/components/schemas/Envelope_PostCreateResult"
126
+ "$ref": "#/components/schemas/ApiResponse_PostCreateResult"
127
127
  }
128
128
  }
129
129
  }
@@ -147,7 +147,7 @@
147
147
  "content": {
148
148
  "application/json": {
149
149
  "schema": {
150
- "$ref": "#/components/schemas/Envelope_ChannelArray"
150
+ "$ref": "#/components/schemas/ApiResponse_ChannelArray"
151
151
  }
152
152
  }
153
153
  }
@@ -176,7 +176,7 @@
176
176
  "content": {
177
177
  "application/json": {
178
178
  "schema": {
179
- "$ref": "#/components/schemas/Envelope_PostDetail"
179
+ "$ref": "#/components/schemas/ApiResponse_PostDetail"
180
180
  }
181
181
  }
182
182
  }
@@ -208,7 +208,7 @@
208
208
  "content": {
209
209
  "application/json": {
210
210
  "schema": {
211
- "$ref": "#/components/schemas/Envelope_Success"
211
+ "$ref": "#/components/schemas/ApiResponse_Success"
212
212
  }
213
213
  }
214
214
  }
@@ -230,7 +230,7 @@
230
230
  "content": {
231
231
  "application/json": {
232
232
  "schema": {
233
- "$ref": "#/components/schemas/Envelope_Success"
233
+ "$ref": "#/components/schemas/ApiResponse_Success"
234
234
  }
235
235
  }
236
236
  }
@@ -269,7 +269,7 @@
269
269
  "content": {
270
270
  "application/json": {
271
271
  "schema": {
272
- "$ref": "#/components/schemas/Envelope_ScheduleResult"
272
+ "$ref": "#/components/schemas/ApiResponse_ScheduleResult"
273
273
  }
274
274
  }
275
275
  }
@@ -298,7 +298,7 @@
298
298
  "content": {
299
299
  "application/json": {
300
300
  "schema": {
301
- "$ref": "#/components/schemas/Envelope_PublishResult"
301
+ "$ref": "#/components/schemas/ApiResponse_PublishResult"
302
302
  }
303
303
  }
304
304
  }
@@ -332,7 +332,7 @@
332
332
  "content": {
333
333
  "application/json": {
334
334
  "schema": {
335
- "$ref": "#/components/schemas/Envelope_EmailSendResult"
335
+ "$ref": "#/components/schemas/ApiResponse_EmailSendResult"
336
336
  }
337
337
  }
338
338
  }
@@ -366,7 +366,7 @@
366
366
  "content": {
367
367
  "application/json": {
368
368
  "schema": {
369
- "$ref": "#/components/schemas/Envelope_BatchSendSummary"
369
+ "$ref": "#/components/schemas/ApiResponse_BatchSendSummary"
370
370
  }
371
371
  }
372
372
  }
@@ -390,7 +390,7 @@
390
390
  "content": {
391
391
  "application/json": {
392
392
  "schema": {
393
- "$ref": "#/components/schemas/Envelope_EmailTemplateArray"
393
+ "$ref": "#/components/schemas/ApiResponse_EmailTemplateArray"
394
394
  }
395
395
  }
396
396
  }
@@ -435,7 +435,7 @@
435
435
  "content": {
436
436
  "application/json": {
437
437
  "schema": {
438
- "$ref": "#/components/schemas/Envelope_EmailTemplateDetail"
438
+ "$ref": "#/components/schemas/ApiResponse_EmailTemplateDetail"
439
439
  }
440
440
  }
441
441
  }
@@ -464,7 +464,7 @@
464
464
  "content": {
465
465
  "application/json": {
466
466
  "schema": {
467
- "$ref": "#/components/schemas/Envelope_EmailSend"
467
+ "$ref": "#/components/schemas/ApiResponse_EmailSend"
468
468
  }
469
469
  }
470
470
  }
@@ -557,7 +557,7 @@
557
557
  "content": {
558
558
  "application/json": {
559
559
  "schema": {
560
- "$ref": "#/components/schemas/Envelope_ContactCreateResult"
560
+ "$ref": "#/components/schemas/ApiResponse_ContactCreateResult"
561
561
  }
562
562
  }
563
563
  }
@@ -603,7 +603,7 @@
603
603
  "content": {
604
604
  "application/json": {
605
605
  "schema": {
606
- "$ref": "#/components/schemas/Envelope_ImportContactsResult"
606
+ "$ref": "#/components/schemas/ApiResponse_ImportContactsResult"
607
607
  }
608
608
  }
609
609
  }
@@ -632,7 +632,7 @@
632
632
  "content": {
633
633
  "application/json": {
634
634
  "schema": {
635
- "$ref": "#/components/schemas/Envelope_Contact"
635
+ "$ref": "#/components/schemas/ApiResponse_Contact"
636
636
  }
637
637
  }
638
638
  }
@@ -664,7 +664,7 @@
664
664
  "content": {
665
665
  "application/json": {
666
666
  "schema": {
667
- "$ref": "#/components/schemas/Envelope_ContactUpdateResult"
667
+ "$ref": "#/components/schemas/ApiResponse_ContactUpdateResult"
668
668
  }
669
669
  }
670
670
  }
@@ -686,7 +686,7 @@
686
686
  "content": {
687
687
  "application/json": {
688
688
  "schema": {
689
- "$ref": "#/components/schemas/Envelope_ContactRemoveResult"
689
+ "$ref": "#/components/schemas/ApiResponse_ContactRemoveResult"
690
690
  }
691
691
  }
692
692
  }
@@ -762,7 +762,7 @@
762
762
  "content": {
763
763
  "application/json": {
764
764
  "schema": {
765
- "$ref": "#/components/schemas/Envelope_ContactNoteResult"
765
+ "$ref": "#/components/schemas/ApiResponse_ContactNoteResult"
766
766
  }
767
767
  }
768
768
  }
@@ -840,7 +840,7 @@
840
840
  "content": {
841
841
  "application/json": {
842
842
  "schema": {
843
- "$ref": "#/components/schemas/Envelope_DealCreateResult"
843
+ "$ref": "#/components/schemas/ApiResponse_DealCreateResult"
844
844
  }
845
845
  }
846
846
  }
@@ -869,7 +869,7 @@
869
869
  "content": {
870
870
  "application/json": {
871
871
  "schema": {
872
- "$ref": "#/components/schemas/Envelope_Deal"
872
+ "$ref": "#/components/schemas/ApiResponse_Deal"
873
873
  }
874
874
  }
875
875
  }
@@ -901,7 +901,7 @@
901
901
  "content": {
902
902
  "application/json": {
903
903
  "schema": {
904
- "$ref": "#/components/schemas/Envelope_DealUpdateResult"
904
+ "$ref": "#/components/schemas/ApiResponse_DealUpdateResult"
905
905
  }
906
906
  }
907
907
  }
@@ -923,7 +923,7 @@
923
923
  "content": {
924
924
  "application/json": {
925
925
  "schema": {
926
- "$ref": "#/components/schemas/Envelope_DealRemoveResult"
926
+ "$ref": "#/components/schemas/ApiResponse_DealRemoveResult"
927
927
  }
928
928
  }
929
929
  }
@@ -947,7 +947,7 @@
947
947
  "content": {
948
948
  "application/json": {
949
949
  "schema": {
950
- "$ref": "#/components/schemas/Envelope_GdprExportRequest"
950
+ "$ref": "#/components/schemas/ApiResponse_GdprExportRequest"
951
951
  }
952
952
  }
953
953
  }
@@ -971,7 +971,7 @@
971
971
  "content": {
972
972
  "application/json": {
973
973
  "schema": {
974
- "$ref": "#/components/schemas/Envelope_GdprExportArray"
974
+ "$ref": "#/components/schemas/ApiResponse_GdprExportArray"
975
975
  }
976
976
  }
977
977
  }
@@ -1000,7 +1000,7 @@
1000
1000
  "content": {
1001
1001
  "application/json": {
1002
1002
  "schema": {
1003
- "$ref": "#/components/schemas/Envelope_GdprExport"
1003
+ "$ref": "#/components/schemas/ApiResponse_GdprExport"
1004
1004
  }
1005
1005
  }
1006
1006
  }
@@ -1034,7 +1034,7 @@
1034
1034
  "content": {
1035
1035
  "application/json": {
1036
1036
  "schema": {
1037
- "$ref": "#/components/schemas/Envelope_ConsentResult"
1037
+ "$ref": "#/components/schemas/ApiResponse_ConsentResult"
1038
1038
  }
1039
1039
  }
1040
1040
  }
@@ -1069,7 +1069,7 @@
1069
1069
  "content": {
1070
1070
  "application/json": {
1071
1071
  "schema": {
1072
- "$ref": "#/components/schemas/Envelope_ConsentRecordArray"
1072
+ "$ref": "#/components/schemas/ApiResponse_ConsentRecordArray"
1073
1073
  }
1074
1074
  }
1075
1075
  }
@@ -1127,7 +1127,7 @@
1127
1127
  "content": {
1128
1128
  "application/json": {
1129
1129
  "schema": {
1130
- "$ref": "#/components/schemas/Envelope_WorkspaceArray"
1130
+ "$ref": "#/components/schemas/ApiResponse_WorkspaceArray"
1131
1131
  }
1132
1132
  }
1133
1133
  }
@@ -1233,7 +1233,7 @@
1233
1233
  "content": {
1234
1234
  "application/json": {
1235
1235
  "schema": {
1236
- "$ref": "#/components/schemas/Envelope_HelpdeskConversation"
1236
+ "$ref": "#/components/schemas/ApiResponse_HelpdeskConversation"
1237
1237
  }
1238
1238
  }
1239
1239
  }
@@ -1266,7 +1266,7 @@
1266
1266
  "content": {
1267
1267
  "application/json": {
1268
1268
  "schema": {
1269
- "$ref": "#/components/schemas/Envelope_HelpdeskConversationUpdateResult"
1269
+ "$ref": "#/components/schemas/ApiResponse_HelpdeskConversationUpdateResult"
1270
1270
  }
1271
1271
  }
1272
1272
  }
@@ -1354,7 +1354,7 @@
1354
1354
  "content": {
1355
1355
  "application/json": {
1356
1356
  "schema": {
1357
- "$ref": "#/components/schemas/Envelope_HelpdeskReplyCreateResult"
1357
+ "$ref": "#/components/schemas/ApiResponse_HelpdeskReplyCreateResult"
1358
1358
  }
1359
1359
  }
1360
1360
  }
@@ -1378,7 +1378,7 @@
1378
1378
  "content": {
1379
1379
  "application/json": {
1380
1380
  "schema": {
1381
- "$ref": "#/components/schemas/Envelope_WebhookEndpointArray"
1381
+ "$ref": "#/components/schemas/ApiResponse_WebhookEndpointArray"
1382
1382
  }
1383
1383
  }
1384
1384
  }
@@ -1411,7 +1411,7 @@
1411
1411
  "content": {
1412
1412
  "application/json": {
1413
1413
  "schema": {
1414
- "$ref": "#/components/schemas/Envelope_WebhookEndpoint"
1414
+ "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
1415
1415
  }
1416
1416
  }
1417
1417
  }
@@ -1440,7 +1440,7 @@
1440
1440
  "content": {
1441
1441
  "application/json": {
1442
1442
  "schema": {
1443
- "$ref": "#/components/schemas/Envelope_WebhookEndpoint"
1443
+ "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
1444
1444
  }
1445
1445
  }
1446
1446
  }
@@ -1473,7 +1473,7 @@
1473
1473
  "content": {
1474
1474
  "application/json": {
1475
1475
  "schema": {
1476
- "$ref": "#/components/schemas/Envelope_WebhookEndpoint"
1476
+ "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
1477
1477
  }
1478
1478
  }
1479
1479
  }
@@ -1496,7 +1496,7 @@
1496
1496
  "content": {
1497
1497
  "application/json": {
1498
1498
  "schema": {
1499
- "$ref": "#/components/schemas/Envelope_WebhookDeleteResult"
1499
+ "$ref": "#/components/schemas/ApiResponse_WebhookDeleteResult"
1500
1500
  }
1501
1501
  }
1502
1502
  }
@@ -1536,7 +1536,7 @@
1536
1536
  "content": {
1537
1537
  "application/json": {
1538
1538
  "schema": {
1539
- "$ref": "#/components/schemas/Envelope_WebhookDeliveryArray"
1539
+ "$ref": "#/components/schemas/ApiResponse_WebhookDeliveryArray"
1540
1540
  }
1541
1541
  }
1542
1542
  }
@@ -1566,7 +1566,7 @@
1566
1566
  "content": {
1567
1567
  "application/json": {
1568
1568
  "schema": {
1569
- "$ref": "#/components/schemas/Envelope_WebhookTestResult"
1569
+ "$ref": "#/components/schemas/ApiResponse_WebhookTestResult"
1570
1570
  }
1571
1571
  }
1572
1572
  }
@@ -2040,6 +2040,17 @@
2040
2040
  },
2041
2041
  "contact_id": {
2042
2042
  "type": "string"
2043
+ },
2044
+ "idempotency_key": {
2045
+ "type": "string"
2046
+ },
2047
+ "copy_to": {
2048
+ "type": "string",
2049
+ "format": "email"
2050
+ },
2051
+ "copy_reply_to": {
2052
+ "type": "string",
2053
+ "format": "email"
2043
2054
  }
2044
2055
  }
2045
2056
  },
@@ -2047,11 +2058,30 @@
2047
2058
  "type": "object",
2048
2059
  "required": [
2049
2060
  "id",
2061
+ "copy_id",
2062
+ "contact_id",
2050
2063
  "status"
2051
2064
  ],
2052
2065
  "properties": {
2053
2066
  "id": {
2054
- "type": "string"
2067
+ "type": [
2068
+ "string",
2069
+ "null"
2070
+ ],
2071
+ "description": "Email send id — poll GET /api/v1/emails/{id} with it."
2072
+ },
2073
+ "copy_id": {
2074
+ "type": [
2075
+ "string",
2076
+ "null"
2077
+ ],
2078
+ "description": "Send id of the copy_to copy, or null when no copy was requested."
2079
+ },
2080
+ "contact_id": {
2081
+ "type": [
2082
+ "string",
2083
+ "null"
2084
+ ]
2055
2085
  },
2056
2086
  "status": {
2057
2087
  "type": "string"
@@ -2202,7 +2232,8 @@
2202
2232
  "batch_id",
2203
2233
  "total",
2204
2234
  "queued",
2205
- "failed"
2235
+ "failed",
2236
+ "results"
2206
2237
  ],
2207
2238
  "properties": {
2208
2239
  "batch_id": {
@@ -2216,6 +2247,49 @@
2216
2247
  },
2217
2248
  "failed": {
2218
2249
  "type": "integer"
2250
+ },
2251
+ "results": {
2252
+ "type": "array",
2253
+ "description": "Per-recipient outcome, in request order.",
2254
+ "items": {
2255
+ "$ref": "#/components/schemas/BatchSendRecipientResult"
2256
+ }
2257
+ }
2258
+ }
2259
+ },
2260
+ "BatchSendRecipientResult": {
2261
+ "type": "object",
2262
+ "required": [
2263
+ "email",
2264
+ "id",
2265
+ "status",
2266
+ "error"
2267
+ ],
2268
+ "properties": {
2269
+ "email": {
2270
+ "type": "string",
2271
+ "format": "email"
2272
+ },
2273
+ "id": {
2274
+ "type": [
2275
+ "string",
2276
+ "null"
2277
+ ],
2278
+ "description": "Email send id — poll GET /api/v1/emails/{id} with it. Null when not queued."
2279
+ },
2280
+ "status": {
2281
+ "type": "string",
2282
+ "enum": [
2283
+ "queued",
2284
+ "failed"
2285
+ ]
2286
+ },
2287
+ "error": {
2288
+ "type": [
2289
+ "string",
2290
+ "null"
2291
+ ],
2292
+ "description": "Failure reason for recipients that were not queued."
2219
2293
  }
2220
2294
  }
2221
2295
  },