@allisall/sdk 0.1.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +145 -4
  2. package/dist/client.d.ts +87 -37
  3. package/dist/client.js +144 -73
  4. package/dist/generated/openapi.d.ts +9497 -0
  5. package/dist/generated/openapi.js +4 -0
  6. package/dist/generated/operations.d.ts +42 -0
  7. package/dist/generated/operations.js +1167 -0
  8. package/dist/import-mapping.d.ts +10 -0
  9. package/dist/import-mapping.js +20 -0
  10. package/dist/index.d.ts +8 -2
  11. package/dist/index.js +2 -0
  12. package/dist/ingest.d.ts +1 -1
  13. package/dist/ingest.js +2 -2
  14. package/dist/money.d.ts +57 -0
  15. package/dist/money.js +284 -0
  16. package/dist/multipart.d.ts +29 -0
  17. package/dist/multipart.js +48 -0
  18. package/dist/options.d.ts +50 -0
  19. package/dist/options.js +73 -0
  20. package/dist/pagination.d.ts +55 -0
  21. package/dist/pagination.js +85 -0
  22. package/dist/request.d.ts +126 -0
  23. package/dist/request.js +403 -0
  24. package/dist/resources/agents.d.ts +58 -0
  25. package/dist/resources/agents.js +72 -0
  26. package/dist/resources/analytics.d.ts +42 -0
  27. package/dist/resources/analytics.js +68 -0
  28. package/dist/resources/api-keys.d.ts +54 -0
  29. package/dist/resources/api-keys.js +63 -0
  30. package/dist/resources/calculations.d.ts +98 -0
  31. package/dist/resources/calculations.js +133 -0
  32. package/dist/resources/clients.d.ts +93 -0
  33. package/dist/resources/clients.js +113 -0
  34. package/dist/resources/cost.d.ts +76 -0
  35. package/dist/resources/cost.js +96 -0
  36. package/dist/resources/dashboard.d.ts +32 -0
  37. package/dist/resources/dashboard.js +36 -0
  38. package/dist/resources/events.d.ts +116 -0
  39. package/dist/resources/events.js +145 -0
  40. package/dist/resources/health.d.ts +14 -0
  41. package/dist/resources/health.js +17 -0
  42. package/dist/resources/imports.d.ts +56 -0
  43. package/dist/resources/imports.js +63 -0
  44. package/dist/resources/onboarding.d.ts +29 -0
  45. package/dist/resources/onboarding.js +34 -0
  46. package/dist/resources/outcome-types.d.ts +25 -0
  47. package/dist/resources/outcome-types.js +33 -0
  48. package/dist/resources/reports.d.ts +92 -0
  49. package/dist/resources/reports.js +120 -0
  50. package/dist/resources/value-models.d.ts +99 -0
  51. package/dist/resources/value-models.js +133 -0
  52. package/dist/resources/workspace.d.ts +15 -0
  53. package/dist/resources/workspace.js +18 -0
  54. package/dist/runtime.d.ts +2 -0
  55. package/dist/runtime.js +2 -1
  56. package/dist/share.d.ts +52 -0
  57. package/dist/share.js +60 -0
  58. package/dist/transport.d.ts +54 -5
  59. package/dist/transport.js +81 -32
  60. package/dist/types.d.ts +163 -3
  61. package/dist/types.js +18 -3
  62. package/dist/unicode.d.ts +2 -0
  63. package/dist/unicode.js +11 -0
  64. package/dist/version.d.ts +1 -1
  65. package/dist/version.js +1 -1
  66. package/package.json +4 -3
@@ -0,0 +1,1167 @@
1
+ // Generated from the API's OpenAPI document by scripts/generate.mjs.
2
+ // Never edit this file by hand: change the document or the script, and
3
+ // regenerate.
4
+ /** The path segment that stands for every item of an array. */
5
+ export const ITEMS = "*";
6
+ /** The operation table, one entry per operation the SDK can call. */
7
+ export const OPERATIONS = {
8
+ commitImport: {
9
+ method: "POST",
10
+ path: "/v1/imports",
11
+ access: "KeyOrSession",
12
+ scope: "ingest",
13
+ idempotent: true,
14
+ list: null,
15
+ repeatable: [],
16
+ body: "multipart",
17
+ status: 200,
18
+ requestMoney: [],
19
+ responseMoney: [],
20
+ },
21
+ createAgent: {
22
+ method: "POST",
23
+ path: "/v1/agents",
24
+ access: "KeyOrSession",
25
+ scope: "write",
26
+ idempotent: true,
27
+ list: null,
28
+ repeatable: [],
29
+ body: "json",
30
+ status: 201,
31
+ requestMoney: [],
32
+ responseMoney: [],
33
+ },
34
+ createApiKey: {
35
+ method: "POST",
36
+ path: "/v1/api-keys",
37
+ access: "SessionOnly",
38
+ scope: null,
39
+ idempotent: false,
40
+ list: null,
41
+ repeatable: [],
42
+ body: "json",
43
+ status: 201,
44
+ requestMoney: [],
45
+ responseMoney: [],
46
+ },
47
+ createCalculation: {
48
+ method: "POST",
49
+ path: "/v1/clients/{id}/calculations",
50
+ access: "KeyOrSession",
51
+ scope: "write",
52
+ idempotent: true,
53
+ list: null,
54
+ repeatable: [],
55
+ body: "json",
56
+ status: 201,
57
+ requestMoney: [],
58
+ responseMoney: [
59
+ ["cost_total"],
60
+ ["snapshot", "cost", "agent_lines", "*", "manual"],
61
+ ["snapshot", "cost", "agent_lines", "*", "pass_through"],
62
+ ["snapshot", "cost", "agent_lines", "*", "token_valued"],
63
+ ["snapshot", "cost", "agent_lines", "*", "total"],
64
+ [
65
+ "snapshot",
66
+ "cost",
67
+ "coverage",
68
+ "partially_covered_line_items",
69
+ "*",
70
+ "monthly_amount",
71
+ ],
72
+ [
73
+ "snapshot",
74
+ "cost",
75
+ "coverage",
76
+ "partially_covered_line_items",
77
+ "*",
78
+ "total",
79
+ ],
80
+ ["snapshot", "cost", "manual"],
81
+ ["snapshot", "cost", "manual_lines", "*", "monthly_amount"],
82
+ ["snapshot", "cost", "manual_lines", "*", "total"],
83
+ ["snapshot", "cost", "pass_through"],
84
+ ["snapshot", "cost", "token_lines", "*", "in_rate"],
85
+ ["snapshot", "cost", "token_lines", "*", "out_rate"],
86
+ ["snapshot", "cost", "token_lines", "*", "total"],
87
+ ["snapshot", "cost", "token_valued"],
88
+ ["snapshot", "cost", "total"],
89
+ ["snapshot", "value", "lines", "*", "total"],
90
+ ["snapshot", "value", "lines", "*", "unit_value"],
91
+ ["snapshot", "value", "total"],
92
+ ["value_total"],
93
+ ],
94
+ },
95
+ createClient: {
96
+ method: "POST",
97
+ path: "/v1/clients",
98
+ access: "KeyOrSession",
99
+ scope: "write",
100
+ idempotent: true,
101
+ list: null,
102
+ repeatable: [],
103
+ body: "json",
104
+ status: 201,
105
+ requestMoney: [],
106
+ responseMoney: [],
107
+ },
108
+ createCostLineItem: {
109
+ method: "POST",
110
+ path: "/v1/cost-line-items",
111
+ access: "KeyOrSession",
112
+ scope: "write",
113
+ idempotent: true,
114
+ list: null,
115
+ repeatable: [],
116
+ body: "json",
117
+ status: 201,
118
+ requestMoney: [["monthly_amount"]],
119
+ responseMoney: [["monthly_amount"]],
120
+ },
121
+ createReport: {
122
+ method: "POST",
123
+ path: "/v1/calculations/{id}/reports",
124
+ access: "KeyOrSession",
125
+ scope: "write",
126
+ idempotent: true,
127
+ list: null,
128
+ repeatable: [],
129
+ body: "none",
130
+ status: 201,
131
+ requestMoney: [],
132
+ responseMoney: [],
133
+ },
134
+ createValueModel: {
135
+ method: "POST",
136
+ path: "/v1/clients/{id}/value-model",
137
+ access: "KeyOrSession",
138
+ scope: "write",
139
+ idempotent: true,
140
+ list: null,
141
+ repeatable: [],
142
+ body: "json",
143
+ status: 201,
144
+ requestMoney: [],
145
+ responseMoney: [["line_items", "*", "unit_value"]],
146
+ },
147
+ deleteAgent: {
148
+ method: "DELETE",
149
+ path: "/v1/agents/{id}",
150
+ access: "KeyOrSession",
151
+ scope: "write",
152
+ idempotent: false,
153
+ list: null,
154
+ repeatable: [],
155
+ body: "none",
156
+ status: 204,
157
+ requestMoney: [],
158
+ responseMoney: [],
159
+ },
160
+ deleteCalculation: {
161
+ method: "DELETE",
162
+ path: "/v1/calculations/{id}",
163
+ access: "KeyOrSession",
164
+ scope: "write",
165
+ idempotent: false,
166
+ list: null,
167
+ repeatable: [],
168
+ body: "none",
169
+ status: 204,
170
+ requestMoney: [],
171
+ responseMoney: [],
172
+ },
173
+ deleteClient: {
174
+ method: "DELETE",
175
+ path: "/v1/clients/{id}",
176
+ access: "KeyOrSession",
177
+ scope: "write",
178
+ idempotent: false,
179
+ list: null,
180
+ repeatable: [],
181
+ body: "none",
182
+ status: 204,
183
+ requestMoney: [],
184
+ responseMoney: [],
185
+ },
186
+ deleteCostLineItem: {
187
+ method: "DELETE",
188
+ path: "/v1/cost-line-items/{id}",
189
+ access: "KeyOrSession",
190
+ scope: "write",
191
+ idempotent: false,
192
+ list: null,
193
+ repeatable: [],
194
+ body: "none",
195
+ status: 204,
196
+ requestMoney: [],
197
+ responseMoney: [],
198
+ },
199
+ deleteReport: {
200
+ method: "DELETE",
201
+ path: "/v1/reports/{id}",
202
+ access: "KeyOrSession",
203
+ scope: "write",
204
+ idempotent: false,
205
+ list: null,
206
+ repeatable: [],
207
+ body: "none",
208
+ status: 204,
209
+ requestMoney: [],
210
+ responseMoney: [],
211
+ },
212
+ deleteValueModel: {
213
+ method: "DELETE",
214
+ path: "/v1/clients/{id}/value-model",
215
+ access: "KeyOrSession",
216
+ scope: "write",
217
+ idempotent: false,
218
+ list: null,
219
+ repeatable: [],
220
+ body: "none",
221
+ status: 204,
222
+ requestMoney: [],
223
+ responseMoney: [],
224
+ },
225
+ getAgent: {
226
+ method: "GET",
227
+ path: "/v1/agents/{id}",
228
+ access: "KeyOrSession",
229
+ scope: "read",
230
+ idempotent: false,
231
+ list: null,
232
+ repeatable: [],
233
+ body: "none",
234
+ status: 200,
235
+ requestMoney: [],
236
+ responseMoney: [["stats", "cost_total"]],
237
+ },
238
+ getApiKey: {
239
+ method: "GET",
240
+ path: "/v1/api-keys/{id}",
241
+ access: "SessionOnly",
242
+ scope: null,
243
+ idempotent: false,
244
+ list: null,
245
+ repeatable: [],
246
+ body: "none",
247
+ status: 200,
248
+ requestMoney: [],
249
+ responseMoney: [],
250
+ },
251
+ getCalculation: {
252
+ method: "GET",
253
+ path: "/v1/calculations/{id}",
254
+ access: "KeyOrSession",
255
+ scope: "read",
256
+ idempotent: false,
257
+ list: null,
258
+ repeatable: [],
259
+ body: "none",
260
+ status: 200,
261
+ requestMoney: [],
262
+ responseMoney: [
263
+ ["cost_total"],
264
+ ["snapshot", "cost", "agent_lines", "*", "manual"],
265
+ ["snapshot", "cost", "agent_lines", "*", "pass_through"],
266
+ ["snapshot", "cost", "agent_lines", "*", "token_valued"],
267
+ ["snapshot", "cost", "agent_lines", "*", "total"],
268
+ [
269
+ "snapshot",
270
+ "cost",
271
+ "coverage",
272
+ "partially_covered_line_items",
273
+ "*",
274
+ "monthly_amount",
275
+ ],
276
+ [
277
+ "snapshot",
278
+ "cost",
279
+ "coverage",
280
+ "partially_covered_line_items",
281
+ "*",
282
+ "total",
283
+ ],
284
+ ["snapshot", "cost", "manual"],
285
+ ["snapshot", "cost", "manual_lines", "*", "monthly_amount"],
286
+ ["snapshot", "cost", "manual_lines", "*", "total"],
287
+ ["snapshot", "cost", "pass_through"],
288
+ ["snapshot", "cost", "token_lines", "*", "in_rate"],
289
+ ["snapshot", "cost", "token_lines", "*", "out_rate"],
290
+ ["snapshot", "cost", "token_lines", "*", "total"],
291
+ ["snapshot", "cost", "token_valued"],
292
+ ["snapshot", "cost", "total"],
293
+ ["snapshot", "value", "lines", "*", "total"],
294
+ ["snapshot", "value", "lines", "*", "unit_value"],
295
+ ["snapshot", "value", "total"],
296
+ ["value_total"],
297
+ ],
298
+ },
299
+ getClient: {
300
+ method: "GET",
301
+ path: "/v1/clients/{id}",
302
+ access: "KeyOrSession",
303
+ scope: "read",
304
+ idempotent: false,
305
+ list: null,
306
+ repeatable: [],
307
+ body: "none",
308
+ status: 200,
309
+ requestMoney: [],
310
+ responseMoney: [],
311
+ },
312
+ getClientAnomalies: {
313
+ method: "GET",
314
+ path: "/v1/clients/{id}/anomalies",
315
+ access: "KeyOrSession",
316
+ scope: "read",
317
+ idempotent: false,
318
+ list: null,
319
+ repeatable: [],
320
+ body: "none",
321
+ status: 200,
322
+ requestMoney: [],
323
+ responseMoney: [
324
+ ["cost_spikes", "*", "baseline"],
325
+ ["cost_spikes", "*", "cost"],
326
+ ],
327
+ },
328
+ getClientCost: {
329
+ method: "GET",
330
+ path: "/v1/clients/{id}/cost",
331
+ access: "KeyOrSession",
332
+ scope: "read",
333
+ idempotent: false,
334
+ list: null,
335
+ repeatable: [],
336
+ body: "none",
337
+ status: 200,
338
+ requestMoney: [],
339
+ responseMoney: [
340
+ ["agent_lines", "*", "manual"],
341
+ ["agent_lines", "*", "pass_through"],
342
+ ["agent_lines", "*", "token_valued"],
343
+ ["agent_lines", "*", "total"],
344
+ ["coverage", "partially_covered_line_items", "*", "monthly_amount"],
345
+ ["coverage", "partially_covered_line_items", "*", "total"],
346
+ ["manual"],
347
+ ["manual_lines", "*", "monthly_amount"],
348
+ ["manual_lines", "*", "total"],
349
+ ["pass_through"],
350
+ ["token_lines", "*", "in_rate"],
351
+ ["token_lines", "*", "out_rate"],
352
+ ["token_lines", "*", "total"],
353
+ ["token_valued"],
354
+ ["total"],
355
+ ],
356
+ },
357
+ getClientRoi: {
358
+ method: "GET",
359
+ path: "/v1/clients/{id}/roi",
360
+ access: "KeyOrSession",
361
+ scope: "read",
362
+ idempotent: false,
363
+ list: null,
364
+ repeatable: [],
365
+ body: "none",
366
+ status: 200,
367
+ requestMoney: [],
368
+ responseMoney: [
369
+ ["cost", "agent_lines", "*", "manual"],
370
+ ["cost", "agent_lines", "*", "pass_through"],
371
+ ["cost", "agent_lines", "*", "token_valued"],
372
+ ["cost", "agent_lines", "*", "total"],
373
+ [
374
+ "cost",
375
+ "coverage",
376
+ "partially_covered_line_items",
377
+ "*",
378
+ "monthly_amount",
379
+ ],
380
+ ["cost", "coverage", "partially_covered_line_items", "*", "total"],
381
+ ["cost", "manual"],
382
+ ["cost", "manual_lines", "*", "monthly_amount"],
383
+ ["cost", "manual_lines", "*", "total"],
384
+ ["cost", "pass_through"],
385
+ ["cost", "token_lines", "*", "in_rate"],
386
+ ["cost", "token_lines", "*", "out_rate"],
387
+ ["cost", "token_lines", "*", "total"],
388
+ ["cost", "token_valued"],
389
+ ["cost", "total"],
390
+ ["value", "lines", "*", "total"],
391
+ ["value", "lines", "*", "unit_value"],
392
+ ["value", "total"],
393
+ ],
394
+ },
395
+ getClientValue: {
396
+ method: "GET",
397
+ path: "/v1/clients/{id}/value",
398
+ access: "KeyOrSession",
399
+ scope: "read",
400
+ idempotent: false,
401
+ list: null,
402
+ repeatable: [],
403
+ body: "none",
404
+ status: 200,
405
+ requestMoney: [],
406
+ responseMoney: [
407
+ ["lines", "*", "total"],
408
+ ["lines", "*", "unit_value"],
409
+ ["total"],
410
+ ],
411
+ },
412
+ getClientValueModel: {
413
+ method: "GET",
414
+ path: "/v1/clients/{id}/value-model",
415
+ access: "KeyOrSession",
416
+ scope: "read",
417
+ idempotent: false,
418
+ list: null,
419
+ repeatable: [],
420
+ body: "none",
421
+ status: 200,
422
+ requestMoney: [],
423
+ responseMoney: [["line_items", "*", "unit_value"]],
424
+ },
425
+ getCostLineItem: {
426
+ method: "GET",
427
+ path: "/v1/cost-line-items/{id}",
428
+ access: "KeyOrSession",
429
+ scope: "read",
430
+ idempotent: false,
431
+ list: null,
432
+ repeatable: [],
433
+ body: "none",
434
+ status: 200,
435
+ requestMoney: [],
436
+ responseMoney: [["monthly_amount"]],
437
+ },
438
+ getDashboard: {
439
+ method: "GET",
440
+ path: "/v1/dashboard",
441
+ access: "KeyOrSession",
442
+ scope: "read",
443
+ idempotent: false,
444
+ list: null,
445
+ repeatable: [],
446
+ body: "none",
447
+ status: 200,
448
+ requestMoney: [],
449
+ responseMoney: [
450
+ ["agent_costs", "*", "manual"],
451
+ ["agent_costs", "*", "pass_through"],
452
+ ["agent_costs", "*", "token_valued"],
453
+ ["agent_costs", "*", "total"],
454
+ ["clients", "*", "cost_total"],
455
+ ["clients", "*", "value_total"],
456
+ ["cost_components", "manual"],
457
+ ["cost_components", "pass_through"],
458
+ ["cost_components", "token_valued"],
459
+ ["cost_total"],
460
+ ["top_clients", "*", "cost_total"],
461
+ ["top_clients", "*", "value_total"],
462
+ ["unallocated_charges", "*", "total"],
463
+ ["value_by_outcome", "*", "total"],
464
+ ["value_by_outcome_omitted_total"],
465
+ ["value_total"],
466
+ ],
467
+ },
468
+ getEventSummary: {
469
+ method: "GET",
470
+ path: "/v1/events/summary",
471
+ access: "KeyOrSession",
472
+ scope: "read",
473
+ idempotent: false,
474
+ list: null,
475
+ repeatable: [],
476
+ body: "none",
477
+ status: 200,
478
+ requestMoney: [],
479
+ responseMoney: [],
480
+ },
481
+ getHealth: {
482
+ method: "GET",
483
+ path: "/healthz",
484
+ access: "Public",
485
+ scope: null,
486
+ idempotent: false,
487
+ list: null,
488
+ repeatable: [],
489
+ body: "none",
490
+ status: 200,
491
+ requestMoney: [],
492
+ responseMoney: [],
493
+ },
494
+ getImport: {
495
+ method: "GET",
496
+ path: "/v1/imports/{id}",
497
+ access: "KeyOrSession",
498
+ scope: "read",
499
+ idempotent: false,
500
+ list: null,
501
+ repeatable: [],
502
+ body: "none",
503
+ status: 200,
504
+ requestMoney: [],
505
+ responseMoney: [],
506
+ },
507
+ getOnboarding: {
508
+ method: "GET",
509
+ path: "/v1/onboarding",
510
+ access: "KeyOrSession",
511
+ scope: "read",
512
+ idempotent: false,
513
+ list: null,
514
+ repeatable: [],
515
+ body: "none",
516
+ status: 200,
517
+ requestMoney: [],
518
+ responseMoney: [],
519
+ },
520
+ getPriceTable: {
521
+ method: "GET",
522
+ path: "/v1/price-table",
523
+ access: "KeyOrSession",
524
+ scope: "read",
525
+ idempotent: false,
526
+ list: null,
527
+ repeatable: [],
528
+ body: "none",
529
+ status: 200,
530
+ requestMoney: [],
531
+ responseMoney: [
532
+ ["models", "*", "input_per_1k"],
533
+ ["models", "*", "output_per_1k"],
534
+ ],
535
+ },
536
+ getReport: {
537
+ method: "GET",
538
+ path: "/v1/reports/{id}",
539
+ access: "KeyOrSession",
540
+ scope: "read",
541
+ idempotent: false,
542
+ list: null,
543
+ repeatable: [],
544
+ body: "none",
545
+ status: 200,
546
+ requestMoney: [],
547
+ responseMoney: [
548
+ ["preview", "compared_to", "cost_total"],
549
+ ["preview", "compared_to", "value_total"],
550
+ ["preview", "snapshot", "cost", "manual"],
551
+ ["preview", "snapshot", "cost", "pass_through"],
552
+ ["preview", "snapshot", "cost", "token_valued"],
553
+ ["preview", "snapshot", "cost", "total"],
554
+ ["preview", "snapshot", "value", "lines", "*", "total"],
555
+ ["preview", "snapshot", "value", "lines", "*", "unit_value"],
556
+ ["preview", "snapshot", "value", "total"],
557
+ ],
558
+ },
559
+ getSharedReport: {
560
+ method: "GET",
561
+ path: "/report",
562
+ access: "ShareToken",
563
+ scope: null,
564
+ idempotent: false,
565
+ list: null,
566
+ repeatable: [],
567
+ body: "none",
568
+ status: 200,
569
+ requestMoney: [],
570
+ responseMoney: [
571
+ ["compared_to", "cost_total"],
572
+ ["compared_to", "value_total"],
573
+ ["snapshot", "cost", "manual"],
574
+ ["snapshot", "cost", "pass_through"],
575
+ ["snapshot", "cost", "token_valued"],
576
+ ["snapshot", "cost", "total"],
577
+ ["snapshot", "value", "lines", "*", "total"],
578
+ ["snapshot", "value", "lines", "*", "unit_value"],
579
+ ["snapshot", "value", "total"],
580
+ ],
581
+ },
582
+ getValueModel: {
583
+ method: "GET",
584
+ path: "/v1/value-models/{id}",
585
+ access: "KeyOrSession",
586
+ scope: "read",
587
+ idempotent: false,
588
+ list: null,
589
+ repeatable: [],
590
+ body: "none",
591
+ status: 200,
592
+ requestMoney: [],
593
+ responseMoney: [["line_items", "*", "unit_value"]],
594
+ },
595
+ getWorkspace: {
596
+ method: "GET",
597
+ path: "/v1/workspace",
598
+ access: "KeyOrSession",
599
+ scope: "read",
600
+ idempotent: false,
601
+ list: null,
602
+ repeatable: [],
603
+ body: "none",
604
+ status: 200,
605
+ requestMoney: [],
606
+ responseMoney: [],
607
+ },
608
+ ingestEvents: {
609
+ method: "POST",
610
+ path: "/v1/events",
611
+ access: "KeyOnly",
612
+ scope: "ingest",
613
+ idempotent: false,
614
+ list: null,
615
+ repeatable: [],
616
+ body: "json",
617
+ status: 200,
618
+ requestMoney: [["events", "*", "cost"]],
619
+ responseMoney: [],
620
+ },
621
+ listAgents: {
622
+ method: "GET",
623
+ path: "/v1/agents",
624
+ access: "KeyOrSession",
625
+ scope: "read",
626
+ idempotent: false,
627
+ list: "keyset",
628
+ repeatable: [],
629
+ body: "none",
630
+ status: 200,
631
+ requestMoney: [],
632
+ responseMoney: [],
633
+ },
634
+ listApiKeys: {
635
+ method: "GET",
636
+ path: "/v1/api-keys",
637
+ access: "SessionOnly",
638
+ scope: null,
639
+ idempotent: false,
640
+ list: "keyset",
641
+ repeatable: [],
642
+ body: "none",
643
+ status: 200,
644
+ requestMoney: [],
645
+ responseMoney: [],
646
+ },
647
+ listCalculationReports: {
648
+ method: "GET",
649
+ path: "/v1/calculations/{id}/reports",
650
+ access: "KeyOrSession",
651
+ scope: "read",
652
+ idempotent: false,
653
+ list: "keyset",
654
+ repeatable: [],
655
+ body: "none",
656
+ status: 200,
657
+ requestMoney: [],
658
+ responseMoney: [],
659
+ },
660
+ listCalculations: {
661
+ method: "GET",
662
+ path: "/v1/calculations",
663
+ access: "KeyOrSession",
664
+ scope: "read",
665
+ idempotent: false,
666
+ list: "keyset",
667
+ repeatable: [],
668
+ body: "none",
669
+ status: 200,
670
+ requestMoney: [],
671
+ responseMoney: [
672
+ ["data", "*", "cost_total"],
673
+ ["data", "*", "value_total"],
674
+ ],
675
+ },
676
+ listClientCalculations: {
677
+ method: "GET",
678
+ path: "/v1/clients/{id}/calculations",
679
+ access: "KeyOrSession",
680
+ scope: "read",
681
+ idempotent: false,
682
+ list: "keyset",
683
+ repeatable: [],
684
+ body: "none",
685
+ status: 200,
686
+ requestMoney: [],
687
+ responseMoney: [
688
+ ["data", "*", "cost_total"],
689
+ ["data", "*", "value_total"],
690
+ ],
691
+ },
692
+ listClientEvents: {
693
+ method: "GET",
694
+ path: "/v1/clients/{id}/events",
695
+ access: "KeyOrSession",
696
+ scope: "read",
697
+ idempotent: false,
698
+ list: "offset",
699
+ repeatable: [],
700
+ body: "none",
701
+ status: 200,
702
+ requestMoney: [],
703
+ responseMoney: [["data", "*", "cost"]],
704
+ },
705
+ listClientOutcomeTypes: {
706
+ method: "GET",
707
+ path: "/v1/clients/{id}/outcome-types",
708
+ access: "KeyOrSession",
709
+ scope: "read",
710
+ idempotent: false,
711
+ list: "offset",
712
+ repeatable: [],
713
+ body: "none",
714
+ status: 200,
715
+ requestMoney: [],
716
+ responseMoney: [],
717
+ },
718
+ listClients: {
719
+ method: "GET",
720
+ path: "/v1/clients",
721
+ access: "KeyOrSession",
722
+ scope: "read",
723
+ idempotent: false,
724
+ list: "keyset",
725
+ repeatable: [],
726
+ body: "none",
727
+ status: 200,
728
+ requestMoney: [],
729
+ responseMoney: [],
730
+ },
731
+ listCostLineItems: {
732
+ method: "GET",
733
+ path: "/v1/cost-line-items",
734
+ access: "KeyOrSession",
735
+ scope: "read",
736
+ idempotent: false,
737
+ list: "keyset",
738
+ repeatable: [],
739
+ body: "none",
740
+ status: 200,
741
+ requestMoney: [],
742
+ responseMoney: [["data", "*", "monthly_amount"]],
743
+ },
744
+ listEventArrivals: {
745
+ method: "GET",
746
+ path: "/v1/events/arrivals",
747
+ access: "KeyOrSession",
748
+ scope: "read",
749
+ idempotent: false,
750
+ list: "keyset",
751
+ repeatable: [],
752
+ body: "none",
753
+ status: 200,
754
+ requestMoney: [],
755
+ responseMoney: [["data", "*", "cost"]],
756
+ },
757
+ listEvents: {
758
+ method: "GET",
759
+ path: "/v1/events",
760
+ access: "KeyOrSession",
761
+ scope: "read",
762
+ idempotent: false,
763
+ list: "keyset",
764
+ repeatable: [],
765
+ body: "none",
766
+ status: 200,
767
+ requestMoney: [],
768
+ responseMoney: [["data", "*", "cost"]],
769
+ },
770
+ listImports: {
771
+ method: "GET",
772
+ path: "/v1/imports",
773
+ access: "KeyOrSession",
774
+ scope: "read",
775
+ idempotent: false,
776
+ list: "keyset",
777
+ repeatable: [],
778
+ body: "none",
779
+ status: 200,
780
+ requestMoney: [],
781
+ responseMoney: [],
782
+ },
783
+ listOutcomeTypes: {
784
+ method: "GET",
785
+ path: "/v1/outcome-types",
786
+ access: "KeyOrSession",
787
+ scope: "read",
788
+ idempotent: false,
789
+ list: "offset",
790
+ repeatable: [],
791
+ body: "none",
792
+ status: 200,
793
+ requestMoney: [],
794
+ responseMoney: [],
795
+ },
796
+ listRenewals: {
797
+ method: "GET",
798
+ path: "/v1/dashboard/renewals",
799
+ access: "KeyOrSession",
800
+ scope: "read",
801
+ idempotent: false,
802
+ list: "offset",
803
+ repeatable: ["renewal_term"],
804
+ body: "none",
805
+ status: 200,
806
+ requestMoney: [],
807
+ responseMoney: [],
808
+ },
809
+ listReports: {
810
+ method: "GET",
811
+ path: "/v1/reports",
812
+ access: "KeyOrSession",
813
+ scope: "read",
814
+ idempotent: false,
815
+ list: "keyset",
816
+ repeatable: [],
817
+ body: "none",
818
+ status: 200,
819
+ requestMoney: [],
820
+ responseMoney: [],
821
+ },
822
+ listValueModels: {
823
+ method: "GET",
824
+ path: "/v1/value-models",
825
+ access: "KeyOrSession",
826
+ scope: "read",
827
+ idempotent: false,
828
+ list: "keyset",
829
+ repeatable: [],
830
+ body: "none",
831
+ status: 200,
832
+ requestMoney: [],
833
+ responseMoney: [],
834
+ },
835
+ listValueTemplates: {
836
+ method: "GET",
837
+ path: "/v1/value-templates",
838
+ access: "KeyOrSession",
839
+ scope: "read",
840
+ idempotent: false,
841
+ list: "offset",
842
+ repeatable: [],
843
+ body: "none",
844
+ status: 200,
845
+ requestMoney: [],
846
+ responseMoney: [["data", "*", "line_items", "*", "unit_value"]],
847
+ },
848
+ previewImport: {
849
+ method: "POST",
850
+ path: "/v1/imports/preview",
851
+ access: "KeyOrSession",
852
+ scope: "ingest",
853
+ idempotent: false,
854
+ list: null,
855
+ repeatable: [],
856
+ body: "multipart",
857
+ status: 200,
858
+ requestMoney: [],
859
+ responseMoney: [["preview", "*", "event", "cost"]],
860
+ },
861
+ publishCalculation: {
862
+ method: "POST",
863
+ path: "/v1/calculations/{id}/publish",
864
+ access: "SessionOnly",
865
+ scope: null,
866
+ idempotent: false,
867
+ list: null,
868
+ repeatable: [],
869
+ body: "none",
870
+ status: 200,
871
+ requestMoney: [],
872
+ responseMoney: [
873
+ ["cost_total"],
874
+ ["snapshot", "cost", "agent_lines", "*", "manual"],
875
+ ["snapshot", "cost", "agent_lines", "*", "pass_through"],
876
+ ["snapshot", "cost", "agent_lines", "*", "token_valued"],
877
+ ["snapshot", "cost", "agent_lines", "*", "total"],
878
+ [
879
+ "snapshot",
880
+ "cost",
881
+ "coverage",
882
+ "partially_covered_line_items",
883
+ "*",
884
+ "monthly_amount",
885
+ ],
886
+ [
887
+ "snapshot",
888
+ "cost",
889
+ "coverage",
890
+ "partially_covered_line_items",
891
+ "*",
892
+ "total",
893
+ ],
894
+ ["snapshot", "cost", "manual"],
895
+ ["snapshot", "cost", "manual_lines", "*", "monthly_amount"],
896
+ ["snapshot", "cost", "manual_lines", "*", "total"],
897
+ ["snapshot", "cost", "pass_through"],
898
+ ["snapshot", "cost", "token_lines", "*", "in_rate"],
899
+ ["snapshot", "cost", "token_lines", "*", "out_rate"],
900
+ ["snapshot", "cost", "token_lines", "*", "total"],
901
+ ["snapshot", "cost", "token_valued"],
902
+ ["snapshot", "cost", "total"],
903
+ ["snapshot", "value", "lines", "*", "total"],
904
+ ["snapshot", "value", "lines", "*", "unit_value"],
905
+ ["snapshot", "value", "total"],
906
+ ["value_total"],
907
+ ],
908
+ },
909
+ reopenCalculation: {
910
+ method: "POST",
911
+ path: "/v1/calculations/{id}/reopen",
912
+ access: "SessionOnly",
913
+ scope: null,
914
+ idempotent: false,
915
+ list: null,
916
+ repeatable: [],
917
+ body: "none",
918
+ status: 200,
919
+ requestMoney: [],
920
+ responseMoney: [
921
+ ["cost_total"],
922
+ ["snapshot", "cost", "agent_lines", "*", "manual"],
923
+ ["snapshot", "cost", "agent_lines", "*", "pass_through"],
924
+ ["snapshot", "cost", "agent_lines", "*", "token_valued"],
925
+ ["snapshot", "cost", "agent_lines", "*", "total"],
926
+ [
927
+ "snapshot",
928
+ "cost",
929
+ "coverage",
930
+ "partially_covered_line_items",
931
+ "*",
932
+ "monthly_amount",
933
+ ],
934
+ [
935
+ "snapshot",
936
+ "cost",
937
+ "coverage",
938
+ "partially_covered_line_items",
939
+ "*",
940
+ "total",
941
+ ],
942
+ ["snapshot", "cost", "manual"],
943
+ ["snapshot", "cost", "manual_lines", "*", "monthly_amount"],
944
+ ["snapshot", "cost", "manual_lines", "*", "total"],
945
+ ["snapshot", "cost", "pass_through"],
946
+ ["snapshot", "cost", "token_lines", "*", "in_rate"],
947
+ ["snapshot", "cost", "token_lines", "*", "out_rate"],
948
+ ["snapshot", "cost", "token_lines", "*", "total"],
949
+ ["snapshot", "cost", "token_valued"],
950
+ ["snapshot", "cost", "total"],
951
+ ["snapshot", "value", "lines", "*", "total"],
952
+ ["snapshot", "value", "lines", "*", "unit_value"],
953
+ ["snapshot", "value", "total"],
954
+ ["value_total"],
955
+ ],
956
+ },
957
+ revokeApiKey: {
958
+ method: "POST",
959
+ path: "/v1/api-keys/{id}/revoke",
960
+ access: "SessionOnly",
961
+ scope: null,
962
+ idempotent: false,
963
+ list: null,
964
+ repeatable: [],
965
+ body: "none",
966
+ status: 200,
967
+ requestMoney: [],
968
+ responseMoney: [],
969
+ },
970
+ revokeReport: {
971
+ method: "POST",
972
+ path: "/v1/reports/{id}/revoke",
973
+ access: "SessionOnly",
974
+ scope: null,
975
+ idempotent: false,
976
+ list: null,
977
+ repeatable: [],
978
+ body: "none",
979
+ status: 200,
980
+ requestMoney: [],
981
+ responseMoney: [],
982
+ },
983
+ setClientAgents: {
984
+ method: "PUT",
985
+ path: "/v1/clients/{id}/agents",
986
+ access: "KeyOrSession",
987
+ scope: "write",
988
+ idempotent: false,
989
+ list: null,
990
+ repeatable: [],
991
+ body: "json",
992
+ status: 200,
993
+ requestMoney: [],
994
+ responseMoney: [],
995
+ },
996
+ setOnboardingSkippedSteps: {
997
+ method: "PUT",
998
+ path: "/v1/onboarding/skipped-steps",
999
+ access: "KeyOrSession",
1000
+ scope: "write",
1001
+ idempotent: false,
1002
+ list: null,
1003
+ repeatable: [],
1004
+ body: "json",
1005
+ status: 200,
1006
+ requestMoney: [],
1007
+ responseMoney: [],
1008
+ },
1009
+ setPriceTable: {
1010
+ method: "PUT",
1011
+ path: "/v1/price-table",
1012
+ access: "KeyOrSession",
1013
+ scope: "write",
1014
+ idempotent: false,
1015
+ list: null,
1016
+ repeatable: [],
1017
+ body: "json",
1018
+ status: 200,
1019
+ requestMoney: [
1020
+ ["models", "*", "input_per_1k"],
1021
+ ["models", "*", "output_per_1k"],
1022
+ ],
1023
+ responseMoney: [
1024
+ ["models", "*", "input_per_1k"],
1025
+ ["models", "*", "output_per_1k"],
1026
+ ],
1027
+ },
1028
+ setValueModelLineItems: {
1029
+ method: "PUT",
1030
+ path: "/v1/clients/{id}/value-model/line-items",
1031
+ access: "KeyOrSession",
1032
+ scope: "write",
1033
+ idempotent: false,
1034
+ list: null,
1035
+ repeatable: [],
1036
+ body: "json",
1037
+ status: 200,
1038
+ requestMoney: [["line_items", "*", "unit_value"]],
1039
+ responseMoney: [["line_items", "*", "unit_value"]],
1040
+ },
1041
+ shareReport: {
1042
+ method: "POST",
1043
+ path: "/v1/reports/{id}/share",
1044
+ access: "SessionOnly",
1045
+ scope: null,
1046
+ idempotent: false,
1047
+ list: null,
1048
+ repeatable: [],
1049
+ body: "none",
1050
+ status: 200,
1051
+ requestMoney: [],
1052
+ responseMoney: [],
1053
+ },
1054
+ updateAgent: {
1055
+ method: "PATCH",
1056
+ path: "/v1/agents/{id}",
1057
+ access: "KeyOrSession",
1058
+ scope: "write",
1059
+ idempotent: false,
1060
+ list: null,
1061
+ repeatable: [],
1062
+ body: "merge-patch",
1063
+ status: 200,
1064
+ requestMoney: [],
1065
+ responseMoney: [],
1066
+ },
1067
+ updateClient: {
1068
+ method: "PATCH",
1069
+ path: "/v1/clients/{id}",
1070
+ access: "KeyOrSession",
1071
+ scope: "write",
1072
+ idempotent: false,
1073
+ list: null,
1074
+ repeatable: [],
1075
+ body: "merge-patch",
1076
+ status: 200,
1077
+ requestMoney: [],
1078
+ responseMoney: [],
1079
+ },
1080
+ updateCostLineItem: {
1081
+ method: "PATCH",
1082
+ path: "/v1/cost-line-items/{id}",
1083
+ access: "KeyOrSession",
1084
+ scope: "write",
1085
+ idempotent: false,
1086
+ list: null,
1087
+ repeatable: [],
1088
+ body: "merge-patch",
1089
+ status: 200,
1090
+ requestMoney: [["monthly_amount"]],
1091
+ responseMoney: [["monthly_amount"]],
1092
+ },
1093
+ updateReport: {
1094
+ method: "PATCH",
1095
+ path: "/v1/reports/{id}",
1096
+ access: "KeyOrSession",
1097
+ scope: "write",
1098
+ idempotent: false,
1099
+ list: null,
1100
+ repeatable: [],
1101
+ body: "merge-patch",
1102
+ status: 200,
1103
+ requestMoney: [],
1104
+ responseMoney: [],
1105
+ },
1106
+ updateValueModel: {
1107
+ method: "PATCH",
1108
+ path: "/v1/clients/{id}/value-model",
1109
+ access: "KeyOrSession",
1110
+ scope: "write",
1111
+ idempotent: false,
1112
+ list: null,
1113
+ repeatable: [],
1114
+ body: "merge-patch",
1115
+ status: 200,
1116
+ requestMoney: [],
1117
+ responseMoney: [["line_items", "*", "unit_value"]],
1118
+ },
1119
+ validateCalculation: {
1120
+ method: "POST",
1121
+ path: "/v1/calculations/{id}/validate",
1122
+ access: "SessionOnly",
1123
+ scope: null,
1124
+ idempotent: false,
1125
+ list: null,
1126
+ repeatable: [],
1127
+ body: "json",
1128
+ status: 200,
1129
+ requestMoney: [],
1130
+ responseMoney: [
1131
+ ["cost_total"],
1132
+ ["snapshot", "cost", "agent_lines", "*", "manual"],
1133
+ ["snapshot", "cost", "agent_lines", "*", "pass_through"],
1134
+ ["snapshot", "cost", "agent_lines", "*", "token_valued"],
1135
+ ["snapshot", "cost", "agent_lines", "*", "total"],
1136
+ [
1137
+ "snapshot",
1138
+ "cost",
1139
+ "coverage",
1140
+ "partially_covered_line_items",
1141
+ "*",
1142
+ "monthly_amount",
1143
+ ],
1144
+ [
1145
+ "snapshot",
1146
+ "cost",
1147
+ "coverage",
1148
+ "partially_covered_line_items",
1149
+ "*",
1150
+ "total",
1151
+ ],
1152
+ ["snapshot", "cost", "manual"],
1153
+ ["snapshot", "cost", "manual_lines", "*", "monthly_amount"],
1154
+ ["snapshot", "cost", "manual_lines", "*", "total"],
1155
+ ["snapshot", "cost", "pass_through"],
1156
+ ["snapshot", "cost", "token_lines", "*", "in_rate"],
1157
+ ["snapshot", "cost", "token_lines", "*", "out_rate"],
1158
+ ["snapshot", "cost", "token_lines", "*", "total"],
1159
+ ["snapshot", "cost", "token_valued"],
1160
+ ["snapshot", "cost", "total"],
1161
+ ["snapshot", "value", "lines", "*", "total"],
1162
+ ["snapshot", "value", "lines", "*", "unit_value"],
1163
+ ["snapshot", "value", "total"],
1164
+ ["value_total"],
1165
+ ],
1166
+ },
1167
+ };