@comms-id/asx 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,894 @@
1
+ // Generated by @comms-id/forge-transformers from the service's OpenAPI contract. Do not edit: change the contract and regenerate.
2
+ /** The operations of Comms.ID ASX, with the schemas the client checks. */
3
+ export const operations = {
4
+ lookup: {
5
+ name: "lookup",
6
+ method: "POST",
7
+ path: "/asx/v1/lookup",
8
+ safeToRetry: true,
9
+ request: {
10
+ "t": "obj",
11
+ "props": {
12
+ "ticker": {
13
+ "t": "str",
14
+ "max": 128
15
+ },
16
+ "mode": {
17
+ "t": "str",
18
+ "values": [
19
+ "live",
20
+ "snapshot",
21
+ "live-first"
22
+ ]
23
+ }
24
+ },
25
+ "req": [
26
+ "ticker"
27
+ ],
28
+ "extra": false
29
+ },
30
+ response: {
31
+ "t": "any_of",
32
+ "of": [
33
+ {
34
+ "t": "obj",
35
+ "props": {
36
+ "status": {
37
+ "t": "str",
38
+ "values": [
39
+ "found"
40
+ ]
41
+ },
42
+ "source": {
43
+ "t": "str",
44
+ "values": [
45
+ "live"
46
+ ]
47
+ },
48
+ "observation": {
49
+ "t": "obj",
50
+ "props": {
51
+ "company": {
52
+ "t": "obj",
53
+ "props": {
54
+ "raw": {
55
+ "t": "obj",
56
+ "props": {},
57
+ "req": [],
58
+ "extra": true
59
+ },
60
+ "ticker": {
61
+ "t": "str",
62
+ "pattern": "^[A-Z0-9]{1,12}$"
63
+ },
64
+ "sourceId": {
65
+ "t": "str"
66
+ },
67
+ "companyName": {
68
+ "t": "str"
69
+ },
70
+ "address": {
71
+ "t": "any_of",
72
+ "of": [
73
+ {
74
+ "t": "str"
75
+ },
76
+ {
77
+ "t": "null"
78
+ }
79
+ ]
80
+ },
81
+ "tel": {
82
+ "t": "any_of",
83
+ "of": [
84
+ {
85
+ "t": "str"
86
+ },
87
+ {
88
+ "t": "null"
89
+ }
90
+ ]
91
+ },
92
+ "fax": {
93
+ "t": "any_of",
94
+ "of": [
95
+ {
96
+ "t": "str"
97
+ },
98
+ {
99
+ "t": "null"
100
+ }
101
+ ]
102
+ },
103
+ "website": {
104
+ "t": "any_of",
105
+ "of": [
106
+ {
107
+ "t": "str"
108
+ },
109
+ {
110
+ "t": "null"
111
+ }
112
+ ]
113
+ },
114
+ "description": {
115
+ "t": "any_of",
116
+ "of": [
117
+ {
118
+ "t": "str"
119
+ },
120
+ {
121
+ "t": "null"
122
+ }
123
+ ]
124
+ },
125
+ "issueType": {
126
+ "t": "any_of",
127
+ "of": [
128
+ {
129
+ "t": "str"
130
+ },
131
+ {
132
+ "t": "null"
133
+ }
134
+ ]
135
+ },
136
+ "foreignExempt": {
137
+ "t": "any_of",
138
+ "of": [
139
+ {
140
+ "t": "bool"
141
+ },
142
+ {
143
+ "t": "null"
144
+ }
145
+ ]
146
+ },
147
+ "people": {
148
+ "t": "arr",
149
+ "of": {
150
+ "t": "obj",
151
+ "props": {
152
+ "sourceName": {
153
+ "t": "str"
154
+ },
155
+ "displayName": {
156
+ "t": "str"
157
+ },
158
+ "title": {
159
+ "t": "str"
160
+ },
161
+ "sourceCategory": {
162
+ "t": "str",
163
+ "values": [
164
+ "directors",
165
+ "secretaries"
166
+ ]
167
+ }
168
+ },
169
+ "req": [
170
+ "sourceName",
171
+ "displayName",
172
+ "title",
173
+ "sourceCategory"
174
+ ],
175
+ "extra": false
176
+ }
177
+ }
178
+ },
179
+ "req": [
180
+ "ticker",
181
+ "sourceId",
182
+ "companyName",
183
+ "address",
184
+ "tel",
185
+ "fax",
186
+ "website",
187
+ "description",
188
+ "issueType",
189
+ "foreignExempt",
190
+ "people"
191
+ ],
192
+ "extra": false
193
+ },
194
+ "startedAt": {
195
+ "t": "str",
196
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
197
+ },
198
+ "observedAt": {
199
+ "t": "str",
200
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
201
+ },
202
+ "lastChangedAt": {
203
+ "t": "str",
204
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
205
+ }
206
+ },
207
+ "req": [
208
+ "company",
209
+ "startedAt",
210
+ "observedAt",
211
+ "lastChangedAt"
212
+ ],
213
+ "extra": false
214
+ }
215
+ },
216
+ "req": [
217
+ "status",
218
+ "source",
219
+ "observation"
220
+ ],
221
+ "extra": false
222
+ },
223
+ {
224
+ "t": "obj",
225
+ "props": {
226
+ "status": {
227
+ "t": "str",
228
+ "values": [
229
+ "missing"
230
+ ]
231
+ },
232
+ "source": {
233
+ "t": "str",
234
+ "values": [
235
+ "live"
236
+ ]
237
+ },
238
+ "startedAt": {
239
+ "t": "str",
240
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
241
+ },
242
+ "observedAt": {
243
+ "t": "str",
244
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
245
+ }
246
+ },
247
+ "req": [
248
+ "status",
249
+ "source",
250
+ "startedAt",
251
+ "observedAt"
252
+ ],
253
+ "extra": false
254
+ },
255
+ {
256
+ "t": "obj",
257
+ "props": {
258
+ "status": {
259
+ "t": "str",
260
+ "values": [
261
+ "found"
262
+ ]
263
+ },
264
+ "source": {
265
+ "t": "str",
266
+ "values": [
267
+ "snapshot"
268
+ ]
269
+ },
270
+ "observation": {
271
+ "t": "obj",
272
+ "props": {
273
+ "company": {
274
+ "t": "obj",
275
+ "props": {
276
+ "raw": {
277
+ "t": "obj",
278
+ "props": {},
279
+ "req": [],
280
+ "extra": true
281
+ },
282
+ "ticker": {
283
+ "t": "str",
284
+ "pattern": "^[A-Z0-9]{1,12}$"
285
+ },
286
+ "sourceId": {
287
+ "t": "str"
288
+ },
289
+ "companyName": {
290
+ "t": "str"
291
+ },
292
+ "address": {
293
+ "t": "any_of",
294
+ "of": [
295
+ {
296
+ "t": "str"
297
+ },
298
+ {
299
+ "t": "null"
300
+ }
301
+ ]
302
+ },
303
+ "tel": {
304
+ "t": "any_of",
305
+ "of": [
306
+ {
307
+ "t": "str"
308
+ },
309
+ {
310
+ "t": "null"
311
+ }
312
+ ]
313
+ },
314
+ "fax": {
315
+ "t": "any_of",
316
+ "of": [
317
+ {
318
+ "t": "str"
319
+ },
320
+ {
321
+ "t": "null"
322
+ }
323
+ ]
324
+ },
325
+ "website": {
326
+ "t": "any_of",
327
+ "of": [
328
+ {
329
+ "t": "str"
330
+ },
331
+ {
332
+ "t": "null"
333
+ }
334
+ ]
335
+ },
336
+ "description": {
337
+ "t": "any_of",
338
+ "of": [
339
+ {
340
+ "t": "str"
341
+ },
342
+ {
343
+ "t": "null"
344
+ }
345
+ ]
346
+ },
347
+ "issueType": {
348
+ "t": "any_of",
349
+ "of": [
350
+ {
351
+ "t": "str"
352
+ },
353
+ {
354
+ "t": "null"
355
+ }
356
+ ]
357
+ },
358
+ "foreignExempt": {
359
+ "t": "any_of",
360
+ "of": [
361
+ {
362
+ "t": "bool"
363
+ },
364
+ {
365
+ "t": "null"
366
+ }
367
+ ]
368
+ },
369
+ "people": {
370
+ "t": "arr",
371
+ "of": {
372
+ "t": "obj",
373
+ "props": {
374
+ "sourceName": {
375
+ "t": "str"
376
+ },
377
+ "displayName": {
378
+ "t": "str"
379
+ },
380
+ "title": {
381
+ "t": "str"
382
+ },
383
+ "sourceCategory": {
384
+ "t": "str",
385
+ "values": [
386
+ "directors",
387
+ "secretaries"
388
+ ]
389
+ }
390
+ },
391
+ "req": [
392
+ "sourceName",
393
+ "displayName",
394
+ "title",
395
+ "sourceCategory"
396
+ ],
397
+ "extra": false
398
+ }
399
+ }
400
+ },
401
+ "req": [
402
+ "ticker",
403
+ "sourceId",
404
+ "companyName",
405
+ "address",
406
+ "tel",
407
+ "fax",
408
+ "website",
409
+ "description",
410
+ "issueType",
411
+ "foreignExempt",
412
+ "people"
413
+ ],
414
+ "extra": false
415
+ },
416
+ "startedAt": {
417
+ "t": "str",
418
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
419
+ },
420
+ "observedAt": {
421
+ "t": "str",
422
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
423
+ },
424
+ "lastChangedAt": {
425
+ "t": "str",
426
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
427
+ }
428
+ },
429
+ "req": [
430
+ "company",
431
+ "startedAt",
432
+ "observedAt",
433
+ "lastChangedAt"
434
+ ],
435
+ "extra": false
436
+ },
437
+ "generation": {
438
+ "t": "str",
439
+ "pattern": "^[a-f0-9]{64}$"
440
+ },
441
+ "enrichment": {
442
+ "t": "obj",
443
+ "props": {
444
+ "ticker": {
445
+ "t": "str",
446
+ "pattern": "^[A-Z0-9]{1,12}$"
447
+ },
448
+ "sourceId": {
449
+ "t": "str",
450
+ "min": 1
451
+ },
452
+ "abn": {
453
+ "t": "str"
454
+ },
455
+ "acn": {
456
+ "t": "any_of",
457
+ "of": [
458
+ {
459
+ "t": "str",
460
+ "pattern": "^\\d{9}$"
461
+ },
462
+ {
463
+ "t": "null"
464
+ }
465
+ ]
466
+ },
467
+ "legalName": {
468
+ "t": "str",
469
+ "min": 1
470
+ },
471
+ "identityEvidence": {
472
+ "t": "obj",
473
+ "props": {
474
+ "url": {
475
+ "t": "str"
476
+ },
477
+ "sha256": {
478
+ "t": "str",
479
+ "pattern": "^[a-f0-9]{64}$"
480
+ },
481
+ "observedAt": {
482
+ "t": "str",
483
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
484
+ },
485
+ "kind": {
486
+ "t": "str",
487
+ "values": [
488
+ "issuer-filing",
489
+ "issuer-website"
490
+ ]
491
+ }
492
+ },
493
+ "req": [
494
+ "url",
495
+ "sha256",
496
+ "observedAt",
497
+ "kind"
498
+ ],
499
+ "extra": false
500
+ },
501
+ "abrEvidence": {
502
+ "t": "obj",
503
+ "props": {
504
+ "source": {
505
+ "t": "str",
506
+ "values": [
507
+ "abr-live",
508
+ "abr-snapshot"
509
+ ]
510
+ },
511
+ "observedAt": {
512
+ "t": "str",
513
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
514
+ }
515
+ },
516
+ "req": [
517
+ "source",
518
+ "observedAt"
519
+ ],
520
+ "extra": false
521
+ },
522
+ "website": {
523
+ "t": "any_of",
524
+ "of": [
525
+ {
526
+ "t": "obj",
527
+ "props": {
528
+ "url": {
529
+ "t": "str"
530
+ },
531
+ "evidence": {
532
+ "t": "obj",
533
+ "props": {
534
+ "url": {
535
+ "t": "str"
536
+ },
537
+ "sha256": {
538
+ "t": "str",
539
+ "pattern": "^[a-f0-9]{64}$"
540
+ },
541
+ "observedAt": {
542
+ "t": "str",
543
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
544
+ },
545
+ "kind": {
546
+ "t": "str",
547
+ "values": [
548
+ "issuer-filing",
549
+ "issuer-website"
550
+ ]
551
+ }
552
+ },
553
+ "req": [
554
+ "url",
555
+ "sha256",
556
+ "observedAt",
557
+ "kind"
558
+ ],
559
+ "extra": false
560
+ }
561
+ },
562
+ "req": [
563
+ "url",
564
+ "evidence"
565
+ ],
566
+ "extra": false
567
+ },
568
+ {
569
+ "t": "null"
570
+ }
571
+ ]
572
+ }
573
+ },
574
+ "req": [
575
+ "ticker",
576
+ "sourceId",
577
+ "abn",
578
+ "acn",
579
+ "legalName",
580
+ "identityEvidence",
581
+ "abrEvidence",
582
+ "website"
583
+ ],
584
+ "extra": false
585
+ },
586
+ "requiresRecheck": {
587
+ "t": "bool"
588
+ },
589
+ "fallbackReason": {
590
+ "t": "str",
591
+ "values": [
592
+ "INVALID_INPUT",
593
+ "PARSE_FAILED",
594
+ "SOURCE_MISMATCH",
595
+ "TRANSPORT_FAILED",
596
+ "TIMEOUT",
597
+ "RATE_LIMITED",
598
+ "UPSTREAM_UNAVAILABLE",
599
+ "CONFIGURATION_ERROR",
600
+ "SNAPSHOT_UNAVAILABLE",
601
+ "CANCELLED",
602
+ "INTERNAL_ERROR",
603
+ "ACCESS_DENIED",
604
+ "UPSTREAM_REJECTED",
605
+ "PERSISTENCE_FAILED",
606
+ "PUBLICATION_CONFLICT",
607
+ "COVERAGE_REJECTED"
608
+ ]
609
+ }
610
+ },
611
+ "req": [
612
+ "status",
613
+ "source",
614
+ "observation",
615
+ "generation",
616
+ "requiresRecheck"
617
+ ],
618
+ "extra": false
619
+ },
620
+ {
621
+ "t": "obj",
622
+ "props": {
623
+ "status": {
624
+ "t": "str",
625
+ "values": [
626
+ "missing"
627
+ ]
628
+ },
629
+ "source": {
630
+ "t": "str",
631
+ "values": [
632
+ "snapshot"
633
+ ]
634
+ },
635
+ "generation": {
636
+ "t": "str",
637
+ "pattern": "^[a-f0-9]{64}$"
638
+ }
639
+ },
640
+ "req": [
641
+ "status",
642
+ "source",
643
+ "generation"
644
+ ],
645
+ "extra": false
646
+ }
647
+ ]
648
+ },
649
+ },
650
+ suggest: {
651
+ name: "suggest",
652
+ method: "POST",
653
+ path: "/asx/v1/suggest",
654
+ safeToRetry: true,
655
+ request: {
656
+ "t": "obj",
657
+ "props": {
658
+ "mode": {
659
+ "t": "str",
660
+ "values": [
661
+ "live",
662
+ "snapshot",
663
+ "live-first"
664
+ ]
665
+ },
666
+ "query": {
667
+ "t": "str",
668
+ "max": 200
669
+ },
670
+ "limit": {
671
+ "t": "int",
672
+ "min": 1,
673
+ "max": 10
674
+ }
675
+ },
676
+ "req": [
677
+ "query"
678
+ ],
679
+ "extra": false
680
+ },
681
+ response: {
682
+ "t": "any_of",
683
+ "of": [
684
+ {
685
+ "t": "obj",
686
+ "props": {
687
+ "source": {
688
+ "t": "str",
689
+ "values": [
690
+ "live"
691
+ ]
692
+ },
693
+ "directoryObservedAt": {
694
+ "t": "str",
695
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
696
+ },
697
+ "suggestions": {
698
+ "t": "arr",
699
+ "of": {
700
+ "t": "obj",
701
+ "props": {
702
+ "ticker": {
703
+ "t": "str",
704
+ "pattern": "^[A-Z0-9]{1,12}$"
705
+ },
706
+ "companyName": {
707
+ "t": "str"
708
+ },
709
+ "industryGroup": {
710
+ "t": "any_of",
711
+ "of": [
712
+ {
713
+ "t": "str"
714
+ },
715
+ {
716
+ "t": "null"
717
+ }
718
+ ]
719
+ },
720
+ "listingDate": {
721
+ "t": "any_of",
722
+ "of": [
723
+ {
724
+ "t": "str"
725
+ },
726
+ {
727
+ "t": "null"
728
+ }
729
+ ]
730
+ },
731
+ "marketCapitalisation": {
732
+ "t": "any_of",
733
+ "of": [
734
+ {
735
+ "t": "num"
736
+ },
737
+ {
738
+ "t": "str",
739
+ "values": [
740
+ "Infinity",
741
+ "-Infinity",
742
+ "NaN"
743
+ ]
744
+ },
745
+ {
746
+ "t": "null"
747
+ }
748
+ ]
749
+ }
750
+ },
751
+ "req": [
752
+ "ticker",
753
+ "companyName",
754
+ "industryGroup",
755
+ "listingDate",
756
+ "marketCapitalisation"
757
+ ],
758
+ "extra": false
759
+ },
760
+ "max": 10
761
+ }
762
+ },
763
+ "req": [
764
+ "source",
765
+ "directoryObservedAt",
766
+ "suggestions"
767
+ ],
768
+ "extra": false
769
+ },
770
+ {
771
+ "t": "obj",
772
+ "props": {
773
+ "source": {
774
+ "t": "str",
775
+ "values": [
776
+ "snapshot"
777
+ ]
778
+ },
779
+ "generation": {
780
+ "t": "str",
781
+ "pattern": "^[a-f0-9]{64}$"
782
+ },
783
+ "directoryObservedAt": {
784
+ "t": "str",
785
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
786
+ },
787
+ "requiresRecheck": {
788
+ "t": "bool"
789
+ },
790
+ "suggestions": {
791
+ "t": "arr",
792
+ "of": {
793
+ "t": "obj",
794
+ "props": {
795
+ "ticker": {
796
+ "t": "str",
797
+ "pattern": "^[A-Z0-9]{1,12}$"
798
+ },
799
+ "companyName": {
800
+ "t": "str"
801
+ },
802
+ "industryGroup": {
803
+ "t": "any_of",
804
+ "of": [
805
+ {
806
+ "t": "str"
807
+ },
808
+ {
809
+ "t": "null"
810
+ }
811
+ ]
812
+ },
813
+ "listingDate": {
814
+ "t": "any_of",
815
+ "of": [
816
+ {
817
+ "t": "str"
818
+ },
819
+ {
820
+ "t": "null"
821
+ }
822
+ ]
823
+ },
824
+ "marketCapitalisation": {
825
+ "t": "any_of",
826
+ "of": [
827
+ {
828
+ "t": "num"
829
+ },
830
+ {
831
+ "t": "str",
832
+ "values": [
833
+ "Infinity",
834
+ "-Infinity",
835
+ "NaN"
836
+ ]
837
+ },
838
+ {
839
+ "t": "null"
840
+ }
841
+ ]
842
+ }
843
+ },
844
+ "req": [
845
+ "ticker",
846
+ "companyName",
847
+ "industryGroup",
848
+ "listingDate",
849
+ "marketCapitalisation"
850
+ ],
851
+ "extra": false
852
+ },
853
+ "max": 10
854
+ },
855
+ "fallbackReason": {
856
+ "t": "str",
857
+ "values": [
858
+ "INVALID_INPUT",
859
+ "PARSE_FAILED",
860
+ "SOURCE_MISMATCH",
861
+ "TRANSPORT_FAILED",
862
+ "TIMEOUT",
863
+ "RATE_LIMITED",
864
+ "UPSTREAM_UNAVAILABLE",
865
+ "CONFIGURATION_ERROR",
866
+ "SNAPSHOT_UNAVAILABLE",
867
+ "CANCELLED",
868
+ "INTERNAL_ERROR",
869
+ "ACCESS_DENIED",
870
+ "UPSTREAM_REJECTED",
871
+ "PERSISTENCE_FAILED",
872
+ "PUBLICATION_CONFLICT",
873
+ "COVERAGE_REJECTED"
874
+ ]
875
+ }
876
+ },
877
+ "req": [
878
+ "source",
879
+ "generation",
880
+ "directoryObservedAt",
881
+ "requiresRecheck",
882
+ "suggestions"
883
+ ],
884
+ "extra": false
885
+ }
886
+ ]
887
+ },
888
+ },
889
+ };
890
+ /** The error codes the contract documents for each operation. */
891
+ export const errorCodes = {
892
+ lookup: ["INVALID_INPUT", "UNAUTHORIZED", "VERSION_RETIRED", "FAIR_USE_CEILING", "UPSTREAM_REJECTED", "PARSE_FAILED", "SOURCE_MISMATCH", "TRANSPORT_FAILED", "RATE_LIMITED", "UPSTREAM_UNAVAILABLE", "ACCESS_DENIED", "CONFIGURATION_ERROR", "SNAPSHOT_UNAVAILABLE", "PERSISTENCE_FAILED", "TIMEOUT"],
893
+ suggest: ["INVALID_INPUT", "UNAUTHORIZED", "VERSION_RETIRED", "FAIR_USE_CEILING", "UPSTREAM_REJECTED", "PARSE_FAILED", "SOURCE_MISMATCH", "TRANSPORT_FAILED", "RATE_LIMITED", "UPSTREAM_UNAVAILABLE", "ACCESS_DENIED", "CONFIGURATION_ERROR", "SNAPSHOT_UNAVAILABLE", "PERSISTENCE_FAILED", "TIMEOUT"],
894
+ };