@checkdigit/eslint-plugin 7.18.0-PR.143-072f → 7.18.0-PR.143-518d

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 (21) hide show
  1. package/dist-mjs/openapi/generate-schema.mjs +7 -1
  2. package/package.json +1 -1
  3. package/src/openapi/generate-schema.ts +6 -0
  4. package/src/services/interchange/v1/swagger.schema.deref.json +1 -75
  5. package/src/services/interchange/v1/swagger.schema.json +1 -51
  6. package/src/services/ledger/v1/swagger.schema.deref.json +49 -2610
  7. package/src/services/ledger/v1/swagger.schema.json +106 -878
  8. package/src/services/link/v1/swagger.schema.deref.json +3 -426
  9. package/src/services/link/v1/swagger.schema.json +3 -261
  10. package/src/services/message/v1/swagger.schema.deref.json +1669 -8447
  11. package/src/services/message/v1/swagger.schema.json +5 -531
  12. package/src/services/message/v2/swagger.schema.deref.json +5125 -27716
  13. package/src/services/message/v2/swagger.schema.json +5 -523
  14. package/src/services/paymentCard/v1/swagger.schema.deref.json +36 -1185
  15. package/src/services/paymentCard/v1/swagger.schema.json +5 -499
  16. package/src/services/paymentCard/v2/swagger.schema.deref.json +60 -1186
  17. package/src/services/paymentCard/v2/swagger.schema.json +5 -511
  18. package/src/services/person/v1/swagger.schema.deref.json +510 -2348
  19. package/src/services/person/v1/swagger.schema.json +4 -470
  20. package/src/services/teampayClientManagement/v1/swagger.schema.deref.json +155 -1254
  21. package/src/services/teampayClientManagement/v1/swagger.schema.json +3 -369
package/src/services/ledger/v1/swagger.schema.deref.json CHANGED
@@ -1,436 +1,7 @@
1
1
  {
2
2
  "apis": {
3
- "/ledger/v1/ping": {
4
- "get": {
5
- "request": {
6
- "$schema": "https://json-schema.org/draft/2020-12/schema",
7
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/PingGetRequestContext",
8
- "type": "object",
9
- "properties": {
10
- "headers": {
11
- "type": "object",
12
- "additionalProperties": true
13
- }
14
- },
15
- "required": [],
16
- "additionalProperties": false
17
- },
18
- "responses": {
19
- "200": {
20
- "$schema": "https://json-schema.org/draft/2020-12/schema",
21
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/PingGetResponseOK",
22
- "type": "object",
23
- "properties": {
24
- "headers": {
25
- "type": "object",
26
- "additionalProperties": true
27
- },
28
- "body": {
29
- "$schema": "https://json-schema.org/draft/2020-12/schema",
30
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Ping",
31
- "type": "object",
32
- "additionalProperties": false,
33
- "required": ["serverTime"],
34
- "properties": {
35
- "serverTime": {
36
- "type": "string",
37
- "format": "date-time",
38
- "description": "Current server time."
39
- }
40
- }
41
- }
42
- },
43
- "required": ["body"],
44
- "additionalProperties": false
45
- },
46
- "default": {
47
- "$schema": "https://json-schema.org/draft/2020-12/schema",
48
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/PingGetResponseDefault",
49
- "type": "object",
50
- "properties": {
51
- "headers": {
52
- "type": "object",
53
- "additionalProperties": true
54
- },
55
- "body": {
56
- "$schema": "https://json-schema.org/draft/2020-12/schema",
57
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
58
- "type": "object",
59
- "additionalProperties": false,
60
- "description": "Error message.",
61
- "required": ["code"],
62
- "properties": {
63
- "message": {
64
- "type": "string"
65
- },
66
- "code": {
67
- "type": "string",
68
- "enum": [
69
- "INVALID_AT",
70
- "INVALID_FROM",
71
- "INVALID_TO",
72
- "INVALID_CREATED_ON",
73
- "INVALID_LAST_MODIFIED",
74
- "INVALID_IF_MATCH",
75
- "FROM_GREATER_THAN_TO",
76
- "ACCOUNT_NOT_FOUND",
77
- "POSTING_AMOUNT_NOT_AN_INTEGER",
78
- "ACCOUNT_MULTIPLE_POSTINGS",
79
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
80
- "POSTING_WITH_ZERO_AMOUNT",
81
- "POSTING_WITH_NEGATIVE_AMOUNT",
82
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
83
- "NO_POSTINGS",
84
- "INSUFFICIENT_POSTINGS",
85
- "UNEQUAL_CREDIT_DEBIT",
86
- "VERSION_BALANCE_MISMATCH",
87
- "VERSION_MISMATCH",
88
- "CURRENCY_MISMATCH",
89
- "UNHANDLED_ERROR"
90
- ]
91
- }
92
- }
93
- }
94
- },
95
- "required": ["body"],
96
- "additionalProperties": false
97
- }
98
- }
99
- }
100
- },
3
+ "/ledger/v1/ping": {},
101
4
  "/ledger/v1/account/:accountId": {
102
- "get": {
103
- "request": {
104
- "$schema": "https://json-schema.org/draft/2020-12/schema",
105
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetRequestContext",
106
- "type": "object",
107
- "properties": {
108
- "params": {
109
- "type": "object",
110
- "additionalProperties": false,
111
- "properties": {
112
- "at": {
113
- "type": "string",
114
- "format": "date-time"
115
- }
116
- },
117
- "required": ["at"]
118
- },
119
- "headers": {
120
- "type": "object",
121
- "additionalProperties": true
122
- }
123
- },
124
- "required": ["params", "query"],
125
- "additionalProperties": false
126
- },
127
- "responses": {
128
- "200": {
129
- "$schema": "https://json-schema.org/draft/2020-12/schema",
130
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetResponseOK",
131
- "type": "object",
132
- "properties": {
133
- "headers": {
134
- "type": "object",
135
- "properties": {
136
- "created-on": {
137
- "type": "string",
138
- "format": "date-time"
139
- },
140
- "updated-on": {
141
- "type": "string",
142
- "format": "date-time"
143
- },
144
- "last-modified": {
145
- "type": "string",
146
- "format": "date-time"
147
- }
148
- },
149
- "required": ["created-on", "updated-on", "last-modified"]
150
- },
151
- "body": {
152
- "$schema": "https://json-schema.org/draft/2020-12/schema",
153
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Account",
154
- "type": "object",
155
- "additionalProperties": false,
156
- "required": ["accountId", "createdOn", "currency", "type"],
157
- "properties": {
158
- "accountId": {
159
- "type": "string",
160
- "description": "Account ID"
161
- },
162
- "createdOn": {
163
- "type": "string",
164
- "format": "date-time",
165
- "description": "Account creation date/time."
166
- },
167
- "currency": {
168
- "$schema": "https://json-schema.org/draft/2020-12/schema",
169
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Currency",
170
- "type": "string",
171
- "enum": [
172
- "AED",
173
- "AFN",
174
- "ALL",
175
- "AMD",
176
- "ANG",
177
- "AOA",
178
- "ARS",
179
- "AUD",
180
- "AWG",
181
- "AZN",
182
- "BAM",
183
- "BBD",
184
- "BDT",
185
- "BGN",
186
- "BHD",
187
- "BIF",
188
- "BMD",
189
- "BND",
190
- "BOB",
191
- "BOV",
192
- "BRL",
193
- "BSD",
194
- "BTN",
195
- "BWP",
196
- "BYN",
197
- "BZD",
198
- "CAD",
199
- "CDF",
200
- "CHE",
201
- "CHF",
202
- "CHW",
203
- "CLF",
204
- "CLP",
205
- "CNY",
206
- "COP",
207
- "COU",
208
- "CRC",
209
- "CUC",
210
- "CUP",
211
- "CVE",
212
- "CZK",
213
- "DJF",
214
- "DKK",
215
- "DOP",
216
- "DZD",
217
- "EGP",
218
- "ERN",
219
- "ETB",
220
- "EUR",
221
- "FJD",
222
- "FKP",
223
- "GBP",
224
- "GEL",
225
- "GHS",
226
- "GIP",
227
- "GMD",
228
- "GNF",
229
- "GTQ",
230
- "GYD",
231
- "HKD",
232
- "HNL",
233
- "HRK",
234
- "HTG",
235
- "HUF",
236
- "IDR",
237
- "ILS",
238
- "INR",
239
- "IQD",
240
- "IRR",
241
- "ISK",
242
- "JMD",
243
- "JOD",
244
- "JPY",
245
- "KES",
246
- "KGS",
247
- "KHR",
248
- "KMF",
249
- "KPW",
250
- "KRW",
251
- "KWD",
252
- "KYD",
253
- "KZT",
254
- "LAK",
255
- "LBP",
256
- "LKR",
257
- "LRD",
258
- "LSL",
259
- "LYD",
260
- "MAD",
261
- "MDL",
262
- "MGA",
263
- "MKD",
264
- "MMK",
265
- "MNT",
266
- "MOP",
267
- "MRU",
268
- "MUR",
269
- "MVR",
270
- "MWK",
271
- "MXN",
272
- "MXV",
273
- "MYR",
274
- "MZN",
275
- "NAD",
276
- "NGN",
277
- "NIO",
278
- "NOK",
279
- "NPR",
280
- "NZD",
281
- "OMR",
282
- "PAB",
283
- "PEN",
284
- "PGK",
285
- "PHP",
286
- "PKR",
287
- "PLN",
288
- "PYG",
289
- "QAR",
290
- "RON",
291
- "RSD",
292
- "RUB",
293
- "RWF",
294
- "SAR",
295
- "SBD",
296
- "SCR",
297
- "SDG",
298
- "SEK",
299
- "SGD",
300
- "SHP",
301
- "SLL",
302
- "SOS",
303
- "SRD",
304
- "SSP",
305
- "STN",
306
- "SVC",
307
- "SYP",
308
- "SZL",
309
- "THB",
310
- "TJS",
311
- "TMT",
312
- "TND",
313
- "TOP",
314
- "TRY",
315
- "TTD",
316
- "TWD",
317
- "TZS",
318
- "UAH",
319
- "UGX",
320
- "USD",
321
- "USN",
322
- "UYI",
323
- "UYU",
324
- "UYW",
325
- "UZS",
326
- "VES",
327
- "VND",
328
- "VUV",
329
- "WST",
330
- "XAF",
331
- "XAG",
332
- "XAU",
333
- "XBA",
334
- "XBB",
335
- "XBC",
336
- "XBD",
337
- "XCD",
338
- "XDR",
339
- "XOF",
340
- "XPD",
341
- "XPF",
342
- "XPT",
343
- "XSU",
344
- "XTS",
345
- "XUA",
346
- "XXX",
347
- "YER",
348
- "ZAR",
349
- "ZMW",
350
- "ZWL"
351
- ]
352
- },
353
- "name": {
354
- "type": "string",
355
- "description": "Account short name."
356
- },
357
- "type": {
358
- "type": "string",
359
- "enum": ["VERSIONED", "UNVERSIONED"]
360
- }
361
- }
362
- }
363
- },
364
- "required": ["headers", "body"],
365
- "additionalProperties": false
366
- },
367
- "404": {
368
- "$schema": "https://json-schema.org/draft/2020-12/schema",
369
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetResponseNotFound",
370
- "type": "object",
371
- "properties": {
372
- "headers": {
373
- "type": "object",
374
- "additionalProperties": true
375
- }
376
- },
377
- "required": [],
378
- "additionalProperties": false
379
- },
380
- "default": {
381
- "$schema": "https://json-schema.org/draft/2020-12/schema",
382
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetResponseDefault",
383
- "type": "object",
384
- "properties": {
385
- "headers": {
386
- "type": "object",
387
- "additionalProperties": true
388
- },
389
- "body": {
390
- "$schema": "https://json-schema.org/draft/2020-12/schema",
391
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
392
- "type": "object",
393
- "additionalProperties": false,
394
- "description": "Error message.",
395
- "required": ["code"],
396
- "properties": {
397
- "message": {
398
- "type": "string"
399
- },
400
- "code": {
401
- "type": "string",
402
- "enum": [
403
- "INVALID_AT",
404
- "INVALID_FROM",
405
- "INVALID_TO",
406
- "INVALID_CREATED_ON",
407
- "INVALID_LAST_MODIFIED",
408
- "INVALID_IF_MATCH",
409
- "FROM_GREATER_THAN_TO",
410
- "ACCOUNT_NOT_FOUND",
411
- "POSTING_AMOUNT_NOT_AN_INTEGER",
412
- "ACCOUNT_MULTIPLE_POSTINGS",
413
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
414
- "POSTING_WITH_ZERO_AMOUNT",
415
- "POSTING_WITH_NEGATIVE_AMOUNT",
416
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
417
- "NO_POSTINGS",
418
- "INSUFFICIENT_POSTINGS",
419
- "UNEQUAL_CREDIT_DEBIT",
420
- "VERSION_BALANCE_MISMATCH",
421
- "VERSION_MISMATCH",
422
- "CURRENCY_MISMATCH",
423
- "UNHANDLED_ERROR"
424
- ]
425
- }
426
- }
427
- }
428
- },
429
- "required": ["body"],
430
- "additionalProperties": false
431
- }
432
- }
433
- },
434
5
  "put": {
435
6
  "request": {
436
7
  "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -766,364 +337,32 @@
766
337
  }
767
338
  },
768
339
  "/ledger/v1/account/:accountId/:idFragment1": {
769
- "get": {
340
+ "put": {
770
341
  "request": {
771
342
  "$schema": "https://json-schema.org/draft/2020-12/schema",
772
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment1RequestContext",
343
+ "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountPutFragment1RequestContext",
773
344
  "type": "object",
774
345
  "properties": {
775
346
  "params": {
776
347
  "type": "object",
777
348
  "additionalProperties": false,
778
349
  "properties": {
779
- "at": {
780
- "type": "string",
781
- "format": "date-time"
350
+ "accountId": {
351
+ "type": "string"
352
+ },
353
+ "idFragment1": {
354
+ "type": "string"
782
355
  }
783
356
  },
784
- "required": ["at"]
357
+ "required": ["accountId", "idFragment1"]
785
358
  },
786
359
  "headers": {
787
360
  "type": "object",
788
- "additionalProperties": true
789
- }
790
- },
791
- "required": ["params", "query"],
792
- "additionalProperties": false
793
- },
794
- "responses": {
795
- "200": {
796
- "$schema": "https://json-schema.org/draft/2020-12/schema",
797
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment1ResponseOK",
798
- "type": "object",
799
- "properties": {
800
- "headers": {
801
- "type": "object",
802
- "properties": {
803
- "created-on": {
804
- "type": "string",
805
- "format": "date-time"
806
- },
807
- "updated-on": {
808
- "type": "string",
809
- "format": "date-time"
810
- },
811
- "last-modified": {
812
- "type": "string",
813
- "format": "date-time"
814
- }
815
- },
816
- "required": ["created-on", "updated-on", "last-modified"]
817
- },
818
- "body": {
819
- "$schema": "https://json-schema.org/draft/2020-12/schema",
820
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Account",
821
- "type": "object",
822
- "additionalProperties": false,
823
- "required": ["accountId", "createdOn", "currency", "type"],
824
- "properties": {
825
- "accountId": {
826
- "type": "string",
827
- "description": "Account ID"
828
- },
829
- "createdOn": {
830
- "type": "string",
831
- "format": "date-time",
832
- "description": "Account creation date/time."
833
- },
834
- "currency": {
835
- "$schema": "https://json-schema.org/draft/2020-12/schema",
836
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Currency",
837
- "type": "string",
838
- "enum": [
839
- "AED",
840
- "AFN",
841
- "ALL",
842
- "AMD",
843
- "ANG",
844
- "AOA",
845
- "ARS",
846
- "AUD",
847
- "AWG",
848
- "AZN",
849
- "BAM",
850
- "BBD",
851
- "BDT",
852
- "BGN",
853
- "BHD",
854
- "BIF",
855
- "BMD",
856
- "BND",
857
- "BOB",
858
- "BOV",
859
- "BRL",
860
- "BSD",
861
- "BTN",
862
- "BWP",
863
- "BYN",
864
- "BZD",
865
- "CAD",
866
- "CDF",
867
- "CHE",
868
- "CHF",
869
- "CHW",
870
- "CLF",
871
- "CLP",
872
- "CNY",
873
- "COP",
874
- "COU",
875
- "CRC",
876
- "CUC",
877
- "CUP",
878
- "CVE",
879
- "CZK",
880
- "DJF",
881
- "DKK",
882
- "DOP",
883
- "DZD",
884
- "EGP",
885
- "ERN",
886
- "ETB",
887
- "EUR",
888
- "FJD",
889
- "FKP",
890
- "GBP",
891
- "GEL",
892
- "GHS",
893
- "GIP",
894
- "GMD",
895
- "GNF",
896
- "GTQ",
897
- "GYD",
898
- "HKD",
899
- "HNL",
900
- "HRK",
901
- "HTG",
902
- "HUF",
903
- "IDR",
904
- "ILS",
905
- "INR",
906
- "IQD",
907
- "IRR",
908
- "ISK",
909
- "JMD",
910
- "JOD",
911
- "JPY",
912
- "KES",
913
- "KGS",
914
- "KHR",
915
- "KMF",
916
- "KPW",
917
- "KRW",
918
- "KWD",
919
- "KYD",
920
- "KZT",
921
- "LAK",
922
- "LBP",
923
- "LKR",
924
- "LRD",
925
- "LSL",
926
- "LYD",
927
- "MAD",
928
- "MDL",
929
- "MGA",
930
- "MKD",
931
- "MMK",
932
- "MNT",
933
- "MOP",
934
- "MRU",
935
- "MUR",
936
- "MVR",
937
- "MWK",
938
- "MXN",
939
- "MXV",
940
- "MYR",
941
- "MZN",
942
- "NAD",
943
- "NGN",
944
- "NIO",
945
- "NOK",
946
- "NPR",
947
- "NZD",
948
- "OMR",
949
- "PAB",
950
- "PEN",
951
- "PGK",
952
- "PHP",
953
- "PKR",
954
- "PLN",
955
- "PYG",
956
- "QAR",
957
- "RON",
958
- "RSD",
959
- "RUB",
960
- "RWF",
961
- "SAR",
962
- "SBD",
963
- "SCR",
964
- "SDG",
965
- "SEK",
966
- "SGD",
967
- "SHP",
968
- "SLL",
969
- "SOS",
970
- "SRD",
971
- "SSP",
972
- "STN",
973
- "SVC",
974
- "SYP",
975
- "SZL",
976
- "THB",
977
- "TJS",
978
- "TMT",
979
- "TND",
980
- "TOP",
981
- "TRY",
982
- "TTD",
983
- "TWD",
984
- "TZS",
985
- "UAH",
986
- "UGX",
987
- "USD",
988
- "USN",
989
- "UYI",
990
- "UYU",
991
- "UYW",
992
- "UZS",
993
- "VES",
994
- "VND",
995
- "VUV",
996
- "WST",
997
- "XAF",
998
- "XAG",
999
- "XAU",
1000
- "XBA",
1001
- "XBB",
1002
- "XBC",
1003
- "XBD",
1004
- "XCD",
1005
- "XDR",
1006
- "XOF",
1007
- "XPD",
1008
- "XPF",
1009
- "XPT",
1010
- "XSU",
1011
- "XTS",
1012
- "XUA",
1013
- "XXX",
1014
- "YER",
1015
- "ZAR",
1016
- "ZMW",
1017
- "ZWL"
1018
- ]
1019
- },
1020
- "name": {
1021
- "type": "string",
1022
- "description": "Account short name."
1023
- },
1024
- "type": {
1025
- "type": "string",
1026
- "enum": ["VERSIONED", "UNVERSIONED"]
1027
- }
1028
- }
1029
- }
1030
- },
1031
- "required": ["headers", "body"],
1032
- "additionalProperties": false
1033
- },
1034
- "404": {
1035
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1036
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment1ResponseNotFound",
1037
- "type": "object",
1038
- "properties": {
1039
- "headers": {
1040
- "type": "object",
1041
- "additionalProperties": true
1042
- }
1043
- },
1044
- "required": [],
1045
- "additionalProperties": false
1046
- },
1047
- "default": {
1048
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1049
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment1ResponseDefault",
1050
- "type": "object",
1051
- "properties": {
1052
- "headers": {
1053
- "type": "object",
1054
- "additionalProperties": true
1055
- },
1056
- "body": {
1057
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1058
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
1059
- "type": "object",
1060
- "additionalProperties": false,
1061
- "description": "Error message.",
1062
- "required": ["code"],
1063
- "properties": {
1064
- "message": {
1065
- "type": "string"
1066
- },
1067
- "code": {
1068
- "type": "string",
1069
- "enum": [
1070
- "INVALID_AT",
1071
- "INVALID_FROM",
1072
- "INVALID_TO",
1073
- "INVALID_CREATED_ON",
1074
- "INVALID_LAST_MODIFIED",
1075
- "INVALID_IF_MATCH",
1076
- "FROM_GREATER_THAN_TO",
1077
- "ACCOUNT_NOT_FOUND",
1078
- "POSTING_AMOUNT_NOT_AN_INTEGER",
1079
- "ACCOUNT_MULTIPLE_POSTINGS",
1080
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
1081
- "POSTING_WITH_ZERO_AMOUNT",
1082
- "POSTING_WITH_NEGATIVE_AMOUNT",
1083
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
1084
- "NO_POSTINGS",
1085
- "INSUFFICIENT_POSTINGS",
1086
- "UNEQUAL_CREDIT_DEBIT",
1087
- "VERSION_BALANCE_MISMATCH",
1088
- "VERSION_MISMATCH",
1089
- "CURRENCY_MISMATCH",
1090
- "UNHANDLED_ERROR"
1091
- ]
1092
- }
1093
- }
1094
- }
1095
- },
1096
- "required": ["body"],
1097
- "additionalProperties": false
1098
- }
1099
- }
1100
- },
1101
- "put": {
1102
- "request": {
1103
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1104
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountPutFragment1RequestContext",
1105
- "type": "object",
1106
- "properties": {
1107
- "params": {
1108
- "type": "object",
1109
- "additionalProperties": false,
1110
- "properties": {
1111
- "accountId": {
1112
- "type": "string"
1113
- },
1114
- "idFragment1": {
1115
- "type": "string"
1116
- }
1117
- },
1118
- "required": ["accountId", "idFragment1"]
1119
- },
1120
- "headers": {
1121
- "type": "object",
1122
- "additionalProperties": true,
1123
- "properties": {
1124
- "created-on": {
1125
- "type": "string",
1126
- "format": "date-time"
361
+ "additionalProperties": true,
362
+ "properties": {
363
+ "created-on": {
364
+ "type": "string",
365
+ "format": "date-time"
1127
366
  },
1128
367
  "last-modified": {
1129
368
  "type": "string",
@@ -1436,338 +675,6 @@
1436
675
  }
1437
676
  },
1438
677
  "/ledger/v1/account/:accountId/:idFragment1/:idFragment2": {
1439
- "get": {
1440
- "request": {
1441
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1442
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment2RequestContext",
1443
- "type": "object",
1444
- "properties": {
1445
- "params": {
1446
- "type": "object",
1447
- "additionalProperties": false,
1448
- "properties": {
1449
- "at": {
1450
- "type": "string",
1451
- "format": "date-time"
1452
- }
1453
- },
1454
- "required": ["at"]
1455
- },
1456
- "headers": {
1457
- "type": "object",
1458
- "additionalProperties": true
1459
- }
1460
- },
1461
- "required": ["params", "query"],
1462
- "additionalProperties": false
1463
- },
1464
- "responses": {
1465
- "200": {
1466
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1467
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment2ResponseOK",
1468
- "type": "object",
1469
- "properties": {
1470
- "headers": {
1471
- "type": "object",
1472
- "properties": {
1473
- "created-on": {
1474
- "type": "string",
1475
- "format": "date-time"
1476
- },
1477
- "updated-on": {
1478
- "type": "string",
1479
- "format": "date-time"
1480
- },
1481
- "last-modified": {
1482
- "type": "string",
1483
- "format": "date-time"
1484
- }
1485
- },
1486
- "required": ["created-on", "updated-on", "last-modified"]
1487
- },
1488
- "body": {
1489
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1490
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Account",
1491
- "type": "object",
1492
- "additionalProperties": false,
1493
- "required": ["accountId", "createdOn", "currency", "type"],
1494
- "properties": {
1495
- "accountId": {
1496
- "type": "string",
1497
- "description": "Account ID"
1498
- },
1499
- "createdOn": {
1500
- "type": "string",
1501
- "format": "date-time",
1502
- "description": "Account creation date/time."
1503
- },
1504
- "currency": {
1505
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1506
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Currency",
1507
- "type": "string",
1508
- "enum": [
1509
- "AED",
1510
- "AFN",
1511
- "ALL",
1512
- "AMD",
1513
- "ANG",
1514
- "AOA",
1515
- "ARS",
1516
- "AUD",
1517
- "AWG",
1518
- "AZN",
1519
- "BAM",
1520
- "BBD",
1521
- "BDT",
1522
- "BGN",
1523
- "BHD",
1524
- "BIF",
1525
- "BMD",
1526
- "BND",
1527
- "BOB",
1528
- "BOV",
1529
- "BRL",
1530
- "BSD",
1531
- "BTN",
1532
- "BWP",
1533
- "BYN",
1534
- "BZD",
1535
- "CAD",
1536
- "CDF",
1537
- "CHE",
1538
- "CHF",
1539
- "CHW",
1540
- "CLF",
1541
- "CLP",
1542
- "CNY",
1543
- "COP",
1544
- "COU",
1545
- "CRC",
1546
- "CUC",
1547
- "CUP",
1548
- "CVE",
1549
- "CZK",
1550
- "DJF",
1551
- "DKK",
1552
- "DOP",
1553
- "DZD",
1554
- "EGP",
1555
- "ERN",
1556
- "ETB",
1557
- "EUR",
1558
- "FJD",
1559
- "FKP",
1560
- "GBP",
1561
- "GEL",
1562
- "GHS",
1563
- "GIP",
1564
- "GMD",
1565
- "GNF",
1566
- "GTQ",
1567
- "GYD",
1568
- "HKD",
1569
- "HNL",
1570
- "HRK",
1571
- "HTG",
1572
- "HUF",
1573
- "IDR",
1574
- "ILS",
1575
- "INR",
1576
- "IQD",
1577
- "IRR",
1578
- "ISK",
1579
- "JMD",
1580
- "JOD",
1581
- "JPY",
1582
- "KES",
1583
- "KGS",
1584
- "KHR",
1585
- "KMF",
1586
- "KPW",
1587
- "KRW",
1588
- "KWD",
1589
- "KYD",
1590
- "KZT",
1591
- "LAK",
1592
- "LBP",
1593
- "LKR",
1594
- "LRD",
1595
- "LSL",
1596
- "LYD",
1597
- "MAD",
1598
- "MDL",
1599
- "MGA",
1600
- "MKD",
1601
- "MMK",
1602
- "MNT",
1603
- "MOP",
1604
- "MRU",
1605
- "MUR",
1606
- "MVR",
1607
- "MWK",
1608
- "MXN",
1609
- "MXV",
1610
- "MYR",
1611
- "MZN",
1612
- "NAD",
1613
- "NGN",
1614
- "NIO",
1615
- "NOK",
1616
- "NPR",
1617
- "NZD",
1618
- "OMR",
1619
- "PAB",
1620
- "PEN",
1621
- "PGK",
1622
- "PHP",
1623
- "PKR",
1624
- "PLN",
1625
- "PYG",
1626
- "QAR",
1627
- "RON",
1628
- "RSD",
1629
- "RUB",
1630
- "RWF",
1631
- "SAR",
1632
- "SBD",
1633
- "SCR",
1634
- "SDG",
1635
- "SEK",
1636
- "SGD",
1637
- "SHP",
1638
- "SLL",
1639
- "SOS",
1640
- "SRD",
1641
- "SSP",
1642
- "STN",
1643
- "SVC",
1644
- "SYP",
1645
- "SZL",
1646
- "THB",
1647
- "TJS",
1648
- "TMT",
1649
- "TND",
1650
- "TOP",
1651
- "TRY",
1652
- "TTD",
1653
- "TWD",
1654
- "TZS",
1655
- "UAH",
1656
- "UGX",
1657
- "USD",
1658
- "USN",
1659
- "UYI",
1660
- "UYU",
1661
- "UYW",
1662
- "UZS",
1663
- "VES",
1664
- "VND",
1665
- "VUV",
1666
- "WST",
1667
- "XAF",
1668
- "XAG",
1669
- "XAU",
1670
- "XBA",
1671
- "XBB",
1672
- "XBC",
1673
- "XBD",
1674
- "XCD",
1675
- "XDR",
1676
- "XOF",
1677
- "XPD",
1678
- "XPF",
1679
- "XPT",
1680
- "XSU",
1681
- "XTS",
1682
- "XUA",
1683
- "XXX",
1684
- "YER",
1685
- "ZAR",
1686
- "ZMW",
1687
- "ZWL"
1688
- ]
1689
- },
1690
- "name": {
1691
- "type": "string",
1692
- "description": "Account short name."
1693
- },
1694
- "type": {
1695
- "type": "string",
1696
- "enum": ["VERSIONED", "UNVERSIONED"]
1697
- }
1698
- }
1699
- }
1700
- },
1701
- "required": ["headers", "body"],
1702
- "additionalProperties": false
1703
- },
1704
- "404": {
1705
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1706
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment2ResponseNotFound",
1707
- "type": "object",
1708
- "properties": {
1709
- "headers": {
1710
- "type": "object",
1711
- "additionalProperties": true
1712
- }
1713
- },
1714
- "required": [],
1715
- "additionalProperties": false
1716
- },
1717
- "default": {
1718
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1719
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment2ResponseDefault",
1720
- "type": "object",
1721
- "properties": {
1722
- "headers": {
1723
- "type": "object",
1724
- "additionalProperties": true
1725
- },
1726
- "body": {
1727
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1728
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
1729
- "type": "object",
1730
- "additionalProperties": false,
1731
- "description": "Error message.",
1732
- "required": ["code"],
1733
- "properties": {
1734
- "message": {
1735
- "type": "string"
1736
- },
1737
- "code": {
1738
- "type": "string",
1739
- "enum": [
1740
- "INVALID_AT",
1741
- "INVALID_FROM",
1742
- "INVALID_TO",
1743
- "INVALID_CREATED_ON",
1744
- "INVALID_LAST_MODIFIED",
1745
- "INVALID_IF_MATCH",
1746
- "FROM_GREATER_THAN_TO",
1747
- "ACCOUNT_NOT_FOUND",
1748
- "POSTING_AMOUNT_NOT_AN_INTEGER",
1749
- "ACCOUNT_MULTIPLE_POSTINGS",
1750
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
1751
- "POSTING_WITH_ZERO_AMOUNT",
1752
- "POSTING_WITH_NEGATIVE_AMOUNT",
1753
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
1754
- "NO_POSTINGS",
1755
- "INSUFFICIENT_POSTINGS",
1756
- "UNEQUAL_CREDIT_DEBIT",
1757
- "VERSION_BALANCE_MISMATCH",
1758
- "VERSION_MISMATCH",
1759
- "CURRENCY_MISMATCH",
1760
- "UNHANDLED_ERROR"
1761
- ]
1762
- }
1763
- }
1764
- }
1765
- },
1766
- "required": ["body"],
1767
- "additionalProperties": false
1768
- }
1769
- }
1770
- },
1771
678
  "put": {
1772
679
  "request": {
1773
680
  "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -2109,362 +1016,30 @@
2109
1016
  }
2110
1017
  },
2111
1018
  "/ledger/v1/account/:accountId/:idFragment1/:idFragment2/:idFragment3": {
2112
- "get": {
1019
+ "put": {
2113
1020
  "request": {
2114
1021
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2115
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment3RequestContext",
1022
+ "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountPutFragment3RequestContext",
2116
1023
  "type": "object",
2117
1024
  "properties": {
2118
1025
  "params": {
2119
1026
  "type": "object",
2120
1027
  "additionalProperties": false,
2121
1028
  "properties": {
2122
- "at": {
2123
- "type": "string",
2124
- "format": "date-time"
1029
+ "accountId": {
1030
+ "type": "string"
1031
+ },
1032
+ "idFragment1": {
1033
+ "type": "string"
1034
+ },
1035
+ "idFragment2": {
1036
+ "type": "string"
1037
+ },
1038
+ "idFragment3": {
1039
+ "type": "string"
2125
1040
  }
2126
1041
  },
2127
- "required": ["at"]
2128
- },
2129
- "headers": {
2130
- "type": "object",
2131
- "additionalProperties": true
2132
- }
2133
- },
2134
- "required": ["params", "query"],
2135
- "additionalProperties": false
2136
- },
2137
- "responses": {
2138
- "200": {
2139
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2140
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment3ResponseOK",
2141
- "type": "object",
2142
- "properties": {
2143
- "headers": {
2144
- "type": "object",
2145
- "properties": {
2146
- "created-on": {
2147
- "type": "string",
2148
- "format": "date-time"
2149
- },
2150
- "updated-on": {
2151
- "type": "string",
2152
- "format": "date-time"
2153
- },
2154
- "last-modified": {
2155
- "type": "string",
2156
- "format": "date-time"
2157
- }
2158
- },
2159
- "required": ["created-on", "updated-on", "last-modified"]
2160
- },
2161
- "body": {
2162
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2163
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Account",
2164
- "type": "object",
2165
- "additionalProperties": false,
2166
- "required": ["accountId", "createdOn", "currency", "type"],
2167
- "properties": {
2168
- "accountId": {
2169
- "type": "string",
2170
- "description": "Account ID"
2171
- },
2172
- "createdOn": {
2173
- "type": "string",
2174
- "format": "date-time",
2175
- "description": "Account creation date/time."
2176
- },
2177
- "currency": {
2178
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2179
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Currency",
2180
- "type": "string",
2181
- "enum": [
2182
- "AED",
2183
- "AFN",
2184
- "ALL",
2185
- "AMD",
2186
- "ANG",
2187
- "AOA",
2188
- "ARS",
2189
- "AUD",
2190
- "AWG",
2191
- "AZN",
2192
- "BAM",
2193
- "BBD",
2194
- "BDT",
2195
- "BGN",
2196
- "BHD",
2197
- "BIF",
2198
- "BMD",
2199
- "BND",
2200
- "BOB",
2201
- "BOV",
2202
- "BRL",
2203
- "BSD",
2204
- "BTN",
2205
- "BWP",
2206
- "BYN",
2207
- "BZD",
2208
- "CAD",
2209
- "CDF",
2210
- "CHE",
2211
- "CHF",
2212
- "CHW",
2213
- "CLF",
2214
- "CLP",
2215
- "CNY",
2216
- "COP",
2217
- "COU",
2218
- "CRC",
2219
- "CUC",
2220
- "CUP",
2221
- "CVE",
2222
- "CZK",
2223
- "DJF",
2224
- "DKK",
2225
- "DOP",
2226
- "DZD",
2227
- "EGP",
2228
- "ERN",
2229
- "ETB",
2230
- "EUR",
2231
- "FJD",
2232
- "FKP",
2233
- "GBP",
2234
- "GEL",
2235
- "GHS",
2236
- "GIP",
2237
- "GMD",
2238
- "GNF",
2239
- "GTQ",
2240
- "GYD",
2241
- "HKD",
2242
- "HNL",
2243
- "HRK",
2244
- "HTG",
2245
- "HUF",
2246
- "IDR",
2247
- "ILS",
2248
- "INR",
2249
- "IQD",
2250
- "IRR",
2251
- "ISK",
2252
- "JMD",
2253
- "JOD",
2254
- "JPY",
2255
- "KES",
2256
- "KGS",
2257
- "KHR",
2258
- "KMF",
2259
- "KPW",
2260
- "KRW",
2261
- "KWD",
2262
- "KYD",
2263
- "KZT",
2264
- "LAK",
2265
- "LBP",
2266
- "LKR",
2267
- "LRD",
2268
- "LSL",
2269
- "LYD",
2270
- "MAD",
2271
- "MDL",
2272
- "MGA",
2273
- "MKD",
2274
- "MMK",
2275
- "MNT",
2276
- "MOP",
2277
- "MRU",
2278
- "MUR",
2279
- "MVR",
2280
- "MWK",
2281
- "MXN",
2282
- "MXV",
2283
- "MYR",
2284
- "MZN",
2285
- "NAD",
2286
- "NGN",
2287
- "NIO",
2288
- "NOK",
2289
- "NPR",
2290
- "NZD",
2291
- "OMR",
2292
- "PAB",
2293
- "PEN",
2294
- "PGK",
2295
- "PHP",
2296
- "PKR",
2297
- "PLN",
2298
- "PYG",
2299
- "QAR",
2300
- "RON",
2301
- "RSD",
2302
- "RUB",
2303
- "RWF",
2304
- "SAR",
2305
- "SBD",
2306
- "SCR",
2307
- "SDG",
2308
- "SEK",
2309
- "SGD",
2310
- "SHP",
2311
- "SLL",
2312
- "SOS",
2313
- "SRD",
2314
- "SSP",
2315
- "STN",
2316
- "SVC",
2317
- "SYP",
2318
- "SZL",
2319
- "THB",
2320
- "TJS",
2321
- "TMT",
2322
- "TND",
2323
- "TOP",
2324
- "TRY",
2325
- "TTD",
2326
- "TWD",
2327
- "TZS",
2328
- "UAH",
2329
- "UGX",
2330
- "USD",
2331
- "USN",
2332
- "UYI",
2333
- "UYU",
2334
- "UYW",
2335
- "UZS",
2336
- "VES",
2337
- "VND",
2338
- "VUV",
2339
- "WST",
2340
- "XAF",
2341
- "XAG",
2342
- "XAU",
2343
- "XBA",
2344
- "XBB",
2345
- "XBC",
2346
- "XBD",
2347
- "XCD",
2348
- "XDR",
2349
- "XOF",
2350
- "XPD",
2351
- "XPF",
2352
- "XPT",
2353
- "XSU",
2354
- "XTS",
2355
- "XUA",
2356
- "XXX",
2357
- "YER",
2358
- "ZAR",
2359
- "ZMW",
2360
- "ZWL"
2361
- ]
2362
- },
2363
- "name": {
2364
- "type": "string",
2365
- "description": "Account short name."
2366
- },
2367
- "type": {
2368
- "type": "string",
2369
- "enum": ["VERSIONED", "UNVERSIONED"]
2370
- }
2371
- }
2372
- }
2373
- },
2374
- "required": ["headers", "body"],
2375
- "additionalProperties": false
2376
- },
2377
- "404": {
2378
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2379
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment3ResponseNotFound",
2380
- "type": "object",
2381
- "properties": {
2382
- "headers": {
2383
- "type": "object",
2384
- "additionalProperties": true
2385
- }
2386
- },
2387
- "required": [],
2388
- "additionalProperties": false
2389
- },
2390
- "default": {
2391
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2392
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountGetFragment3ResponseDefault",
2393
- "type": "object",
2394
- "properties": {
2395
- "headers": {
2396
- "type": "object",
2397
- "additionalProperties": true
2398
- },
2399
- "body": {
2400
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2401
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
2402
- "type": "object",
2403
- "additionalProperties": false,
2404
- "description": "Error message.",
2405
- "required": ["code"],
2406
- "properties": {
2407
- "message": {
2408
- "type": "string"
2409
- },
2410
- "code": {
2411
- "type": "string",
2412
- "enum": [
2413
- "INVALID_AT",
2414
- "INVALID_FROM",
2415
- "INVALID_TO",
2416
- "INVALID_CREATED_ON",
2417
- "INVALID_LAST_MODIFIED",
2418
- "INVALID_IF_MATCH",
2419
- "FROM_GREATER_THAN_TO",
2420
- "ACCOUNT_NOT_FOUND",
2421
- "POSTING_AMOUNT_NOT_AN_INTEGER",
2422
- "ACCOUNT_MULTIPLE_POSTINGS",
2423
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
2424
- "POSTING_WITH_ZERO_AMOUNT",
2425
- "POSTING_WITH_NEGATIVE_AMOUNT",
2426
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
2427
- "NO_POSTINGS",
2428
- "INSUFFICIENT_POSTINGS",
2429
- "UNEQUAL_CREDIT_DEBIT",
2430
- "VERSION_BALANCE_MISMATCH",
2431
- "VERSION_MISMATCH",
2432
- "CURRENCY_MISMATCH",
2433
- "UNHANDLED_ERROR"
2434
- ]
2435
- }
2436
- }
2437
- }
2438
- },
2439
- "required": ["body"],
2440
- "additionalProperties": false
2441
- }
2442
- }
2443
- },
2444
- "put": {
2445
- "request": {
2446
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2447
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountPutFragment3RequestContext",
2448
- "type": "object",
2449
- "properties": {
2450
- "params": {
2451
- "type": "object",
2452
- "additionalProperties": false,
2453
- "properties": {
2454
- "accountId": {
2455
- "type": "string"
2456
- },
2457
- "idFragment1": {
2458
- "type": "string"
2459
- },
2460
- "idFragment2": {
2461
- "type": "string"
2462
- },
2463
- "idFragment3": {
2464
- "type": "string"
2465
- }
2466
- },
2467
- "required": ["accountId", "idFragment1", "idFragment2", "idFragment3"]
1042
+ "required": ["accountId", "idFragment1", "idFragment2", "idFragment3"]
2468
1043
  },
2469
1044
  "headers": {
2470
1045
  "type": "object",
@@ -2784,773 +1359,38 @@
2784
1359
  }
2785
1360
  }
2786
1361
  },
2787
- "/ledger/v1/account-entries": {
2788
- "get": {
1362
+ "/ledger/v1/account-entries": {},
1363
+ "/ledger/v1/entry/:entryId": {
1364
+ "put": {
2789
1365
  "request": {
2790
1366
  "$schema": "https://json-schema.org/draft/2020-12/schema",
2791
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountEntriesQueryGetRequestContext",
1367
+ "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/EntryPutRequestContext",
2792
1368
  "type": "object",
2793
1369
  "properties": {
2794
1370
  "params": {
2795
1371
  "type": "object",
2796
1372
  "additionalProperties": false,
2797
1373
  "properties": {
2798
- "toDate": {
2799
- "type": "string",
2800
- "format": "date-time"
2801
- },
2802
- "fromDate": {
2803
- "type": "string",
2804
- "format": "date-time"
2805
- },
2806
- "accountIds": {
2807
- "type": "array",
2808
- "minItems": 1,
2809
- "items": {
2810
- "type": "string"
2811
- }
1374
+ "entryId": {
1375
+ "type": "string"
2812
1376
  }
2813
1377
  },
2814
- "required": ["toDate", "accountIds"]
1378
+ "required": ["entryId"]
2815
1379
  },
2816
1380
  "headers": {
2817
1381
  "type": "object",
2818
- "additionalProperties": true
2819
- }
2820
- },
2821
- "required": ["query"],
2822
- "additionalProperties": false
2823
- },
2824
- "responses": {
2825
- "200": {
2826
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2827
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountEntriesQueryGetResponseOK",
2828
- "type": "object",
2829
- "properties": {
2830
- "headers": {
2831
- "type": "object",
2832
- "additionalProperties": true
2833
- },
2834
- "body": {
2835
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2836
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/EntriesList",
2837
- "type": "object",
2838
- "additionalProperties": false,
2839
- "required": ["accountEntries"],
2840
- "properties": {
2841
- "accountEntries": {
2842
- "type": "array",
2843
- "items": {
2844
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2845
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Entries",
2846
- "type": "object",
2847
- "additionalProperties": false,
2848
- "required": ["entries", "accountId"],
2849
- "properties": {
2850
- "accountId": {
2851
- "type": "string",
2852
- "description": "Account ID"
2853
- },
2854
- "entries": {
2855
- "type": "array",
2856
- "minItems": 0,
2857
- "items": {
2858
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2859
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Entry",
2860
- "type": "object",
2861
- "additionalProperties": false,
2862
- "required": ["entryId", "createdOn", "postings"],
2863
- "properties": {
2864
- "entryId": {
2865
- "type": "string",
2866
- "description": "Journal entry ID"
2867
- },
2868
- "createdOn": {
2869
- "type": "string",
2870
- "format": "date-time",
2871
- "description": "Journal entry creation date/time"
2872
- },
2873
- "postings": {
2874
- "type": "array",
2875
- "items": {
2876
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2877
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Post",
2878
- "type": "object",
2879
- "additionalProperties": false,
2880
- "required": ["amount", "currency", "type", "accountId"],
2881
- "properties": {
2882
- "amount": {
2883
- "type": "string"
2884
- },
2885
- "currency": {
2886
- "$schema": "https://json-schema.org/draft/2020-12/schema",
2887
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Currency",
2888
- "type": "string",
2889
- "enum": [
2890
- "AED",
2891
- "AFN",
2892
- "ALL",
2893
- "AMD",
2894
- "ANG",
2895
- "AOA",
2896
- "ARS",
2897
- "AUD",
2898
- "AWG",
2899
- "AZN",
2900
- "BAM",
2901
- "BBD",
2902
- "BDT",
2903
- "BGN",
2904
- "BHD",
2905
- "BIF",
2906
- "BMD",
2907
- "BND",
2908
- "BOB",
2909
- "BOV",
2910
- "BRL",
2911
- "BSD",
2912
- "BTN",
2913
- "BWP",
2914
- "BYN",
2915
- "BZD",
2916
- "CAD",
2917
- "CDF",
2918
- "CHE",
2919
- "CHF",
2920
- "CHW",
2921
- "CLF",
2922
- "CLP",
2923
- "CNY",
2924
- "COP",
2925
- "COU",
2926
- "CRC",
2927
- "CUC",
2928
- "CUP",
2929
- "CVE",
2930
- "CZK",
2931
- "DJF",
2932
- "DKK",
2933
- "DOP",
2934
- "DZD",
2935
- "EGP",
2936
- "ERN",
2937
- "ETB",
2938
- "EUR",
2939
- "FJD",
2940
- "FKP",
2941
- "GBP",
2942
- "GEL",
2943
- "GHS",
2944
- "GIP",
2945
- "GMD",
2946
- "GNF",
2947
- "GTQ",
2948
- "GYD",
2949
- "HKD",
2950
- "HNL",
2951
- "HRK",
2952
- "HTG",
2953
- "HUF",
2954
- "IDR",
2955
- "ILS",
2956
- "INR",
2957
- "IQD",
2958
- "IRR",
2959
- "ISK",
2960
- "JMD",
2961
- "JOD",
2962
- "JPY",
2963
- "KES",
2964
- "KGS",
2965
- "KHR",
2966
- "KMF",
2967
- "KPW",
2968
- "KRW",
2969
- "KWD",
2970
- "KYD",
2971
- "KZT",
2972
- "LAK",
2973
- "LBP",
2974
- "LKR",
2975
- "LRD",
2976
- "LSL",
2977
- "LYD",
2978
- "MAD",
2979
- "MDL",
2980
- "MGA",
2981
- "MKD",
2982
- "MMK",
2983
- "MNT",
2984
- "MOP",
2985
- "MRU",
2986
- "MUR",
2987
- "MVR",
2988
- "MWK",
2989
- "MXN",
2990
- "MXV",
2991
- "MYR",
2992
- "MZN",
2993
- "NAD",
2994
- "NGN",
2995
- "NIO",
2996
- "NOK",
2997
- "NPR",
2998
- "NZD",
2999
- "OMR",
3000
- "PAB",
3001
- "PEN",
3002
- "PGK",
3003
- "PHP",
3004
- "PKR",
3005
- "PLN",
3006
- "PYG",
3007
- "QAR",
3008
- "RON",
3009
- "RSD",
3010
- "RUB",
3011
- "RWF",
3012
- "SAR",
3013
- "SBD",
3014
- "SCR",
3015
- "SDG",
3016
- "SEK",
3017
- "SGD",
3018
- "SHP",
3019
- "SLL",
3020
- "SOS",
3021
- "SRD",
3022
- "SSP",
3023
- "STN",
3024
- "SVC",
3025
- "SYP",
3026
- "SZL",
3027
- "THB",
3028
- "TJS",
3029
- "TMT",
3030
- "TND",
3031
- "TOP",
3032
- "TRY",
3033
- "TTD",
3034
- "TWD",
3035
- "TZS",
3036
- "UAH",
3037
- "UGX",
3038
- "USD",
3039
- "USN",
3040
- "UYI",
3041
- "UYU",
3042
- "UYW",
3043
- "UZS",
3044
- "VES",
3045
- "VND",
3046
- "VUV",
3047
- "WST",
3048
- "XAF",
3049
- "XAG",
3050
- "XAU",
3051
- "XBA",
3052
- "XBB",
3053
- "XBC",
3054
- "XBD",
3055
- "XCD",
3056
- "XDR",
3057
- "XOF",
3058
- "XPD",
3059
- "XPF",
3060
- "XPT",
3061
- "XSU",
3062
- "XTS",
3063
- "XUA",
3064
- "XXX",
3065
- "YER",
3066
- "ZAR",
3067
- "ZMW",
3068
- "ZWL"
3069
- ]
3070
- },
3071
- "type": {
3072
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3073
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Type",
3074
- "type": "string",
3075
- "description": "CREDIT or DEBIT",
3076
- "enum": ["CREDIT", "DEBIT"]
3077
- },
3078
- "createdOn": {
3079
- "type": "string",
3080
- "format": "date-time"
3081
- },
3082
- "accountId": {
3083
- "type": "string",
3084
- "description": "account ID"
3085
- }
3086
- }
3087
- }
3088
- }
3089
- }
3090
- }
3091
- }
3092
- }
3093
- }
3094
- }
3095
- }
3096
- }
3097
- },
3098
- "required": ["body"],
3099
- "additionalProperties": false
3100
- },
3101
- "404": {
3102
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3103
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountEntriesQueryGetResponseNotFound",
3104
- "type": "object",
3105
- "properties": {
3106
- "headers": {
3107
- "type": "object",
3108
- "additionalProperties": true
3109
- }
3110
- },
3111
- "required": [],
3112
- "additionalProperties": false
3113
- },
3114
- "default": {
3115
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3116
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/AccountEntriesQueryGetResponseDefault",
3117
- "type": "object",
3118
- "properties": {
3119
- "headers": {
3120
- "type": "object",
3121
- "additionalProperties": true
3122
- },
3123
- "body": {
3124
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3125
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
3126
- "type": "object",
3127
- "additionalProperties": false,
3128
- "description": "Error message.",
3129
- "required": ["code"],
3130
- "properties": {
3131
- "message": {
3132
- "type": "string"
3133
- },
3134
- "code": {
3135
- "type": "string",
3136
- "enum": [
3137
- "INVALID_AT",
3138
- "INVALID_FROM",
3139
- "INVALID_TO",
3140
- "INVALID_CREATED_ON",
3141
- "INVALID_LAST_MODIFIED",
3142
- "INVALID_IF_MATCH",
3143
- "FROM_GREATER_THAN_TO",
3144
- "ACCOUNT_NOT_FOUND",
3145
- "POSTING_AMOUNT_NOT_AN_INTEGER",
3146
- "ACCOUNT_MULTIPLE_POSTINGS",
3147
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
3148
- "POSTING_WITH_ZERO_AMOUNT",
3149
- "POSTING_WITH_NEGATIVE_AMOUNT",
3150
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
3151
- "NO_POSTINGS",
3152
- "INSUFFICIENT_POSTINGS",
3153
- "UNEQUAL_CREDIT_DEBIT",
3154
- "VERSION_BALANCE_MISMATCH",
3155
- "VERSION_MISMATCH",
3156
- "CURRENCY_MISMATCH",
3157
- "UNHANDLED_ERROR"
3158
- ]
3159
- }
3160
- }
3161
- }
3162
- },
3163
- "required": ["body"],
3164
- "additionalProperties": false
3165
- }
3166
- }
3167
- }
3168
- },
3169
- "/ledger/v1/entry/:entryId": {
3170
- "get": {
3171
- "request": {
3172
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3173
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/EntryGetRequestContext",
3174
- "type": "object",
3175
- "properties": {
3176
- "params": {
3177
- "type": "object",
3178
- "additionalProperties": false,
3179
- "properties": {
3180
- "at": {
3181
- "type": "string",
3182
- "format": "date-time"
3183
- }
3184
- },
3185
- "required": ["at"]
3186
- },
3187
- "headers": {
3188
- "type": "object",
3189
- "additionalProperties": true
3190
- }
3191
- },
3192
- "required": ["params", "query"],
3193
- "additionalProperties": false
3194
- },
3195
- "responses": {
3196
- "200": {
3197
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3198
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/EntryGetResponseOK",
3199
- "type": "object",
3200
- "properties": {
3201
- "headers": {
3202
- "type": "object",
3203
- "properties": {
3204
- "created-on": {
3205
- "type": "string",
3206
- "format": "date-time"
3207
- },
3208
- "updated-on": {
3209
- "type": "string",
3210
- "format": "date-time"
3211
- },
3212
- "last-modified": {
3213
- "type": "string",
3214
- "format": "date-time"
3215
- }
3216
- },
3217
- "required": ["created-on", "updated-on", "last-modified"]
3218
- },
3219
- "body": {
3220
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3221
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/ResponseEntry",
3222
- "type": "object",
3223
- "additionalProperties": false,
3224
- "required": ["entryId", "createdOn", "postings"],
3225
- "properties": {
3226
- "entryId": {
3227
- "type": "string",
3228
- "description": "Journal entry ID"
3229
- },
3230
- "createdOn": {
3231
- "type": "string",
3232
- "format": "date-time",
3233
- "description": "Journal entry creation date/time"
3234
- },
3235
- "postings": {
3236
- "type": "array",
3237
- "items": {
3238
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3239
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/ResponsePost",
3240
- "type": "object",
3241
- "additionalProperties": false,
3242
- "required": ["amount", "currency", "type", "accountId", "createdOn"],
3243
- "properties": {
3244
- "amount": {
3245
- "type": "string"
3246
- },
3247
- "currency": {
3248
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3249
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Currency",
3250
- "type": "string",
3251
- "enum": [
3252
- "AED",
3253
- "AFN",
3254
- "ALL",
3255
- "AMD",
3256
- "ANG",
3257
- "AOA",
3258
- "ARS",
3259
- "AUD",
3260
- "AWG",
3261
- "AZN",
3262
- "BAM",
3263
- "BBD",
3264
- "BDT",
3265
- "BGN",
3266
- "BHD",
3267
- "BIF",
3268
- "BMD",
3269
- "BND",
3270
- "BOB",
3271
- "BOV",
3272
- "BRL",
3273
- "BSD",
3274
- "BTN",
3275
- "BWP",
3276
- "BYN",
3277
- "BZD",
3278
- "CAD",
3279
- "CDF",
3280
- "CHE",
3281
- "CHF",
3282
- "CHW",
3283
- "CLF",
3284
- "CLP",
3285
- "CNY",
3286
- "COP",
3287
- "COU",
3288
- "CRC",
3289
- "CUC",
3290
- "CUP",
3291
- "CVE",
3292
- "CZK",
3293
- "DJF",
3294
- "DKK",
3295
- "DOP",
3296
- "DZD",
3297
- "EGP",
3298
- "ERN",
3299
- "ETB",
3300
- "EUR",
3301
- "FJD",
3302
- "FKP",
3303
- "GBP",
3304
- "GEL",
3305
- "GHS",
3306
- "GIP",
3307
- "GMD",
3308
- "GNF",
3309
- "GTQ",
3310
- "GYD",
3311
- "HKD",
3312
- "HNL",
3313
- "HRK",
3314
- "HTG",
3315
- "HUF",
3316
- "IDR",
3317
- "ILS",
3318
- "INR",
3319
- "IQD",
3320
- "IRR",
3321
- "ISK",
3322
- "JMD",
3323
- "JOD",
3324
- "JPY",
3325
- "KES",
3326
- "KGS",
3327
- "KHR",
3328
- "KMF",
3329
- "KPW",
3330
- "KRW",
3331
- "KWD",
3332
- "KYD",
3333
- "KZT",
3334
- "LAK",
3335
- "LBP",
3336
- "LKR",
3337
- "LRD",
3338
- "LSL",
3339
- "LYD",
3340
- "MAD",
3341
- "MDL",
3342
- "MGA",
3343
- "MKD",
3344
- "MMK",
3345
- "MNT",
3346
- "MOP",
3347
- "MRU",
3348
- "MUR",
3349
- "MVR",
3350
- "MWK",
3351
- "MXN",
3352
- "MXV",
3353
- "MYR",
3354
- "MZN",
3355
- "NAD",
3356
- "NGN",
3357
- "NIO",
3358
- "NOK",
3359
- "NPR",
3360
- "NZD",
3361
- "OMR",
3362
- "PAB",
3363
- "PEN",
3364
- "PGK",
3365
- "PHP",
3366
- "PKR",
3367
- "PLN",
3368
- "PYG",
3369
- "QAR",
3370
- "RON",
3371
- "RSD",
3372
- "RUB",
3373
- "RWF",
3374
- "SAR",
3375
- "SBD",
3376
- "SCR",
3377
- "SDG",
3378
- "SEK",
3379
- "SGD",
3380
- "SHP",
3381
- "SLL",
3382
- "SOS",
3383
- "SRD",
3384
- "SSP",
3385
- "STN",
3386
- "SVC",
3387
- "SYP",
3388
- "SZL",
3389
- "THB",
3390
- "TJS",
3391
- "TMT",
3392
- "TND",
3393
- "TOP",
3394
- "TRY",
3395
- "TTD",
3396
- "TWD",
3397
- "TZS",
3398
- "UAH",
3399
- "UGX",
3400
- "USD",
3401
- "USN",
3402
- "UYI",
3403
- "UYU",
3404
- "UYW",
3405
- "UZS",
3406
- "VES",
3407
- "VND",
3408
- "VUV",
3409
- "WST",
3410
- "XAF",
3411
- "XAG",
3412
- "XAU",
3413
- "XBA",
3414
- "XBB",
3415
- "XBC",
3416
- "XBD",
3417
- "XCD",
3418
- "XDR",
3419
- "XOF",
3420
- "XPD",
3421
- "XPF",
3422
- "XPT",
3423
- "XSU",
3424
- "XTS",
3425
- "XUA",
3426
- "XXX",
3427
- "YER",
3428
- "ZAR",
3429
- "ZMW",
3430
- "ZWL"
3431
- ]
3432
- },
3433
- "type": {
3434
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3435
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Type",
3436
- "type": "string",
3437
- "description": "CREDIT or DEBIT",
3438
- "enum": ["CREDIT", "DEBIT"]
3439
- },
3440
- "createdOn": {
3441
- "type": "string",
3442
- "format": "date-time"
3443
- },
3444
- "accountId": {
3445
- "type": "string",
3446
- "description": "account ID"
3447
- }
3448
- }
3449
- }
3450
- }
3451
- }
3452
- }
3453
- },
3454
- "required": ["headers", "body"],
3455
- "additionalProperties": false
3456
- },
3457
- "404": {
3458
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3459
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/EntryGetResponseNotFound",
3460
- "type": "object",
3461
- "properties": {
3462
- "headers": {
3463
- "type": "object",
3464
- "additionalProperties": true
3465
- }
3466
- },
3467
- "required": [],
3468
- "additionalProperties": false
3469
- },
3470
- "default": {
3471
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3472
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/EntryGetResponseDefault",
3473
- "type": "object",
3474
- "properties": {
3475
- "headers": {
3476
- "type": "object",
3477
- "additionalProperties": true
3478
- },
3479
- "body": {
3480
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3481
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
3482
- "type": "object",
3483
- "additionalProperties": false,
3484
- "description": "Error message.",
3485
- "required": ["code"],
3486
- "properties": {
3487
- "message": {
3488
- "type": "string"
3489
- },
3490
- "code": {
3491
- "type": "string",
3492
- "enum": [
3493
- "INVALID_AT",
3494
- "INVALID_FROM",
3495
- "INVALID_TO",
3496
- "INVALID_CREATED_ON",
3497
- "INVALID_LAST_MODIFIED",
3498
- "INVALID_IF_MATCH",
3499
- "FROM_GREATER_THAN_TO",
3500
- "ACCOUNT_NOT_FOUND",
3501
- "POSTING_AMOUNT_NOT_AN_INTEGER",
3502
- "ACCOUNT_MULTIPLE_POSTINGS",
3503
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
3504
- "POSTING_WITH_ZERO_AMOUNT",
3505
- "POSTING_WITH_NEGATIVE_AMOUNT",
3506
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
3507
- "NO_POSTINGS",
3508
- "INSUFFICIENT_POSTINGS",
3509
- "UNEQUAL_CREDIT_DEBIT",
3510
- "VERSION_BALANCE_MISMATCH",
3511
- "VERSION_MISMATCH",
3512
- "CURRENCY_MISMATCH",
3513
- "UNHANDLED_ERROR"
3514
- ]
3515
- }
3516
- }
3517
- }
3518
- },
3519
- "required": ["body"],
3520
- "additionalProperties": false
3521
- }
3522
- }
3523
- },
3524
- "put": {
3525
- "request": {
3526
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3527
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/EntryPutRequestContext",
3528
- "type": "object",
3529
- "properties": {
3530
- "params": {
3531
- "type": "object",
3532
- "additionalProperties": false,
3533
- "properties": {
3534
- "entryId": {
3535
- "type": "string"
3536
- }
3537
- },
3538
- "required": ["entryId"]
3539
- },
3540
- "headers": {
3541
- "type": "object",
3542
- "additionalProperties": true,
3543
- "properties": {
3544
- "if-match": {
3545
- "type": "string"
3546
- },
3547
- "created-on": {
3548
- "type": "string",
3549
- "format": "date-time"
3550
- },
3551
- "last-modified": {
3552
- "type": "string",
3553
- "format": "date-time"
1382
+ "additionalProperties": true,
1383
+ "properties": {
1384
+ "if-match": {
1385
+ "type": "string"
1386
+ },
1387
+ "created-on": {
1388
+ "type": "string",
1389
+ "format": "date-time"
1390
+ },
1391
+ "last-modified": {
1392
+ "type": "string",
1393
+ "format": "date-time"
3554
1394
  }
3555
1395
  }
3556
1396
  },
@@ -3893,409 +1733,8 @@
3893
1733
  }
3894
1734
  }
3895
1735
  },
3896
- "/ledger/v1/balance": {
3897
- "get": {
3898
- "request": {
3899
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3900
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/BalanceGetRequestContext",
3901
- "type": "object",
3902
- "properties": {
3903
- "params": {
3904
- "type": "object",
3905
- "additionalProperties": false,
3906
- "properties": {
3907
- "accountIds": {
3908
- "type": "array",
3909
- "minItems": 1,
3910
- "items": {
3911
- "type": "string"
3912
- }
3913
- },
3914
- "at": {
3915
- "type": "string",
3916
- "format": "date-time"
3917
- }
3918
- },
3919
- "required": ["accountIds", "at"]
3920
- },
3921
- "headers": {
3922
- "type": "object",
3923
- "additionalProperties": true,
3924
- "properties": {
3925
- "if-none-match": {
3926
- "type": "string"
3927
- }
3928
- }
3929
- }
3930
- },
3931
- "required": ["query"],
3932
- "additionalProperties": false
3933
- },
3934
- "responses": {
3935
- "200": {
3936
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3937
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/BalanceGetResponseOK",
3938
- "type": "object",
3939
- "properties": {
3940
- "headers": {
3941
- "type": "object",
3942
- "properties": {
3943
- "etag": {
3944
- "type": "string"
3945
- }
3946
- },
3947
- "required": ["etag"]
3948
- },
3949
- "body": {
3950
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3951
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/BalanceList",
3952
- "type": "object",
3953
- "additionalProperties": false,
3954
- "description": "Balances for the accounts requested.",
3955
- "required": ["at", "balances"],
3956
- "properties": {
3957
- "at": {
3958
- "type": "string",
3959
- "format": "date-time",
3960
- "description": "Account balance at this date/time"
3961
- },
3962
- "balances": {
3963
- "type": "array",
3964
- "items": {
3965
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3966
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Balance",
3967
- "type": "object",
3968
- "additionalProperties": false,
3969
- "description": "Ledger balance at a point in time.",
3970
- "required": ["accountId", "balance"],
3971
- "properties": {
3972
- "accountId": {
3973
- "type": "string",
3974
- "description": "Account ID"
3975
- },
3976
- "balance": {
3977
- "type": "string"
3978
- }
3979
- }
3980
- }
3981
- }
3982
- }
3983
- }
3984
- },
3985
- "required": ["headers", "body"],
3986
- "additionalProperties": false
3987
- },
3988
- "400": {
3989
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3990
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/BalanceGetResponseBadRequest",
3991
- "type": "object",
3992
- "properties": {
3993
- "headers": {
3994
- "type": "object",
3995
- "additionalProperties": true
3996
- },
3997
- "body": {
3998
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3999
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
4000
- "type": "object",
4001
- "additionalProperties": false,
4002
- "description": "Error message.",
4003
- "required": ["code"],
4004
- "properties": {
4005
- "message": {
4006
- "type": "string"
4007
- },
4008
- "code": {
4009
- "type": "string",
4010
- "enum": [
4011
- "INVALID_AT",
4012
- "INVALID_FROM",
4013
- "INVALID_TO",
4014
- "INVALID_CREATED_ON",
4015
- "INVALID_LAST_MODIFIED",
4016
- "INVALID_IF_MATCH",
4017
- "FROM_GREATER_THAN_TO",
4018
- "ACCOUNT_NOT_FOUND",
4019
- "POSTING_AMOUNT_NOT_AN_INTEGER",
4020
- "ACCOUNT_MULTIPLE_POSTINGS",
4021
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
4022
- "POSTING_WITH_ZERO_AMOUNT",
4023
- "POSTING_WITH_NEGATIVE_AMOUNT",
4024
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
4025
- "NO_POSTINGS",
4026
- "INSUFFICIENT_POSTINGS",
4027
- "UNEQUAL_CREDIT_DEBIT",
4028
- "VERSION_BALANCE_MISMATCH",
4029
- "VERSION_MISMATCH",
4030
- "CURRENCY_MISMATCH",
4031
- "UNHANDLED_ERROR"
4032
- ]
4033
- }
4034
- }
4035
- }
4036
- },
4037
- "required": ["body"],
4038
- "additionalProperties": false
4039
- },
4040
- "default": {
4041
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4042
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/BalanceGetResponseDefault",
4043
- "type": "object",
4044
- "properties": {
4045
- "headers": {
4046
- "type": "object",
4047
- "additionalProperties": true
4048
- },
4049
- "body": {
4050
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4051
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
4052
- "type": "object",
4053
- "additionalProperties": false,
4054
- "description": "Error message.",
4055
- "required": ["code"],
4056
- "properties": {
4057
- "message": {
4058
- "type": "string"
4059
- },
4060
- "code": {
4061
- "type": "string",
4062
- "enum": [
4063
- "INVALID_AT",
4064
- "INVALID_FROM",
4065
- "INVALID_TO",
4066
- "INVALID_CREATED_ON",
4067
- "INVALID_LAST_MODIFIED",
4068
- "INVALID_IF_MATCH",
4069
- "FROM_GREATER_THAN_TO",
4070
- "ACCOUNT_NOT_FOUND",
4071
- "POSTING_AMOUNT_NOT_AN_INTEGER",
4072
- "ACCOUNT_MULTIPLE_POSTINGS",
4073
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
4074
- "POSTING_WITH_ZERO_AMOUNT",
4075
- "POSTING_WITH_NEGATIVE_AMOUNT",
4076
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
4077
- "NO_POSTINGS",
4078
- "INSUFFICIENT_POSTINGS",
4079
- "UNEQUAL_CREDIT_DEBIT",
4080
- "VERSION_BALANCE_MISMATCH",
4081
- "VERSION_MISMATCH",
4082
- "CURRENCY_MISMATCH",
4083
- "UNHANDLED_ERROR"
4084
- ]
4085
- }
4086
- }
4087
- }
4088
- },
4089
- "required": ["body"],
4090
- "additionalProperties": false
4091
- }
4092
- }
4093
- }
4094
- },
4095
- "/ledger/v1/total": {
4096
- "get": {
4097
- "request": {
4098
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4099
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/TotalGetRequestContext",
4100
- "type": "object",
4101
- "properties": {
4102
- "params": {
4103
- "type": "object",
4104
- "additionalProperties": false,
4105
- "properties": {
4106
- "accountIds": {
4107
- "type": "array",
4108
- "minItems": 1,
4109
- "items": {
4110
- "type": "string"
4111
- }
4112
- },
4113
- "filteredAccounts": {
4114
- "type": "array",
4115
- "minItems": 1,
4116
- "items": {
4117
- "type": "string"
4118
- }
4119
- },
4120
- "fromDate": {
4121
- "type": "string",
4122
- "format": "date-time"
4123
- },
4124
- "toDate": {
4125
- "type": "string",
4126
- "format": "date-time"
4127
- }
4128
- },
4129
- "required": ["accountIds", "toDate"]
4130
- },
4131
- "headers": {
4132
- "type": "object",
4133
- "additionalProperties": true
4134
- }
4135
- },
4136
- "required": ["query"],
4137
- "additionalProperties": false
4138
- },
4139
- "responses": {
4140
- "200": {
4141
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4142
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/TotalGetResponseOK",
4143
- "type": "object",
4144
- "properties": {
4145
- "headers": {
4146
- "type": "object",
4147
- "additionalProperties": true
4148
- },
4149
- "body": {
4150
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4151
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/TotalsList",
4152
- "type": "array",
4153
- "additionalProperties": false,
4154
- "description": "Totals of filtered entries for the accounts requested.",
4155
- "items": {
4156
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4157
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Total",
4158
- "type": "object",
4159
- "additionalProperties": false,
4160
- "description": "- The total debit or credit to an account.\n- If debits exceed credits the total value will be negative.\n- AccountIds may include idFragments formatted as: :accountId/:idFragment1/:idFragment2/:idFragment3.\n",
4161
- "required": ["accountId", "total"],
4162
- "properties": {
4163
- "accountId": {
4164
- "type": "string",
4165
- "description": "account ID"
4166
- },
4167
- "total": {
4168
- "type": "string",
4169
- "minLength": 1
4170
- }
4171
- }
4172
- },
4173
- "minItems": 1
4174
- }
4175
- },
4176
- "required": ["body"],
4177
- "additionalProperties": false
4178
- },
4179
- "400": {
4180
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4181
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/TotalGetResponseBadRequest",
4182
- "type": "object",
4183
- "properties": {
4184
- "headers": {
4185
- "type": "object",
4186
- "additionalProperties": true
4187
- },
4188
- "body": {
4189
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4190
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
4191
- "type": "object",
4192
- "additionalProperties": false,
4193
- "description": "Error message.",
4194
- "required": ["code"],
4195
- "properties": {
4196
- "message": {
4197
- "type": "string"
4198
- },
4199
- "code": {
4200
- "type": "string",
4201
- "enum": [
4202
- "INVALID_AT",
4203
- "INVALID_FROM",
4204
- "INVALID_TO",
4205
- "INVALID_CREATED_ON",
4206
- "INVALID_LAST_MODIFIED",
4207
- "INVALID_IF_MATCH",
4208
- "FROM_GREATER_THAN_TO",
4209
- "ACCOUNT_NOT_FOUND",
4210
- "POSTING_AMOUNT_NOT_AN_INTEGER",
4211
- "ACCOUNT_MULTIPLE_POSTINGS",
4212
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
4213
- "POSTING_WITH_ZERO_AMOUNT",
4214
- "POSTING_WITH_NEGATIVE_AMOUNT",
4215
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
4216
- "NO_POSTINGS",
4217
- "INSUFFICIENT_POSTINGS",
4218
- "UNEQUAL_CREDIT_DEBIT",
4219
- "VERSION_BALANCE_MISMATCH",
4220
- "VERSION_MISMATCH",
4221
- "CURRENCY_MISMATCH",
4222
- "UNHANDLED_ERROR"
4223
- ]
4224
- }
4225
- }
4226
- }
4227
- },
4228
- "required": ["body"],
4229
- "additionalProperties": false
4230
- },
4231
- "404": {
4232
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4233
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/TotalGetResponseNotFound",
4234
- "type": "object",
4235
- "properties": {
4236
- "headers": {
4237
- "type": "object",
4238
- "additionalProperties": true
4239
- }
4240
- },
4241
- "required": [],
4242
- "additionalProperties": false
4243
- },
4244
- "default": {
4245
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4246
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/api/TotalGetResponseDefault",
4247
- "type": "object",
4248
- "properties": {
4249
- "headers": {
4250
- "type": "object",
4251
- "additionalProperties": true
4252
- },
4253
- "body": {
4254
- "$schema": "https://json-schema.org/draft/2020-12/schema",
4255
- "$id": "https://eslint-plugin.checkdigit/ledger/v1/schemas/definitions/Error",
4256
- "type": "object",
4257
- "additionalProperties": false,
4258
- "description": "Error message.",
4259
- "required": ["code"],
4260
- "properties": {
4261
- "message": {
4262
- "type": "string"
4263
- },
4264
- "code": {
4265
- "type": "string",
4266
- "enum": [
4267
- "INVALID_AT",
4268
- "INVALID_FROM",
4269
- "INVALID_TO",
4270
- "INVALID_CREATED_ON",
4271
- "INVALID_LAST_MODIFIED",
4272
- "INVALID_IF_MATCH",
4273
- "FROM_GREATER_THAN_TO",
4274
- "ACCOUNT_NOT_FOUND",
4275
- "POSTING_AMOUNT_NOT_AN_INTEGER",
4276
- "ACCOUNT_MULTIPLE_POSTINGS",
4277
- "LAST_MODIFIED_BEFORE_ACCOUNT_CREATED_ON",
4278
- "POSTING_WITH_ZERO_AMOUNT",
4279
- "POSTING_WITH_NEGATIVE_AMOUNT",
4280
- "VERSION_SUPPLIED_FOR_UNVERSIONED_ACCOUNT",
4281
- "NO_POSTINGS",
4282
- "INSUFFICIENT_POSTINGS",
4283
- "UNEQUAL_CREDIT_DEBIT",
4284
- "VERSION_BALANCE_MISMATCH",
4285
- "VERSION_MISMATCH",
4286
- "CURRENCY_MISMATCH",
4287
- "UNHANDLED_ERROR"
4288
- ]
4289
- }
4290
- }
4291
- }
4292
- },
4293
- "required": ["body"],
4294
- "additionalProperties": false
4295
- }
4296
- }
4297
- }
4298
- }
1736
+ "/ledger/v1/balance": {},
1737
+ "/ledger/v1/total": {}
4299
1738
  },
4300
1739
  "definitions": {
4301
1740
  "Ping": {