@pidgeon-ai/sdk 1.33.0 → 1.35.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/CHANGELOG.md +22 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +50 -22
- package/dist/index.d.ts +50 -22
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -437,6 +437,10 @@ type Identity = {
|
|
|
437
437
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
438
438
|
*/
|
|
439
439
|
pod_id: string;
|
|
440
|
+
/**
|
|
441
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
442
|
+
*/
|
|
443
|
+
test: boolean;
|
|
440
444
|
};
|
|
441
445
|
type Message = {
|
|
442
446
|
id: string;
|
|
@@ -1516,9 +1520,9 @@ type ApiKeyCreated = {
|
|
|
1516
1520
|
*/
|
|
1517
1521
|
previous_token_expires_at: string | null;
|
|
1518
1522
|
/**
|
|
1519
|
-
* The secret. Shown once, here, and never again.
|
|
1523
|
+
* The secret. Shown once, here, and never again. Null on an `Idempotency-Key` replay of a mint (`Idempotent-Replay: true`): the secret is never stored, so rotate the key (`POST /api-keys/{id}/rotate`), or revoke it and mint again.
|
|
1520
1524
|
*/
|
|
1521
|
-
token: string;
|
|
1525
|
+
token: string | null;
|
|
1522
1526
|
};
|
|
1523
1527
|
type AppPassword = {
|
|
1524
1528
|
id: string;
|
|
@@ -1571,6 +1575,18 @@ type Me = {
|
|
|
1571
1575
|
* ISO-8601, UTC.
|
|
1572
1576
|
*/
|
|
1573
1577
|
created_at: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* A test-mode key (`pgn_test_`): its mail never leaves Pidgeon and counts against nothing. Read this rather than the token’s prefix.
|
|
1580
|
+
*/
|
|
1581
|
+
test: boolean;
|
|
1582
|
+
/**
|
|
1583
|
+
* When the key was last given a new secret by `POST /api-keys/{id}/rotate`, or null.
|
|
1584
|
+
*/
|
|
1585
|
+
rotated_at: string | null;
|
|
1586
|
+
/**
|
|
1587
|
+
* While the secret it had before its last rotation still works, when that stops. Null when it has stopped or there was no grace period.
|
|
1588
|
+
*/
|
|
1589
|
+
previous_token_expires_at: string | null;
|
|
1574
1590
|
} | null;
|
|
1575
1591
|
workspace: {
|
|
1576
1592
|
id: string;
|
|
@@ -1913,6 +1929,10 @@ type PodCreated = {
|
|
|
1913
1929
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
1914
1930
|
*/
|
|
1915
1931
|
pod_id: string;
|
|
1932
|
+
/**
|
|
1933
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
1934
|
+
*/
|
|
1935
|
+
test: boolean;
|
|
1916
1936
|
} | null;
|
|
1917
1937
|
/**
|
|
1918
1938
|
* A pod key for it, or null when the call asked for none.
|
|
@@ -2372,7 +2392,7 @@ type IdentitiesCreateErrors = {
|
|
|
2372
2392
|
*/
|
|
2373
2393
|
404: Error;
|
|
2374
2394
|
/**
|
|
2375
|
-
*
|
|
2395
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
2376
2396
|
*/
|
|
2377
2397
|
409: Error;
|
|
2378
2398
|
/**
|
|
@@ -3257,7 +3277,7 @@ type PodsCreateErrors = {
|
|
|
3257
3277
|
*/
|
|
3258
3278
|
404: Error;
|
|
3259
3279
|
/**
|
|
3260
|
-
*
|
|
3280
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
3261
3281
|
*/
|
|
3262
3282
|
409: Error;
|
|
3263
3283
|
/**
|
|
@@ -3548,7 +3568,7 @@ type LabelsCreateErrors = {
|
|
|
3548
3568
|
*/
|
|
3549
3569
|
404: Error;
|
|
3550
3570
|
/**
|
|
3551
|
-
*
|
|
3571
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
3552
3572
|
*/
|
|
3553
3573
|
409: Error;
|
|
3554
3574
|
/**
|
|
@@ -4002,7 +4022,7 @@ type MessagesSendErrors = {
|
|
|
4002
4022
|
*/
|
|
4003
4023
|
404: Error;
|
|
4004
4024
|
/**
|
|
4005
|
-
*
|
|
4025
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4006
4026
|
*/
|
|
4007
4027
|
409: Error;
|
|
4008
4028
|
/**
|
|
@@ -4458,7 +4478,7 @@ type MessagesReplyErrors = {
|
|
|
4458
4478
|
*/
|
|
4459
4479
|
404: Error;
|
|
4460
4480
|
/**
|
|
4461
|
-
*
|
|
4481
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4462
4482
|
*/
|
|
4463
4483
|
409: Error;
|
|
4464
4484
|
/**
|
|
@@ -4558,7 +4578,7 @@ type MessagesReplyAllErrors = {
|
|
|
4558
4578
|
*/
|
|
4559
4579
|
404: Error;
|
|
4560
4580
|
/**
|
|
4561
|
-
*
|
|
4581
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4562
4582
|
*/
|
|
4563
4583
|
409: Error;
|
|
4564
4584
|
/**
|
|
@@ -4658,7 +4678,7 @@ type MessagesForwardErrors = {
|
|
|
4658
4678
|
*/
|
|
4659
4679
|
404: Error;
|
|
4660
4680
|
/**
|
|
4661
|
-
*
|
|
4681
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4662
4682
|
*/
|
|
4663
4683
|
409: Error;
|
|
4664
4684
|
/**
|
|
@@ -5066,7 +5086,7 @@ type DomainsCreateErrors = {
|
|
|
5066
5086
|
*/
|
|
5067
5087
|
404: Error;
|
|
5068
5088
|
/**
|
|
5069
|
-
*
|
|
5089
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
5070
5090
|
*/
|
|
5071
5091
|
409: Error;
|
|
5072
5092
|
/**
|
|
@@ -5521,7 +5541,7 @@ type RoutingCreateErrors = {
|
|
|
5521
5541
|
*/
|
|
5522
5542
|
404: Error;
|
|
5523
5543
|
/**
|
|
5524
|
-
*
|
|
5544
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
5525
5545
|
*/
|
|
5526
5546
|
409: Error;
|
|
5527
5547
|
/**
|
|
@@ -5994,6 +6014,12 @@ type KeysCreateData = {
|
|
|
5994
6014
|
*/
|
|
5995
6015
|
test?: boolean;
|
|
5996
6016
|
};
|
|
6017
|
+
headers?: {
|
|
6018
|
+
/**
|
|
6019
|
+
* Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
|
|
6020
|
+
*/
|
|
6021
|
+
'Idempotency-Key'?: string;
|
|
6022
|
+
};
|
|
5997
6023
|
path?: never;
|
|
5998
6024
|
query?: never;
|
|
5999
6025
|
url: '/api-keys';
|
|
@@ -6020,7 +6046,7 @@ type KeysCreateErrors = {
|
|
|
6020
6046
|
*/
|
|
6021
6047
|
404: Error;
|
|
6022
6048
|
/**
|
|
6023
|
-
*
|
|
6049
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
6024
6050
|
*/
|
|
6025
6051
|
409: Error;
|
|
6026
6052
|
/**
|
|
@@ -6335,7 +6361,7 @@ type TestInboundErrors = {
|
|
|
6335
6361
|
*/
|
|
6336
6362
|
404: Error;
|
|
6337
6363
|
/**
|
|
6338
|
-
*
|
|
6364
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
6339
6365
|
*/
|
|
6340
6366
|
409: Error;
|
|
6341
6367
|
/**
|
|
@@ -7017,7 +7043,7 @@ type WebhooksCreateErrors = {
|
|
|
7017
7043
|
*/
|
|
7018
7044
|
404: Error;
|
|
7019
7045
|
/**
|
|
7020
|
-
*
|
|
7046
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7021
7047
|
*/
|
|
7022
7048
|
409: Error;
|
|
7023
7049
|
/**
|
|
@@ -7458,7 +7484,7 @@ type MessagesRespondToInvitationErrors = {
|
|
|
7458
7484
|
*/
|
|
7459
7485
|
404: Error;
|
|
7460
7486
|
/**
|
|
7461
|
-
*
|
|
7487
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7462
7488
|
*/
|
|
7463
7489
|
409: Error;
|
|
7464
7490
|
/**
|
|
@@ -7729,7 +7755,7 @@ type CalendarCreateEventErrors = {
|
|
|
7729
7755
|
*/
|
|
7730
7756
|
404: Error;
|
|
7731
7757
|
/**
|
|
7732
|
-
*
|
|
7758
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7733
7759
|
*/
|
|
7734
7760
|
409: Error;
|
|
7735
7761
|
/**
|
|
@@ -7800,7 +7826,7 @@ type CalendarRespondToEventErrors = {
|
|
|
7800
7826
|
*/
|
|
7801
7827
|
404: Error;
|
|
7802
7828
|
/**
|
|
7803
|
-
*
|
|
7829
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7804
7830
|
*/
|
|
7805
7831
|
409: Error;
|
|
7806
7832
|
/**
|
|
@@ -8004,7 +8030,7 @@ type CalendarDeleteEventErrors = {
|
|
|
8004
8030
|
*/
|
|
8005
8031
|
404: Error;
|
|
8006
8032
|
/**
|
|
8007
|
-
*
|
|
8033
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8008
8034
|
*/
|
|
8009
8035
|
409: Error;
|
|
8010
8036
|
/**
|
|
@@ -8162,7 +8188,7 @@ type CalendarUpdateEventErrors = {
|
|
|
8162
8188
|
*/
|
|
8163
8189
|
404: Error;
|
|
8164
8190
|
/**
|
|
8165
|
-
*
|
|
8191
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8166
8192
|
*/
|
|
8167
8193
|
409: Error;
|
|
8168
8194
|
/**
|
|
@@ -8338,7 +8364,7 @@ type DraftsCreateErrors = {
|
|
|
8338
8364
|
*/
|
|
8339
8365
|
404: Error;
|
|
8340
8366
|
/**
|
|
8341
|
-
*
|
|
8367
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8342
8368
|
*/
|
|
8343
8369
|
409: Error;
|
|
8344
8370
|
/**
|
|
@@ -8598,7 +8624,7 @@ type DraftsSendErrors = {
|
|
|
8598
8624
|
*/
|
|
8599
8625
|
404: Error;
|
|
8600
8626
|
/**
|
|
8601
|
-
*
|
|
8627
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8602
8628
|
*/
|
|
8603
8629
|
409: Error;
|
|
8604
8630
|
/**
|
|
@@ -8714,7 +8740,7 @@ type DraftsScheduleErrors = {
|
|
|
8714
8740
|
*/
|
|
8715
8741
|
404: Error;
|
|
8716
8742
|
/**
|
|
8717
|
-
*
|
|
8743
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8718
8744
|
*/
|
|
8719
8745
|
409: Error;
|
|
8720
8746
|
/**
|
|
@@ -9052,6 +9078,8 @@ declare const identitiesList: <ThrowOnError extends boolean = false>(options?: O
|
|
|
9052
9078
|
* Create an address
|
|
9053
9079
|
*
|
|
9054
9080
|
* Idempotent with an `Idempotency-Key` header: the same key returns the first result rather than creating a second address.
|
|
9081
|
+
*
|
|
9082
|
+
* Needs a key with admin over the account, or over its pod. A **test key** creates a test address (`test: true`): outside your plan’s counts, at most 100 at once, taking only test mail, and deleted a day after it was made.
|
|
9055
9083
|
*/
|
|
9056
9084
|
declare const identitiesCreate: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCreateData, ThrowOnError>) => RequestResult<IdentitiesCreateResponses, IdentitiesCreateErrors, ThrowOnError>;
|
|
9057
9085
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -437,6 +437,10 @@ type Identity = {
|
|
|
437
437
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
438
438
|
*/
|
|
439
439
|
pod_id: string;
|
|
440
|
+
/**
|
|
441
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
442
|
+
*/
|
|
443
|
+
test: boolean;
|
|
440
444
|
};
|
|
441
445
|
type Message = {
|
|
442
446
|
id: string;
|
|
@@ -1516,9 +1520,9 @@ type ApiKeyCreated = {
|
|
|
1516
1520
|
*/
|
|
1517
1521
|
previous_token_expires_at: string | null;
|
|
1518
1522
|
/**
|
|
1519
|
-
* The secret. Shown once, here, and never again.
|
|
1523
|
+
* The secret. Shown once, here, and never again. Null on an `Idempotency-Key` replay of a mint (`Idempotent-Replay: true`): the secret is never stored, so rotate the key (`POST /api-keys/{id}/rotate`), or revoke it and mint again.
|
|
1520
1524
|
*/
|
|
1521
|
-
token: string;
|
|
1525
|
+
token: string | null;
|
|
1522
1526
|
};
|
|
1523
1527
|
type AppPassword = {
|
|
1524
1528
|
id: string;
|
|
@@ -1571,6 +1575,18 @@ type Me = {
|
|
|
1571
1575
|
* ISO-8601, UTC.
|
|
1572
1576
|
*/
|
|
1573
1577
|
created_at: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* A test-mode key (`pgn_test_`): its mail never leaves Pidgeon and counts against nothing. Read this rather than the token’s prefix.
|
|
1580
|
+
*/
|
|
1581
|
+
test: boolean;
|
|
1582
|
+
/**
|
|
1583
|
+
* When the key was last given a new secret by `POST /api-keys/{id}/rotate`, or null.
|
|
1584
|
+
*/
|
|
1585
|
+
rotated_at: string | null;
|
|
1586
|
+
/**
|
|
1587
|
+
* While the secret it had before its last rotation still works, when that stops. Null when it has stopped or there was no grace period.
|
|
1588
|
+
*/
|
|
1589
|
+
previous_token_expires_at: string | null;
|
|
1574
1590
|
} | null;
|
|
1575
1591
|
workspace: {
|
|
1576
1592
|
id: string;
|
|
@@ -1913,6 +1929,10 @@ type PodCreated = {
|
|
|
1913
1929
|
* The pod this address is in. Every workspace has one to start with and every address is in one, so this is never null.
|
|
1914
1930
|
*/
|
|
1915
1931
|
pod_id: string;
|
|
1932
|
+
/**
|
|
1933
|
+
* A test address, made by a test key: it counts against no plan, takes only test mail (a test send or `POST /test/inbound`), and is deleted a day after it was made.
|
|
1934
|
+
*/
|
|
1935
|
+
test: boolean;
|
|
1916
1936
|
} | null;
|
|
1917
1937
|
/**
|
|
1918
1938
|
* A pod key for it, or null when the call asked for none.
|
|
@@ -2372,7 +2392,7 @@ type IdentitiesCreateErrors = {
|
|
|
2372
2392
|
*/
|
|
2373
2393
|
404: Error;
|
|
2374
2394
|
/**
|
|
2375
|
-
*
|
|
2395
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
2376
2396
|
*/
|
|
2377
2397
|
409: Error;
|
|
2378
2398
|
/**
|
|
@@ -3257,7 +3277,7 @@ type PodsCreateErrors = {
|
|
|
3257
3277
|
*/
|
|
3258
3278
|
404: Error;
|
|
3259
3279
|
/**
|
|
3260
|
-
*
|
|
3280
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
3261
3281
|
*/
|
|
3262
3282
|
409: Error;
|
|
3263
3283
|
/**
|
|
@@ -3548,7 +3568,7 @@ type LabelsCreateErrors = {
|
|
|
3548
3568
|
*/
|
|
3549
3569
|
404: Error;
|
|
3550
3570
|
/**
|
|
3551
|
-
*
|
|
3571
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
3552
3572
|
*/
|
|
3553
3573
|
409: Error;
|
|
3554
3574
|
/**
|
|
@@ -4002,7 +4022,7 @@ type MessagesSendErrors = {
|
|
|
4002
4022
|
*/
|
|
4003
4023
|
404: Error;
|
|
4004
4024
|
/**
|
|
4005
|
-
*
|
|
4025
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4006
4026
|
*/
|
|
4007
4027
|
409: Error;
|
|
4008
4028
|
/**
|
|
@@ -4458,7 +4478,7 @@ type MessagesReplyErrors = {
|
|
|
4458
4478
|
*/
|
|
4459
4479
|
404: Error;
|
|
4460
4480
|
/**
|
|
4461
|
-
*
|
|
4481
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4462
4482
|
*/
|
|
4463
4483
|
409: Error;
|
|
4464
4484
|
/**
|
|
@@ -4558,7 +4578,7 @@ type MessagesReplyAllErrors = {
|
|
|
4558
4578
|
*/
|
|
4559
4579
|
404: Error;
|
|
4560
4580
|
/**
|
|
4561
|
-
*
|
|
4581
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4562
4582
|
*/
|
|
4563
4583
|
409: Error;
|
|
4564
4584
|
/**
|
|
@@ -4658,7 +4678,7 @@ type MessagesForwardErrors = {
|
|
|
4658
4678
|
*/
|
|
4659
4679
|
404: Error;
|
|
4660
4680
|
/**
|
|
4661
|
-
*
|
|
4681
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
4662
4682
|
*/
|
|
4663
4683
|
409: Error;
|
|
4664
4684
|
/**
|
|
@@ -5066,7 +5086,7 @@ type DomainsCreateErrors = {
|
|
|
5066
5086
|
*/
|
|
5067
5087
|
404: Error;
|
|
5068
5088
|
/**
|
|
5069
|
-
*
|
|
5089
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
5070
5090
|
*/
|
|
5071
5091
|
409: Error;
|
|
5072
5092
|
/**
|
|
@@ -5521,7 +5541,7 @@ type RoutingCreateErrors = {
|
|
|
5521
5541
|
*/
|
|
5522
5542
|
404: Error;
|
|
5523
5543
|
/**
|
|
5524
|
-
*
|
|
5544
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
5525
5545
|
*/
|
|
5526
5546
|
409: Error;
|
|
5527
5547
|
/**
|
|
@@ -5994,6 +6014,12 @@ type KeysCreateData = {
|
|
|
5994
6014
|
*/
|
|
5995
6015
|
test?: boolean;
|
|
5996
6016
|
};
|
|
6017
|
+
headers?: {
|
|
6018
|
+
/**
|
|
6019
|
+
* Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing — no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.
|
|
6020
|
+
*/
|
|
6021
|
+
'Idempotency-Key'?: string;
|
|
6022
|
+
};
|
|
5997
6023
|
path?: never;
|
|
5998
6024
|
query?: never;
|
|
5999
6025
|
url: '/api-keys';
|
|
@@ -6020,7 +6046,7 @@ type KeysCreateErrors = {
|
|
|
6020
6046
|
*/
|
|
6021
6047
|
404: Error;
|
|
6022
6048
|
/**
|
|
6023
|
-
*
|
|
6049
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
6024
6050
|
*/
|
|
6025
6051
|
409: Error;
|
|
6026
6052
|
/**
|
|
@@ -6335,7 +6361,7 @@ type TestInboundErrors = {
|
|
|
6335
6361
|
*/
|
|
6336
6362
|
404: Error;
|
|
6337
6363
|
/**
|
|
6338
|
-
*
|
|
6364
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
6339
6365
|
*/
|
|
6340
6366
|
409: Error;
|
|
6341
6367
|
/**
|
|
@@ -7017,7 +7043,7 @@ type WebhooksCreateErrors = {
|
|
|
7017
7043
|
*/
|
|
7018
7044
|
404: Error;
|
|
7019
7045
|
/**
|
|
7020
|
-
*
|
|
7046
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7021
7047
|
*/
|
|
7022
7048
|
409: Error;
|
|
7023
7049
|
/**
|
|
@@ -7458,7 +7484,7 @@ type MessagesRespondToInvitationErrors = {
|
|
|
7458
7484
|
*/
|
|
7459
7485
|
404: Error;
|
|
7460
7486
|
/**
|
|
7461
|
-
*
|
|
7487
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7462
7488
|
*/
|
|
7463
7489
|
409: Error;
|
|
7464
7490
|
/**
|
|
@@ -7729,7 +7755,7 @@ type CalendarCreateEventErrors = {
|
|
|
7729
7755
|
*/
|
|
7730
7756
|
404: Error;
|
|
7731
7757
|
/**
|
|
7732
|
-
*
|
|
7758
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7733
7759
|
*/
|
|
7734
7760
|
409: Error;
|
|
7735
7761
|
/**
|
|
@@ -7800,7 +7826,7 @@ type CalendarRespondToEventErrors = {
|
|
|
7800
7826
|
*/
|
|
7801
7827
|
404: Error;
|
|
7802
7828
|
/**
|
|
7803
|
-
*
|
|
7829
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
7804
7830
|
*/
|
|
7805
7831
|
409: Error;
|
|
7806
7832
|
/**
|
|
@@ -8004,7 +8030,7 @@ type CalendarDeleteEventErrors = {
|
|
|
8004
8030
|
*/
|
|
8005
8031
|
404: Error;
|
|
8006
8032
|
/**
|
|
8007
|
-
*
|
|
8033
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8008
8034
|
*/
|
|
8009
8035
|
409: Error;
|
|
8010
8036
|
/**
|
|
@@ -8162,7 +8188,7 @@ type CalendarUpdateEventErrors = {
|
|
|
8162
8188
|
*/
|
|
8163
8189
|
404: Error;
|
|
8164
8190
|
/**
|
|
8165
|
-
*
|
|
8191
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8166
8192
|
*/
|
|
8167
8193
|
409: Error;
|
|
8168
8194
|
/**
|
|
@@ -8338,7 +8364,7 @@ type DraftsCreateErrors = {
|
|
|
8338
8364
|
*/
|
|
8339
8365
|
404: Error;
|
|
8340
8366
|
/**
|
|
8341
|
-
*
|
|
8367
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8342
8368
|
*/
|
|
8343
8369
|
409: Error;
|
|
8344
8370
|
/**
|
|
@@ -8598,7 +8624,7 @@ type DraftsSendErrors = {
|
|
|
8598
8624
|
*/
|
|
8599
8625
|
404: Error;
|
|
8600
8626
|
/**
|
|
8601
|
-
*
|
|
8627
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8602
8628
|
*/
|
|
8603
8629
|
409: Error;
|
|
8604
8630
|
/**
|
|
@@ -8714,7 +8740,7 @@ type DraftsScheduleErrors = {
|
|
|
8714
8740
|
*/
|
|
8715
8741
|
404: Error;
|
|
8716
8742
|
/**
|
|
8717
|
-
*
|
|
8743
|
+
* Nothing was done by this call. `error.code` says which: `idempotency_in_progress` when the first request with this `Idempotency-Key` has not answered yet (wait `Retry-After` seconds and send it again), `idempotency_mismatch` when the key was used with a different request (use a new key).
|
|
8718
8744
|
*/
|
|
8719
8745
|
409: Error;
|
|
8720
8746
|
/**
|
|
@@ -9052,6 +9078,8 @@ declare const identitiesList: <ThrowOnError extends boolean = false>(options?: O
|
|
|
9052
9078
|
* Create an address
|
|
9053
9079
|
*
|
|
9054
9080
|
* Idempotent with an `Idempotency-Key` header: the same key returns the first result rather than creating a second address.
|
|
9081
|
+
*
|
|
9082
|
+
* Needs a key with admin over the account, or over its pod. A **test key** creates a test address (`test: true`): outside your plan’s counts, at most 100 at once, taking only test mail, and deleted a day after it was made.
|
|
9055
9083
|
*/
|
|
9056
9084
|
declare const identitiesCreate: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCreateData, ThrowOnError>) => RequestResult<IdentitiesCreateResponses, IdentitiesCreateErrors, ThrowOnError>;
|
|
9057
9085
|
/**
|