@alis-build/alis-open-cx-v1 1.16.0 → 1.18.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.
@@ -1,7 +1,28 @@
1
- // @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
1
+ // @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
2
2
  // @generated from file alis/open/cx/v1/cx.proto (package alis.open.cx.v1, syntax proto3)
3
3
  /* eslint-disable */
4
4
 
5
+ // Holds the attributes the Compliance Exchange (CX) engine uses to classify a
6
+ // financial instrument under regulatory and industry classification sets.
7
+ //
8
+ // The package defines no service. Its one top-level message, `Instrument`
9
+ // (`instruments/{instrument}`, keyed by a Bloomberg or custom FIGI), is
10
+ // embedded in the IN instrument (`alis.open.in.v1.Instrument`) as
11
+ // `engines.cx`. Besides basic reference data (market sector, exchange,
12
+ // currency, country, issuer), it carries one nested message per set:
13
+ //
14
+ // - `asisa`: ASISA asset class and category, credit ratings, and related
15
+ // attributes.
16
+ // - `mifid`: MiFID asset class.
17
+ // - `ucits`: UCITS eligibility attributes.
18
+ // - `reg28`: Reg 28 category and issuer attributes.
19
+ // - `cisca`: CISCA category, leverage, and index weight.
20
+ // - `reg30`: Regulation 30 (Annexure B of the Medical Schemes Act) category.
21
+ // - `sarbC23`: SARB (South African Reserve Bank) C23 form rows.
22
+ //
23
+ // Each set has a `Validation` recording whether the instrument's attributes
24
+ // meet that set's requirements and which fields need attention.
25
+
5
26
  import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
6
27
  import type { Message } from "@bufbuild/protobuf";
7
28
  import type { BoolValueJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
@@ -12,180 +33,282 @@ import type { BoolValueJson, Timestamp, TimestampJson } from "@bufbuild/protobuf
12
33
  export declare const file_alis_open_cx_v1_cx: GenFile;
13
34
 
14
35
  /**
36
+ * Instrument is a resource within the Compliance Exchange product.
37
+ *
15
38
  * @generated from message alis.open.cx.v1.Instrument
16
39
  */
17
40
  export declare type Instrument = Message<"alis.open.cx.v1.Instrument"> & {
18
41
  /**
42
+ * The instrument name is the unique identifier across organisations.
43
+ *
44
+ * Format: instruments/{instrument}. {instrument} must be a valid Bloomberg or custom FIGI as defined by www.openfigi.com..
45
+ *
19
46
  * @generated from field: string name = 1;
20
47
  */
21
48
  name: string;
22
49
 
23
50
  /**
51
+ * Figi Type. Either a global or custom FIGI, else set to unspecified
52
+ *
24
53
  * @generated from field: alis.open.cx.v1.Instrument.FigiType figi_type = 2;
25
54
  */
26
55
  figiType: Instrument_FigiType;
27
56
 
28
57
  /**
58
+ * Human readable display name
59
+ *
29
60
  * @generated from field: string display_name = 3;
30
61
  */
31
62
  displayName: string;
32
63
 
33
64
  /**
65
+ * Security Description
66
+ *
34
67
  * @generated from field: string description = 4;
35
68
  */
36
69
  description: string;
37
70
 
38
71
  /**
72
+ * Market Sector
73
+ * The asset class/category of the particular instrument
74
+ *
75
+ * Format: EQUITY, MONEY_MARKET, etc.
76
+ *
39
77
  * @generated from field: alis.open.cx.v1.Instrument.MarketSector market_sector = 5;
40
78
  */
41
79
  marketSector: Instrument_MarketSector;
42
80
 
43
81
  /**
82
+ * Exchange Code
83
+ * Code for the trading venue or environment on which the instrument trades. If an exchange is specified,
84
+ * the code will be for the specified exchange.
85
+ *
86
+ * Format: US, UN, SJ etc.
87
+ *
44
88
  * @generated from field: string exch_code = 6;
45
89
  */
46
90
  exchCode: string;
47
91
 
48
92
  /**
93
+ * Currency
94
+ * The 3-letter currency code defined in ISO 4217.
95
+ * Currency in which the security was issued. Equities: Trading currency for the security.
96
+ * Fixed Income: Provides the currency in which the bond was issued, not necessarily the currency in which
97
+ * the bond trades or pays its coupons.
98
+ *
49
99
  * @generated from field: string currency_code = 7;
50
100
  */
51
101
  currencyCode: string;
52
102
 
53
103
  /**
104
+ * The ISO country code
105
+ * (-- api-linter: core::0143::standardized-codes=disabled
106
+ * aip.dev/not-precedent: 'Country' is a well defined attributes within Finance. --)
107
+ *
54
108
  * @generated from field: string country_code = 8;
55
109
  */
56
110
  countryCode: string;
57
111
 
58
112
  /**
113
+ * Name of the issuing entity of the security.
114
+ *
59
115
  * @generated from field: string issuer = 9;
60
116
  */
61
117
  issuer: string;
62
118
 
63
119
  /**
120
+ * Instrument Update time
121
+ *
64
122
  * @generated from field: google.protobuf.Timestamp update_time = 10;
65
123
  */
66
124
  updateTime?: Timestamp | undefined;
67
125
 
68
126
  /**
127
+ * ASISA attributes.
128
+ *
69
129
  * @generated from field: alis.open.cx.v1.Instrument.Asisa asisa = 100;
70
130
  */
71
131
  asisa?: Instrument_Asisa | undefined;
72
132
 
73
133
  /**
134
+ * MiFID attributes
135
+ *
74
136
  * @generated from field: alis.open.cx.v1.Instrument.Mifid mifid = 101;
75
137
  */
76
138
  mifid?: Instrument_Mifid | undefined;
77
139
 
78
140
  /**
141
+ * UCITS attributes
142
+ *
79
143
  * @generated from field: alis.open.cx.v1.Instrument.Ucits ucits = 102;
80
144
  */
81
145
  ucits?: Instrument_Ucits | undefined;
82
146
 
83
147
  /**
148
+ * Reg28 attributes
149
+ *
84
150
  * @generated from field: alis.open.cx.v1.Instrument.Reg28 reg28 = 103;
85
151
  */
86
152
  reg28?: Instrument_Reg28 | undefined;
87
153
 
88
154
  /**
155
+ * CISCA attributes
156
+ *
89
157
  * @generated from field: alis.open.cx.v1.Instrument.Cisca cisca = 104;
90
158
  */
91
159
  cisca?: Instrument_Cisca | undefined;
92
160
 
93
161
  /**
162
+ * Regulation 30 from Annexure B of the Medical Schemes Act.
163
+ *
94
164
  * @generated from field: alis.open.cx.v1.Instrument.Reg30 reg30 = 105;
95
165
  */
96
166
  reg30?: Instrument_Reg30 | undefined;
97
167
 
98
168
  /**
169
+ * SARB C23
170
+ *
99
171
  * @generated from field: alis.open.cx.v1.Instrument.SarbC23 sarbC23 = 106;
100
172
  */
101
173
  sarbC23?: Instrument_SarbC23 | undefined;
102
174
  };
103
175
 
104
176
  /**
177
+ * Instrument is a resource within the Compliance Exchange product.
178
+ *
105
179
  * @generated from message alis.open.cx.v1.Instrument
106
180
  */
107
181
  export declare type InstrumentJson = {
108
182
  /**
183
+ * The instrument name is the unique identifier across organisations.
184
+ *
185
+ * Format: instruments/{instrument}. {instrument} must be a valid Bloomberg or custom FIGI as defined by www.openfigi.com..
186
+ *
109
187
  * @generated from field: string name = 1;
110
188
  */
111
189
  name?: string;
112
190
 
113
191
  /**
192
+ * Figi Type. Either a global or custom FIGI, else set to unspecified
193
+ *
114
194
  * @generated from field: alis.open.cx.v1.Instrument.FigiType figi_type = 2;
115
195
  */
116
196
  figiType?: Instrument_FigiTypeJson;
117
197
 
118
198
  /**
199
+ * Human readable display name
200
+ *
119
201
  * @generated from field: string display_name = 3;
120
202
  */
121
203
  displayName?: string;
122
204
 
123
205
  /**
206
+ * Security Description
207
+ *
124
208
  * @generated from field: string description = 4;
125
209
  */
126
210
  description?: string;
127
211
 
128
212
  /**
213
+ * Market Sector
214
+ * The asset class/category of the particular instrument
215
+ *
216
+ * Format: EQUITY, MONEY_MARKET, etc.
217
+ *
129
218
  * @generated from field: alis.open.cx.v1.Instrument.MarketSector market_sector = 5;
130
219
  */
131
220
  marketSector?: Instrument_MarketSectorJson;
132
221
 
133
222
  /**
223
+ * Exchange Code
224
+ * Code for the trading venue or environment on which the instrument trades. If an exchange is specified,
225
+ * the code will be for the specified exchange.
226
+ *
227
+ * Format: US, UN, SJ etc.
228
+ *
134
229
  * @generated from field: string exch_code = 6;
135
230
  */
136
231
  exchCode?: string;
137
232
 
138
233
  /**
234
+ * Currency
235
+ * The 3-letter currency code defined in ISO 4217.
236
+ * Currency in which the security was issued. Equities: Trading currency for the security.
237
+ * Fixed Income: Provides the currency in which the bond was issued, not necessarily the currency in which
238
+ * the bond trades or pays its coupons.
239
+ *
139
240
  * @generated from field: string currency_code = 7;
140
241
  */
141
242
  currencyCode?: string;
142
243
 
143
244
  /**
245
+ * The ISO country code
246
+ * (-- api-linter: core::0143::standardized-codes=disabled
247
+ * aip.dev/not-precedent: 'Country' is a well defined attributes within Finance. --)
248
+ *
144
249
  * @generated from field: string country_code = 8;
145
250
  */
146
251
  countryCode?: string;
147
252
 
148
253
  /**
254
+ * Name of the issuing entity of the security.
255
+ *
149
256
  * @generated from field: string issuer = 9;
150
257
  */
151
258
  issuer?: string;
152
259
 
153
260
  /**
261
+ * Instrument Update time
262
+ *
154
263
  * @generated from field: google.protobuf.Timestamp update_time = 10;
155
264
  */
156
265
  updateTime?: TimestampJson;
157
266
 
158
267
  /**
268
+ * ASISA attributes.
269
+ *
159
270
  * @generated from field: alis.open.cx.v1.Instrument.Asisa asisa = 100;
160
271
  */
161
272
  asisa?: Instrument_AsisaJson;
162
273
 
163
274
  /**
275
+ * MiFID attributes
276
+ *
164
277
  * @generated from field: alis.open.cx.v1.Instrument.Mifid mifid = 101;
165
278
  */
166
279
  mifid?: Instrument_MifidJson;
167
280
 
168
281
  /**
282
+ * UCITS attributes
283
+ *
169
284
  * @generated from field: alis.open.cx.v1.Instrument.Ucits ucits = 102;
170
285
  */
171
286
  ucits?: Instrument_UcitsJson;
172
287
 
173
288
  /**
289
+ * Reg28 attributes
290
+ *
174
291
  * @generated from field: alis.open.cx.v1.Instrument.Reg28 reg28 = 103;
175
292
  */
176
293
  reg28?: Instrument_Reg28Json;
177
294
 
178
295
  /**
296
+ * CISCA attributes
297
+ *
179
298
  * @generated from field: alis.open.cx.v1.Instrument.Cisca cisca = 104;
180
299
  */
181
300
  cisca?: Instrument_CiscaJson;
182
301
 
183
302
  /**
303
+ * Regulation 30 from Annexure B of the Medical Schemes Act.
304
+ *
184
305
  * @generated from field: alis.open.cx.v1.Instrument.Reg30 reg30 = 105;
185
306
  */
186
307
  reg30?: Instrument_Reg30Json;
187
308
 
188
309
  /**
310
+ * SARB C23
311
+ *
189
312
  * @generated from field: alis.open.cx.v1.Instrument.SarbC23 sarbC23 = 106;
190
313
  */
191
314
  sarbC23?: Instrument_SarbC23Json;
@@ -198,140 +321,210 @@ export declare type InstrumentJson = {
198
321
  export declare const InstrumentSchema: GenMessage<Instrument, {jsonType: InstrumentJson}>;
199
322
 
200
323
  /**
324
+ * The ASISA set
325
+ *
201
326
  * @generated from message alis.open.cx.v1.Instrument.Asisa
202
327
  */
203
328
  export declare type Instrument_Asisa = Message<"alis.open.cx.v1.Instrument.Asisa"> & {
204
329
  /**
330
+ * The Asset Classes
331
+ *
205
332
  * @generated from field: alis.open.cx.v1.Instrument.Asisa.AssetClass asset_class = 1;
206
333
  */
207
334
  assetClass: Instrument_Asisa_AssetClass;
208
335
 
209
336
  /**
337
+ * Description of the specific instrument type within its market sector.
338
+ * This typically depends on the market sector and is fairly flexible
339
+ *
210
340
  * @generated from field: string security_type = 2;
211
341
  */
212
342
  securityType: string;
213
343
 
214
344
  /**
345
+ * Name of the issuing entity of the security.
346
+ *
215
347
  * @generated from field: string issuer = 3;
216
348
  */
217
349
  issuer: string;
218
350
 
219
351
  /**
352
+ * market capitalisation in ZAR
353
+ *
220
354
  * @generated from field: double issuer_zar_market_capitalisation = 4;
221
355
  */
222
356
  issuerZarMarketCapitalisation: number;
223
357
 
224
358
  /**
359
+ * short term credit rating
360
+ *
225
361
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating short_term_credit_rating = 5;
226
362
  */
227
363
  shortTermCreditRating?: Instrument_CreditRating | undefined;
228
364
 
229
365
  /**
366
+ * long term credit rating
367
+ *
230
368
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating long_term_credit_rating = 6;
231
369
  */
232
370
  longTermCreditRating?: Instrument_CreditRating | undefined;
233
371
 
234
372
  /**
373
+ * issuer short term credit rating
374
+ *
235
375
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating short_term_credit_rating_issuer = 7;
236
376
  */
237
377
  shortTermCreditRatingIssuer?: Instrument_CreditRating | undefined;
238
378
 
239
379
  /**
380
+ * issuer long term credit rating
381
+ *
240
382
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating long_term_credit_rating_issuer = 8;
241
383
  */
242
384
  longTermCreditRatingIssuer?: Instrument_CreditRating | undefined;
243
385
 
244
386
  /**
387
+ * // Indicates if the security is linked to an as an equity index linked instrument
388
+ * google.protobuf.BoolValue equities_index_linked = 9;
389
+ * Indicates if the security forms part of the 5% Africa allowance.
390
+ *
245
391
  * @generated from field: google.protobuf.BoolValue africa_allowance = 10;
246
392
  */
247
393
  africaAllowance?: boolean | undefined;
248
394
 
249
395
  /**
396
+ * If the security is classified as a compulsory convertible debenture (CCD)
397
+ *
250
398
  * @generated from field: google.protobuf.BoolValue ccd_classified = 11;
251
399
  */
252
400
  ccdClassified?: boolean | undefined;
253
401
 
254
402
  /**
403
+ * Currency
404
+ * The 3-letter currency code defined in ISO 4217.
405
+ * Currency in which the security was issued. Equities: Trading currency for the security.
406
+ * Fixed Income: Provides the currency in which the bond was issued, not necessarily the currency in which
407
+ * the bond trades or pays its coupons.
408
+ *
255
409
  * @generated from field: string currency_code = 12;
256
410
  */
257
411
  currencyCode: string;
258
412
 
259
413
  /**
414
+ * The different categories of securities
415
+ *
260
416
  * @generated from field: alis.open.cx.v1.Instrument.Asisa.Category category = 13;
261
417
  */
262
418
  category: Instrument_Asisa_Category;
263
419
 
264
420
  /**
421
+ * Details on whether the instrument attributes meet the requirements for the Set
422
+ *
265
423
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
266
424
  */
267
425
  validation?: Instrument_Validation | undefined;
268
426
  };
269
427
 
270
428
  /**
429
+ * The ASISA set
430
+ *
271
431
  * @generated from message alis.open.cx.v1.Instrument.Asisa
272
432
  */
273
433
  export declare type Instrument_AsisaJson = {
274
434
  /**
435
+ * The Asset Classes
436
+ *
275
437
  * @generated from field: alis.open.cx.v1.Instrument.Asisa.AssetClass asset_class = 1;
276
438
  */
277
439
  assetClass?: Instrument_Asisa_AssetClassJson;
278
440
 
279
441
  /**
442
+ * Description of the specific instrument type within its market sector.
443
+ * This typically depends on the market sector and is fairly flexible
444
+ *
280
445
  * @generated from field: string security_type = 2;
281
446
  */
282
447
  securityType?: string;
283
448
 
284
449
  /**
450
+ * Name of the issuing entity of the security.
451
+ *
285
452
  * @generated from field: string issuer = 3;
286
453
  */
287
454
  issuer?: string;
288
455
 
289
456
  /**
457
+ * market capitalisation in ZAR
458
+ *
290
459
  * @generated from field: double issuer_zar_market_capitalisation = 4;
291
460
  */
292
461
  issuerZarMarketCapitalisation?: number | "NaN" | "Infinity" | "-Infinity";
293
462
 
294
463
  /**
464
+ * short term credit rating
465
+ *
295
466
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating short_term_credit_rating = 5;
296
467
  */
297
468
  shortTermCreditRating?: Instrument_CreditRatingJson;
298
469
 
299
470
  /**
471
+ * long term credit rating
472
+ *
300
473
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating long_term_credit_rating = 6;
301
474
  */
302
475
  longTermCreditRating?: Instrument_CreditRatingJson;
303
476
 
304
477
  /**
478
+ * issuer short term credit rating
479
+ *
305
480
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating short_term_credit_rating_issuer = 7;
306
481
  */
307
482
  shortTermCreditRatingIssuer?: Instrument_CreditRatingJson;
308
483
 
309
484
  /**
485
+ * issuer long term credit rating
486
+ *
310
487
  * @generated from field: alis.open.cx.v1.Instrument.CreditRating long_term_credit_rating_issuer = 8;
311
488
  */
312
489
  longTermCreditRatingIssuer?: Instrument_CreditRatingJson;
313
490
 
314
491
  /**
492
+ * // Indicates if the security is linked to an as an equity index linked instrument
493
+ * google.protobuf.BoolValue equities_index_linked = 9;
494
+ * Indicates if the security forms part of the 5% Africa allowance.
495
+ *
315
496
  * @generated from field: google.protobuf.BoolValue africa_allowance = 10;
316
497
  */
317
498
  africaAllowance?: BoolValueJson;
318
499
 
319
500
  /**
501
+ * If the security is classified as a compulsory convertible debenture (CCD)
502
+ *
320
503
  * @generated from field: google.protobuf.BoolValue ccd_classified = 11;
321
504
  */
322
505
  ccdClassified?: BoolValueJson;
323
506
 
324
507
  /**
508
+ * Currency
509
+ * The 3-letter currency code defined in ISO 4217.
510
+ * Currency in which the security was issued. Equities: Trading currency for the security.
511
+ * Fixed Income: Provides the currency in which the bond was issued, not necessarily the currency in which
512
+ * the bond trades or pays its coupons.
513
+ *
325
514
  * @generated from field: string currency_code = 12;
326
515
  */
327
516
  currencyCode?: string;
328
517
 
329
518
  /**
519
+ * The different categories of securities
520
+ *
330
521
  * @generated from field: alis.open.cx.v1.Instrument.Asisa.Category category = 13;
331
522
  */
332
523
  category?: Instrument_Asisa_CategoryJson;
333
524
 
334
525
  /**
526
+ * Details on whether the instrument attributes meet the requirements for the Set
527
+ *
335
528
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
336
529
  */
337
530
  validation?: Instrument_ValidationJson;
@@ -344,161 +537,225 @@ export declare type Instrument_AsisaJson = {
344
537
  export declare const Instrument_AsisaSchema: GenMessage<Instrument_Asisa, {jsonType: Instrument_AsisaJson}>;
345
538
 
346
539
  /**
540
+ * List of available Asisa asset classes
541
+ *
347
542
  * @generated from enum alis.open.cx.v1.Instrument.Asisa.AssetClass
348
543
  */
349
544
  export enum Instrument_Asisa_AssetClass {
350
545
  /**
546
+ * Category not provided by the user.
547
+ *
351
548
  * @generated from enum value: ASSET_CLASS_UNSPECIFIED = 0;
352
549
  */
353
550
  ASSET_CLASS_UNSPECIFIED = 0,
354
551
 
355
552
  /**
553
+ * Domestic bonds and debentures (listed)
554
+ *
356
555
  * @generated from enum value: DB = 1;
357
556
  */
358
557
  DB = 1,
359
558
 
360
559
  /**
560
+ * Domestic bonds and debentures (unlisted)
561
+ *
361
562
  * @generated from enum value: DBU = 2;
362
563
  */
363
564
  DBU = 2,
364
565
 
365
566
  /**
567
+ * Domestic deposits with banks
568
+ *
366
569
  * @generated from enum value: DC = 3;
367
570
  */
368
571
  DC = 3,
369
572
 
370
573
  /**
574
+ * Domestic other liquid assets
575
+ *
371
576
  * @generated from enum value: DCO = 4;
372
577
  */
373
578
  DCO = 4,
374
579
 
375
580
  /**
581
+ * Other derivatives
582
+ *
376
583
  * @generated from enum value: DD = 5;
377
584
  */
378
585
  DD = 5,
379
586
 
380
587
  /**
588
+ * JSE listed equity (primary listing)
589
+ *
381
590
  * @generated from enum value: DEP = 6;
382
591
  */
383
592
  DEP = 6,
384
593
 
385
594
  /**
595
+ * JSE listed equity (secondary listing)
596
+ *
386
597
  * @generated from enum value: DES = 7;
387
598
  */
388
599
  DES = 7,
389
600
 
390
601
  /**
602
+ * Local unlisted equity
603
+ *
391
604
  * @generated from enum value: DEU = 8;
392
605
  */
393
606
  DEU = 8,
394
607
 
395
608
  /**
609
+ * Instruments based on underlying asset
610
+ *
396
611
  * @generated from enum value: DFI = 9;
397
612
  */
398
613
  DFI = 9,
399
614
 
400
615
  /**
616
+ * Options
617
+ *
401
618
  * @generated from enum value: DFO = 10;
402
619
  */
403
620
  DFO = 10,
404
621
 
405
622
  /**
623
+ * Index Tracking Certificates
624
+ *
406
625
  * @generated from enum value: DFT = 11;
407
626
  */
408
627
  DFT = 11,
409
628
 
410
629
  /**
630
+ * Domestic Loans
631
+ *
411
632
  * @generated from enum value: DLN = 12;
412
633
  */
413
634
  DLN = 12,
414
635
 
415
636
  /**
637
+ * Domestic money market
638
+ *
416
639
  * @generated from enum value: DM = 13;
417
640
  */
418
641
  DM = 13,
419
642
 
420
643
  /**
644
+ * Domestic other
645
+ *
421
646
  * @generated from enum value: DO = 14;
422
647
  */
423
648
  DO = 14,
424
649
 
425
650
  /**
651
+ * Domestic settlement accounts
652
+ *
426
653
  * @generated from enum value: DS = 15;
427
654
  */
428
655
  DS = 15,
429
656
 
430
657
  /**
658
+ * Trust account
659
+ *
431
660
  * @generated from enum value: DT = 16;
432
661
  */
433
662
  DT = 16,
434
663
 
435
664
  /**
665
+ * Foreign bonds and debentures (listed)
666
+ *
436
667
  * @generated from enum value: FB = 17;
437
668
  */
438
669
  FB = 17,
439
670
 
440
671
  /**
672
+ * Foreign bonds and debentures (unlisted)
673
+ *
441
674
  * @generated from enum value: FBU = 18;
442
675
  */
443
676
  FBU = 18,
444
677
 
445
678
  /**
679
+ * Foreign deposits with banks
680
+ *
446
681
  * @generated from enum value: FC = 19;
447
682
  */
448
683
  FC = 19,
449
684
 
450
685
  /**
686
+ * Foreign other liquid assets
687
+ *
451
688
  * @generated from enum value: FCO = 20;
452
689
  */
453
690
  FCO = 20,
454
691
 
455
692
  /**
693
+ * Foreign listed equity
694
+ *
456
695
  * @generated from enum value: FE = 21;
457
696
  */
458
697
  FE = 21,
459
698
 
460
699
  /**
700
+ * Foreign unlisted equity
701
+ *
461
702
  * @generated from enum value: FEU = 22;
462
703
  */
463
704
  FEU = 22,
464
705
 
465
706
  /**
707
+ * Foreign Loans
708
+ *
466
709
  * @generated from enum value: FLN = 23;
467
710
  */
468
711
  FLN = 23,
469
712
 
470
713
  /**
714
+ * Foreign money market
715
+ *
471
716
  * @generated from enum value: FM = 24;
472
717
  */
473
718
  FM = 24,
474
719
 
475
720
  /**
721
+ * Foreign other
722
+ *
476
723
  * @generated from enum value: FO = 25;
477
724
  */
478
725
  FO = 25,
479
726
 
480
727
  /**
728
+ * Foreign settlement accounts
729
+ *
481
730
  * @generated from enum value: FS = 26;
482
731
  */
483
732
  FS = 26,
484
733
 
485
734
  /**
735
+ * Foreign unit trust
736
+ *
486
737
  * @generated from enum value: FUT = 27;
487
738
  */
488
739
  FUT = 27,
489
740
 
490
741
  /**
742
+ * Local unit trust
743
+ *
491
744
  * @generated from enum value: LUT = 28;
492
745
  */
493
746
  LUT = 28,
494
747
 
495
748
  /**
749
+ * Futures
750
+ *
496
751
  * @generated from enum value: DFF = 29;
497
752
  */
498
753
  DFF = 29,
499
754
  }
500
755
 
501
756
  /**
757
+ * List of available Asisa asset classes
758
+ *
502
759
  * @generated from enum alis.open.cx.v1.Instrument.Asisa.AssetClass
503
760
  */
504
761
  export declare type Instrument_Asisa_AssetClassJson = "ASSET_CLASS_UNSPECIFIED" | "DB" | "DBU" | "DC" | "DCO" | "DD" | "DEP" | "DES" | "DEU" | "DFI" | "DFO" | "DFT" | "DLN" | "DM" | "DO" | "DS" | "DT" | "FB" | "FBU" | "FC" | "FCO" | "FE" | "FEU" | "FLN" | "FM" | "FO" | "FS" | "FUT" | "LUT" | "DFF";
@@ -509,116 +766,191 @@ export declare type Instrument_Asisa_AssetClassJson = "ASSET_CLASS_UNSPECIFIED"
509
766
  export declare const Instrument_Asisa_AssetClassSchema: GenEnum<Instrument_Asisa_AssetClass, Instrument_Asisa_AssetClassJson>;
510
767
 
511
768
  /**
769
+ * List of available ASISA Categories
770
+ *
512
771
  * @generated from enum alis.open.cx.v1.Instrument.Asisa.Category
513
772
  */
514
773
  export enum Instrument_Asisa_Category {
515
774
  /**
775
+ * Category not provided by the user.
776
+ *
516
777
  * @generated from enum value: CATEGORY_UNSPECIFIED = 0;
517
778
  */
518
779
  CATEGORY_UNSPECIFIED = 0,
519
780
 
520
781
  /**
782
+ * Notes and coins; any balance or deposit in an account
783
+ * held with a South African bank;
784
+ * A money market instrument issued by a South African
785
+ * bank including an Islamic liquidity management financial
786
+ * instrument;
787
+ * Any positive net balance in a margin account with an
788
+ * exchange; and
789
+ * Any positive net balance in a settlement account with an
790
+ * exchange, operated for the buying and selling of assets.
791
+ *
521
792
  * @generated from enum value: CASH_INSIDE_THE_REPUBLIC = 1;
522
793
  */
523
794
  CASH_INSIDE_THE_REPUBLIC = 1,
524
795
 
525
796
  /**
797
+ * Any balance or deposit held with a foreign bank;
798
+ * A money market instrument issued by a foreign bank
799
+ * including an Islamic liquidity management financial
800
+ * instrument;
801
+ *
526
802
  * @generated from enum value: CASH_FOREIGN_ASSETS = 2;
527
803
  */
528
804
  CASH_FOREIGN_ASSETS = 2,
529
805
 
530
806
  /**
807
+ * Debt instruments issued by, and loans to, the
808
+ * government of the Republic, and any debt or loan
809
+ * guaranteed by the Republic
810
+ *
531
811
  * @generated from enum value: DEBT_GUARANTEED_BY_THE_REPUBLIC = 3;
532
812
  */
533
813
  DEBT_GUARANTEED_BY_THE_REPUBLIC = 3,
534
814
 
535
815
  /**
816
+ * Debt instruments issued or guaranteed by the
817
+ * government of a foreign country
818
+ *
536
819
  * @generated from enum value: DEBT_GUARANTEED_BY_FOREIGN_COUNTRY = 4;
537
820
  */
538
821
  DEBT_GUARANTEED_BY_FOREIGN_COUNTRY = 4,
539
822
 
540
823
  /**
824
+ * Debt instruments issued or guaranteed by a South
825
+ * African bank against its balance sheet subject to issuer listing status
826
+ * and prevailing market capitalisation
827
+ *
541
828
  * @generated from enum value: DEBT_GUARANTEED_BY_SOUTH_AFRICAN_BANK = 5;
542
829
  */
543
830
  DEBT_GUARANTEED_BY_SOUTH_AFRICAN_BANK = 5,
544
831
 
545
832
  /**
833
+ * Debt instruments issued or guaranteed by an entity
834
+ * that has equity listed on an exchange, or debt
835
+ * instruments issued or guaranteed by a public entity
836
+ * under the Public Finance Management Act, 1999
837
+ * (Act No. 1 of 1999)
838
+ *
546
839
  * @generated from enum value: DEBT_GUARANTEED_BY_LISTED_OR_PFMA_ENTITY = 6;
547
840
  */
548
841
  DEBT_GUARANTEED_BY_LISTED_OR_PFMA_ENTITY = 6,
549
842
 
550
843
  /**
844
+ * Other debt instruments
845
+ *
551
846
  * @generated from enum value: DEBT_OTHER = 7;
552
847
  */
553
848
  DEBT_OTHER = 7,
554
849
 
555
850
  /**
851
+ * Preference and ordinary shares in companies,
852
+ * excluding shares in property companies
853
+ *
556
854
  * @generated from enum value: EQUITIES = 8;
557
855
  */
558
856
  EQUITIES = 8,
559
857
 
560
858
  /**
859
+ * Preference shares, ordinary shares and linked units
860
+ * comprising shares linked to debentures in property
861
+ * companies, or units in a Collective Investment
862
+ * Scheme in Property
863
+ *
561
864
  * @generated from enum value: IMMOVABLE_PROPERTY = 10;
562
865
  */
563
866
  IMMOVABLE_PROPERTY = 10,
564
867
 
565
868
  /**
869
+ * Kruger Rands and other commodities listed on an
870
+ * exchange, including exchange traded commodities.
871
+ *
566
872
  * @generated from enum value: COMMODITIES_GOLD = 12;
567
873
  */
568
874
  COMMODITIES_GOLD = 12,
569
875
 
570
876
  /**
877
+ * All other non-gold commodities
878
+ *
571
879
  * @generated from enum value: COMMODITIES_OTHER = 13;
572
880
  */
573
881
  COMMODITIES_OTHER = 13,
574
882
 
575
883
  /**
884
+ * Investments in the business of a participating employer
885
+ * inside the republic in terms of Section 19(4) of the Pension Funds Act (PFA)
886
+ *
576
887
  * @generated from enum value: PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4 = 14;
577
888
  */
578
889
  PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4 = 14,
579
890
 
580
891
  /**
892
+ * Investments in the business of a participating employer
893
+ * inside the republic in terms of the extent it has been allowed by an exemption in terms of
894
+ * section 19(4A) of the Pension Funds Act
895
+ *
581
896
  * @generated from enum value: PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4A_EXEMPT = 15;
582
897
  */
583
898
  PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4A_EXEMPT = 15,
584
899
 
585
900
  /**
901
+ * Housing loans granted to members in accordance with the provisions of Section 19(5)
902
+ *
586
903
  * @generated from enum value: HOUSING_LOANS = 16;
587
904
  */
588
905
  HOUSING_LOANS = 16,
589
906
 
590
907
  /**
908
+ * Funds of hedge funds
909
+ *
591
910
  * @generated from enum value: OTHER_ASSETS_FUNDS_OF_HEDGE_FUNDS = 17;
592
911
  */
593
912
  OTHER_ASSETS_FUNDS_OF_HEDGE_FUNDS = 17,
594
913
 
595
914
  /**
915
+ * Hedge funds
916
+ *
596
917
  * @generated from enum value: OTHER_ASSETS_HEDGE_FUNDS = 18;
597
918
  */
598
919
  OTHER_ASSETS_HEDGE_FUNDS = 18,
599
920
 
600
921
  /**
922
+ * Funds of private equity funds
923
+ *
601
924
  * @generated from enum value: OTHER_ASSETS_FUNDS_OF_PRIVATE_EQUITY_FUNDS = 19;
602
925
  */
603
926
  OTHER_ASSETS_FUNDS_OF_PRIVATE_EQUITY_FUNDS = 19,
604
927
 
605
928
  /**
929
+ * Private equity funds
930
+ *
606
931
  * @generated from enum value: OTHER_ASSETS_PRIVATE_EQUITY_FUNDS = 20;
607
932
  */
608
933
  OTHER_ASSETS_PRIVATE_EQUITY_FUNDS = 20,
609
934
 
610
935
  /**
936
+ * Other assets not referred to in this schedule and
937
+ * excluding a hedge fund or private equity fund
938
+ *
611
939
  * @generated from enum value: OTHER_ASSETS_NOT_REFERRED_TO_IN_SCHEDULE = 21;
612
940
  */
613
941
  OTHER_ASSETS_NOT_REFERRED_TO_IN_SCHEDULE = 21,
614
942
 
615
943
  /**
944
+ * Assets excluding from all other categorisations
945
+ *
616
946
  * @generated from enum value: EXCLUDED_ASSETS = 22;
617
947
  */
618
948
  EXCLUDED_ASSETS = 22,
619
949
  }
620
950
 
621
951
  /**
952
+ * List of available ASISA Categories
953
+ *
622
954
  * @generated from enum alis.open.cx.v1.Instrument.Asisa.Category
623
955
  */
624
956
  export declare type Instrument_Asisa_CategoryJson = "CATEGORY_UNSPECIFIED" | "CASH_INSIDE_THE_REPUBLIC" | "CASH_FOREIGN_ASSETS" | "DEBT_GUARANTEED_BY_THE_REPUBLIC" | "DEBT_GUARANTEED_BY_FOREIGN_COUNTRY" | "DEBT_GUARANTEED_BY_SOUTH_AFRICAN_BANK" | "DEBT_GUARANTEED_BY_LISTED_OR_PFMA_ENTITY" | "DEBT_OTHER" | "EQUITIES" | "IMMOVABLE_PROPERTY" | "COMMODITIES_GOLD" | "COMMODITIES_OTHER" | "PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4" | "PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4A_EXEMPT" | "HOUSING_LOANS" | "OTHER_ASSETS_FUNDS_OF_HEDGE_FUNDS" | "OTHER_ASSETS_HEDGE_FUNDS" | "OTHER_ASSETS_FUNDS_OF_PRIVATE_EQUITY_FUNDS" | "OTHER_ASSETS_PRIVATE_EQUITY_FUNDS" | "OTHER_ASSETS_NOT_REFERRED_TO_IN_SCHEDULE" | "EXCLUDED_ASSETS";
@@ -629,30 +961,42 @@ export declare type Instrument_Asisa_CategoryJson = "CATEGORY_UNSPECIFIED" | "CA
629
961
  export declare const Instrument_Asisa_CategorySchema: GenEnum<Instrument_Asisa_Category, Instrument_Asisa_CategoryJson>;
630
962
 
631
963
  /**
964
+ * The MiFID set
965
+ *
632
966
  * @generated from message alis.open.cx.v1.Instrument.Mifid
633
967
  */
634
968
  export declare type Instrument_Mifid = Message<"alis.open.cx.v1.Instrument.Mifid"> & {
635
969
  /**
970
+ * The Asset classes
971
+ *
636
972
  * @generated from field: alis.open.cx.v1.Instrument.Mifid.AssetClass asset_class = 1;
637
973
  */
638
974
  assetClass: Instrument_Mifid_AssetClass;
639
975
 
640
976
  /**
977
+ * Details on whether the instrument attributes meet the requirements for the Set
978
+ *
641
979
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
642
980
  */
643
981
  validation?: Instrument_Validation | undefined;
644
982
  };
645
983
 
646
984
  /**
985
+ * The MiFID set
986
+ *
647
987
  * @generated from message alis.open.cx.v1.Instrument.Mifid
648
988
  */
649
989
  export declare type Instrument_MifidJson = {
650
990
  /**
991
+ * The Asset classes
992
+ *
651
993
  * @generated from field: alis.open.cx.v1.Instrument.Mifid.AssetClass asset_class = 1;
652
994
  */
653
995
  assetClass?: Instrument_Mifid_AssetClassJson;
654
996
 
655
997
  /**
998
+ * Details on whether the instrument attributes meet the requirements for the Set
999
+ *
656
1000
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
657
1001
  */
658
1002
  validation?: Instrument_ValidationJson;
@@ -665,81 +1009,113 @@ export declare type Instrument_MifidJson = {
665
1009
  export declare const Instrument_MifidSchema: GenMessage<Instrument_Mifid, {jsonType: Instrument_MifidJson}>;
666
1010
 
667
1011
  /**
1012
+ * List of available MiFID asset classes
1013
+ *
668
1014
  * @generated from enum alis.open.cx.v1.Instrument.Mifid.AssetClass
669
1015
  */
670
1016
  export enum Instrument_Mifid_AssetClass {
671
1017
  /**
1018
+ * Category not provided by the user.
1019
+ *
672
1020
  * @generated from enum value: ASSET_CLASS_UNSPECIFIED = 0;
673
1021
  */
674
1022
  ASSET_CLASS_UNSPECIFIED = 0,
675
1023
 
676
1024
  /**
1025
+ * C10 Derivatives
1026
+ *
677
1027
  * @generated from enum value: CTDV = 1;
678
1028
  */
679
1029
  CTDV = 1,
680
1030
 
681
1031
  /**
1032
+ * Emission Allowances
1033
+ *
682
1034
  * @generated from enum value: EALL = 2;
683
1035
  */
684
1036
  EALL = 2,
685
1037
 
686
1038
  /**
1039
+ * Interest Rate Derivatives
1040
+ *
687
1041
  * @generated from enum value: IRDV = 3;
688
1042
  */
689
1043
  IRDV = 3,
690
1044
 
691
1045
  /**
1046
+ * Structured Financial Products
1047
+ *
692
1048
  * @generated from enum value: SFPS = 4;
693
1049
  */
694
1050
  SFPS = 4,
695
1051
 
696
1052
  /**
1053
+ * Commodity Derivatives
1054
+ *
697
1055
  * @generated from enum value: CDRV = 5;
698
1056
  */
699
1057
  CDRV = 5,
700
1058
 
701
1059
  /**
1060
+ * Equity Derivatives
1061
+ *
702
1062
  * @generated from enum value: EDRV = 6;
703
1063
  */
704
1064
  EDRV = 6,
705
1065
 
706
1066
  /**
1067
+ * Securitised Derivatives
1068
+ *
707
1069
  * @generated from enum value: SDRV = 7;
708
1070
  */
709
1071
  SDRV = 7,
710
1072
 
711
1073
  /**
1074
+ * Credit Derivatives
1075
+ *
712
1076
  * @generated from enum value: CRDV = 8;
713
1077
  */
714
1078
  CRDV = 8,
715
1079
 
716
1080
  /**
1081
+ * Foreign Exchange Derivatives
1082
+ *
717
1083
  * @generated from enum value: FXDV = 9;
718
1084
  */
719
1085
  FXDV = 9,
720
1086
 
721
1087
  /**
1088
+ * Equity Financial Derivatives
1089
+ *
722
1090
  * @generated from enum value: EQUI = 10;
723
1091
  */
724
1092
  EQUI = 10,
725
1093
 
726
1094
  /**
1095
+ * Emission Allowance Derivatives
1096
+ *
727
1097
  * @generated from enum value: EADV = 11;
728
1098
  */
729
1099
  EADV = 11,
730
1100
 
731
1101
  /**
1102
+ * Financial Contracts for Difference
1103
+ *
732
1104
  * @generated from enum value: FCFD = 12;
733
1105
  */
734
1106
  FCFD = 12,
735
1107
 
736
1108
  /**
1109
+ * Bonds
1110
+ *
737
1111
  * @generated from enum value: BOND = 13;
738
1112
  */
739
1113
  BOND = 13,
740
1114
  }
741
1115
 
742
1116
  /**
1117
+ * List of available MiFID asset classes
1118
+ *
743
1119
  * @generated from enum alis.open.cx.v1.Instrument.Mifid.AssetClass
744
1120
  */
745
1121
  export declare type Instrument_Mifid_AssetClassJson = "ASSET_CLASS_UNSPECIFIED" | "CTDV" | "EALL" | "IRDV" | "SFPS" | "CDRV" | "EDRV" | "SDRV" | "CRDV" | "FXDV" | "EQUI" | "EADV" | "FCFD" | "BOND";
@@ -750,100 +1126,148 @@ export declare type Instrument_Mifid_AssetClassJson = "ASSET_CLASS_UNSPECIFIED"
750
1126
  export declare const Instrument_Mifid_AssetClassSchema: GenEnum<Instrument_Mifid_AssetClass, Instrument_Mifid_AssetClassJson>;
751
1127
 
752
1128
  /**
1129
+ * The Ucits set
1130
+ *
753
1131
  * @generated from message alis.open.cx.v1.Instrument.Ucits
754
1132
  */
755
1133
  export declare type Instrument_Ucits = Message<"alis.open.cx.v1.Instrument.Ucits"> & {
756
1134
  /**
1135
+ * Market Sector
1136
+ * The asset class/category of the particular instrument
1137
+ *
1138
+ * Format: EQUITY, MONEY_MARKET, etc.
1139
+ *
757
1140
  * @generated from field: alis.open.cx.v1.Instrument.Ucits.MarketSector market_sector = 1;
758
1141
  */
759
1142
  marketSector: Instrument_Ucits_MarketSector;
760
1143
 
761
1144
  /**
1145
+ * Description of the specific instrument type within its market sector.
1146
+ * This typically depends on the market sector and is fairly flexible
1147
+ *
762
1148
  * @generated from field: string security_type = 2;
763
1149
  */
764
1150
  securityType: string;
765
1151
 
766
1152
  /**
1153
+ * Name of the issuing entity of the security.
1154
+ *
767
1155
  * @generated from field: string issuer = 3;
768
1156
  */
769
1157
  issuer: string;
770
1158
 
771
1159
  /**
1160
+ * Instrument issued by Banks in EU or in non-member states with equivalent supervision
1161
+ *
772
1162
  * @generated from field: google.protobuf.BoolValue eu_bank_issuer = 4;
773
1163
  */
774
1164
  euBankIssuer?: boolean | undefined;
775
1165
 
776
1166
  /**
1167
+ * Instrument issued by EU credit institutions with special public supervision
1168
+ *
777
1169
  * @generated from field: google.protobuf.BoolValue eu_credit_institution_issuer = 5;
778
1170
  */
779
1171
  euCreditInstitutionIssuer?: boolean | undefined;
780
1172
 
781
1173
  /**
1174
+ * Permissible for inclusion in a portfolio governed by UCITS
1175
+ *
782
1176
  * @generated from field: google.protobuf.BoolValue ucits_compatible = 6;
783
1177
  */
784
1178
  ucitsCompatible?: boolean | undefined;
785
1179
 
786
1180
  /**
1181
+ * Instrument is traded on a regulated exchange
1182
+ *
787
1183
  * @generated from field: google.protobuf.BoolValue traded_on_exchange = 7;
788
1184
  */
789
1185
  tradedOnExchange?: boolean | undefined;
790
1186
 
791
1187
  /**
1188
+ * Instrument itself is UCITS fund or equivalent funds (UCI)
1189
+ *
792
1190
  * @generated from field: google.protobuf.BoolValue ucits_uci_fund = 8;
793
1191
  */
794
1192
  ucitsUciFund?: boolean | undefined;
795
1193
 
796
1194
  /**
1195
+ * Details on whether the instrument attributes meet the requirements for the Set
1196
+ *
797
1197
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
798
1198
  */
799
1199
  validation?: Instrument_Validation | undefined;
800
1200
  };
801
1201
 
802
1202
  /**
1203
+ * The Ucits set
1204
+ *
803
1205
  * @generated from message alis.open.cx.v1.Instrument.Ucits
804
1206
  */
805
1207
  export declare type Instrument_UcitsJson = {
806
1208
  /**
1209
+ * Market Sector
1210
+ * The asset class/category of the particular instrument
1211
+ *
1212
+ * Format: EQUITY, MONEY_MARKET, etc.
1213
+ *
807
1214
  * @generated from field: alis.open.cx.v1.Instrument.Ucits.MarketSector market_sector = 1;
808
1215
  */
809
1216
  marketSector?: Instrument_Ucits_MarketSectorJson;
810
1217
 
811
1218
  /**
1219
+ * Description of the specific instrument type within its market sector.
1220
+ * This typically depends on the market sector and is fairly flexible
1221
+ *
812
1222
  * @generated from field: string security_type = 2;
813
1223
  */
814
1224
  securityType?: string;
815
1225
 
816
1226
  /**
1227
+ * Name of the issuing entity of the security.
1228
+ *
817
1229
  * @generated from field: string issuer = 3;
818
1230
  */
819
1231
  issuer?: string;
820
1232
 
821
1233
  /**
1234
+ * Instrument issued by Banks in EU or in non-member states with equivalent supervision
1235
+ *
822
1236
  * @generated from field: google.protobuf.BoolValue eu_bank_issuer = 4;
823
1237
  */
824
1238
  euBankIssuer?: BoolValueJson;
825
1239
 
826
1240
  /**
1241
+ * Instrument issued by EU credit institutions with special public supervision
1242
+ *
827
1243
  * @generated from field: google.protobuf.BoolValue eu_credit_institution_issuer = 5;
828
1244
  */
829
1245
  euCreditInstitutionIssuer?: BoolValueJson;
830
1246
 
831
1247
  /**
1248
+ * Permissible for inclusion in a portfolio governed by UCITS
1249
+ *
832
1250
  * @generated from field: google.protobuf.BoolValue ucits_compatible = 6;
833
1251
  */
834
1252
  ucitsCompatible?: BoolValueJson;
835
1253
 
836
1254
  /**
1255
+ * Instrument is traded on a regulated exchange
1256
+ *
837
1257
  * @generated from field: google.protobuf.BoolValue traded_on_exchange = 7;
838
1258
  */
839
1259
  tradedOnExchange?: BoolValueJson;
840
1260
 
841
1261
  /**
1262
+ * Instrument itself is UCITS fund or equivalent funds (UCI)
1263
+ *
842
1264
  * @generated from field: google.protobuf.BoolValue ucits_uci_fund = 8;
843
1265
  */
844
1266
  ucitsUciFund?: BoolValueJson;
845
1267
 
846
1268
  /**
1269
+ * Details on whether the instrument attributes meet the requirements for the Set
1270
+ *
847
1271
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
848
1272
  */
849
1273
  validation?: Instrument_ValidationJson;
@@ -856,66 +1280,92 @@ export declare type Instrument_UcitsJson = {
856
1280
  export declare const Instrument_UcitsSchema: GenMessage<Instrument_Ucits, {jsonType: Instrument_UcitsJson}>;
857
1281
 
858
1282
  /**
1283
+ * The instrument market sector
1284
+ *
859
1285
  * @generated from enum alis.open.cx.v1.Instrument.Ucits.MarketSector
860
1286
  */
861
1287
  export enum Instrument_Ucits_MarketSector {
862
1288
  /**
1289
+ * Market Sector not specified
1290
+ *
863
1291
  * @generated from enum value: MARKET_SECTOR_UNSPECIFIED = 0;
864
1292
  */
865
1293
  MARKET_SECTOR_UNSPECIFIED = 0,
866
1294
 
867
1295
  /**
1296
+ * Commodities
1297
+ *
868
1298
  * @generated from enum value: COMMODITY = 1;
869
1299
  */
870
1300
  COMMODITY = 1,
871
1301
 
872
1302
  /**
1303
+ * Corporate Bonds
1304
+ *
873
1305
  * @generated from enum value: CORPORATE = 2;
874
1306
  */
875
1307
  CORPORATE = 2,
876
1308
 
877
1309
  /**
1310
+ * Currency
1311
+ *
878
1312
  * @generated from enum value: CURRENCY = 3;
879
1313
  */
880
1314
  CURRENCY = 3,
881
1315
 
882
1316
  /**
1317
+ * Equity
1318
+ *
883
1319
  * @generated from enum value: EQUITY = 4;
884
1320
  */
885
1321
  EQUITY = 4,
886
1322
 
887
1323
  /**
1324
+ * Market index
1325
+ *
888
1326
  * @generated from enum value: INDEX = 5;
889
1327
  */
890
1328
  INDEX = 5,
891
1329
 
892
1330
  /**
1331
+ * Money Market
1332
+ *
893
1333
  * @generated from enum value: MONEY_MARKET = 6;
894
1334
  */
895
1335
  MONEY_MARKET = 6,
896
1336
 
897
1337
  /**
1338
+ * Government Bonds
1339
+ *
898
1340
  * @generated from enum value: GOVERNMENT = 7;
899
1341
  */
900
1342
  GOVERNMENT = 7,
901
1343
 
902
1344
  /**
1345
+ * Mortgage Backed
1346
+ *
903
1347
  * @generated from enum value: MTGE = 8;
904
1348
  */
905
1349
  MTGE = 8,
906
1350
 
907
1351
  /**
1352
+ * Municipal Bonds
1353
+ *
908
1354
  * @generated from enum value: MUNI = 9;
909
1355
  */
910
1356
  MUNI = 9,
911
1357
 
912
1358
  /**
1359
+ * Preferred Stock
1360
+ *
913
1361
  * @generated from enum value: PFD = 10;
914
1362
  */
915
1363
  PFD = 10,
916
1364
  }
917
1365
 
918
1366
  /**
1367
+ * The instrument market sector
1368
+ *
919
1369
  * @generated from enum alis.open.cx.v1.Instrument.Ucits.MarketSector
920
1370
  */
921
1371
  export declare type Instrument_Ucits_MarketSectorJson = "MARKET_SECTOR_UNSPECIFIED" | "COMMODITY" | "CORPORATE" | "CURRENCY" | "EQUITY" | "INDEX" | "MONEY_MARKET" | "GOVERNMENT" | "MTGE" | "MUNI" | "PFD";
@@ -926,80 +1376,114 @@ export declare type Instrument_Ucits_MarketSectorJson = "MARKET_SECTOR_UNSPECIFI
926
1376
  export declare const Instrument_Ucits_MarketSectorSchema: GenEnum<Instrument_Ucits_MarketSector, Instrument_Ucits_MarketSectorJson>;
927
1377
 
928
1378
  /**
1379
+ * The Reg28 set
1380
+ *
929
1381
  * @generated from message alis.open.cx.v1.Instrument.Reg28
930
1382
  */
931
1383
  export declare type Instrument_Reg28 = Message<"alis.open.cx.v1.Instrument.Reg28"> & {
932
1384
  /**
1385
+ * The different categories of securities
1386
+ *
933
1387
  * @generated from field: alis.open.cx.v1.Instrument.Reg28.Category category = 1;
934
1388
  */
935
1389
  category: Instrument_Reg28_Category;
936
1390
 
937
1391
  /**
1392
+ * Issuer of instrument is listed on an exchange
1393
+ *
938
1394
  * @generated from field: google.protobuf.BoolValue exchange_listed_issuer = 2;
939
1395
  */
940
1396
  exchangeListedIssuer?: boolean | undefined;
941
1397
 
942
1398
  /**
1399
+ * Description of the specific instrument type within its market sector.
1400
+ * This typically depends on the market sector and is fairly flexible
1401
+ *
943
1402
  * @generated from field: string security_type = 3;
944
1403
  */
945
1404
  securityType: string;
946
1405
 
947
1406
  /**
1407
+ * Name of the issuing entity of the security.
1408
+ *
948
1409
  * @generated from field: string issuer = 4;
949
1410
  */
950
1411
  issuer: string;
951
1412
 
952
1413
  /**
1414
+ * market capitalisation in ZAR
1415
+ *
953
1416
  * @generated from field: double issuer_zar_market_capitalisation = 5;
954
1417
  */
955
1418
  issuerZarMarketCapitalisation: number;
956
1419
 
957
1420
  /**
1421
+ * currency code for the reg28 field
1422
+ *
958
1423
  * @generated from field: string currency_code = 6;
959
1424
  */
960
1425
  currencyCode: string;
961
1426
 
962
1427
  /**
1428
+ * Details on whether the instrument attributes meet the requirements for the Set
1429
+ *
963
1430
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
964
1431
  */
965
1432
  validation?: Instrument_Validation | undefined;
966
1433
  };
967
1434
 
968
1435
  /**
1436
+ * The Reg28 set
1437
+ *
969
1438
  * @generated from message alis.open.cx.v1.Instrument.Reg28
970
1439
  */
971
1440
  export declare type Instrument_Reg28Json = {
972
1441
  /**
1442
+ * The different categories of securities
1443
+ *
973
1444
  * @generated from field: alis.open.cx.v1.Instrument.Reg28.Category category = 1;
974
1445
  */
975
1446
  category?: Instrument_Reg28_CategoryJson;
976
1447
 
977
1448
  /**
1449
+ * Issuer of instrument is listed on an exchange
1450
+ *
978
1451
  * @generated from field: google.protobuf.BoolValue exchange_listed_issuer = 2;
979
1452
  */
980
1453
  exchangeListedIssuer?: BoolValueJson;
981
1454
 
982
1455
  /**
1456
+ * Description of the specific instrument type within its market sector.
1457
+ * This typically depends on the market sector and is fairly flexible
1458
+ *
983
1459
  * @generated from field: string security_type = 3;
984
1460
  */
985
1461
  securityType?: string;
986
1462
 
987
1463
  /**
1464
+ * Name of the issuing entity of the security.
1465
+ *
988
1466
  * @generated from field: string issuer = 4;
989
1467
  */
990
1468
  issuer?: string;
991
1469
 
992
1470
  /**
1471
+ * market capitalisation in ZAR
1472
+ *
993
1473
  * @generated from field: double issuer_zar_market_capitalisation = 5;
994
1474
  */
995
1475
  issuerZarMarketCapitalisation?: number | "NaN" | "Infinity" | "-Infinity";
996
1476
 
997
1477
  /**
1478
+ * currency code for the reg28 field
1479
+ *
998
1480
  * @generated from field: string currency_code = 6;
999
1481
  */
1000
1482
  currencyCode?: string;
1001
1483
 
1002
1484
  /**
1485
+ * Details on whether the instrument attributes meet the requirements for the Set
1486
+ *
1003
1487
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
1004
1488
  */
1005
1489
  validation?: Instrument_ValidationJson;
@@ -1012,116 +1496,191 @@ export declare type Instrument_Reg28Json = {
1012
1496
  export declare const Instrument_Reg28Schema: GenMessage<Instrument_Reg28, {jsonType: Instrument_Reg28Json}>;
1013
1497
 
1014
1498
  /**
1499
+ * List of available Reg 28 Categories
1500
+ *
1015
1501
  * @generated from enum alis.open.cx.v1.Instrument.Reg28.Category
1016
1502
  */
1017
1503
  export enum Instrument_Reg28_Category {
1018
1504
  /**
1505
+ * Category not provided by the user.
1506
+ *
1019
1507
  * @generated from enum value: CATEGORY_UNSPECIFIED = 0;
1020
1508
  */
1021
1509
  CATEGORY_UNSPECIFIED = 0,
1022
1510
 
1023
1511
  /**
1512
+ * Notes and coins; any balance or deposit in an account
1513
+ * held with a South African bank;
1514
+ * A money market instrument issued by a South African
1515
+ * bank including an Islamic liquidity management financial
1516
+ * instrument;
1517
+ * Any positive net balance in a margin account with an
1518
+ * exchange; and
1519
+ * Any positive net balance in a settlement account with an
1520
+ * exchange, operated for the buying and selling of assets.
1521
+ *
1024
1522
  * @generated from enum value: CASH_INSIDE_THE_REPUBLIC = 1;
1025
1523
  */
1026
1524
  CASH_INSIDE_THE_REPUBLIC = 1,
1027
1525
 
1028
1526
  /**
1527
+ * Any balance or deposit held with a foreign bank;
1528
+ * A money market instrument issued by a foreign bank
1529
+ * including an Islamic liquidity management financial
1530
+ * instrument;
1531
+ *
1029
1532
  * @generated from enum value: CASH_FOREIGN_ASSETS = 2;
1030
1533
  */
1031
1534
  CASH_FOREIGN_ASSETS = 2,
1032
1535
 
1033
1536
  /**
1537
+ * Debt instruments issued by, and loans to, the
1538
+ * government of the Republic, and any debt or loan
1539
+ * guaranteed by the Republic
1540
+ *
1034
1541
  * @generated from enum value: DEBT_GUARANTEED_BY_THE_REPUBLIC = 3;
1035
1542
  */
1036
1543
  DEBT_GUARANTEED_BY_THE_REPUBLIC = 3,
1037
1544
 
1038
1545
  /**
1546
+ * Debt instruments issued or guaranteed by the
1547
+ * government of a foreign country
1548
+ *
1039
1549
  * @generated from enum value: DEBT_GUARANTEED_BY_FOREIGN_COUNTRY = 4;
1040
1550
  */
1041
1551
  DEBT_GUARANTEED_BY_FOREIGN_COUNTRY = 4,
1042
1552
 
1043
1553
  /**
1554
+ * Debt instruments issued or guaranteed by a South
1555
+ * African bank against its balance sheet subject to issuer listing status
1556
+ * and prevailing market capitalisation
1557
+ *
1044
1558
  * @generated from enum value: DEBT_GUARANTEED_BY_SOUTH_AFRICAN_BANK = 5;
1045
1559
  */
1046
1560
  DEBT_GUARANTEED_BY_SOUTH_AFRICAN_BANK = 5,
1047
1561
 
1048
1562
  /**
1563
+ * Debt instruments issued or guaranteed by an entity
1564
+ * that has equity listed on an exchange, or debt
1565
+ * instruments issued or guaranteed by a public entity
1566
+ * under the Public Finance Management Act, 1999
1567
+ * (Act No. 1 of 1999)
1568
+ *
1049
1569
  * @generated from enum value: DEBT_GUARANTEED_BY_LISTED_OR_PFMA_ENTITY = 6;
1050
1570
  */
1051
1571
  DEBT_GUARANTEED_BY_LISTED_OR_PFMA_ENTITY = 6,
1052
1572
 
1053
1573
  /**
1574
+ * Other debt instruments
1575
+ *
1054
1576
  * @generated from enum value: DEBT_OTHER = 7;
1055
1577
  */
1056
1578
  DEBT_OTHER = 7,
1057
1579
 
1058
1580
  /**
1581
+ * Preference and ordinary shares in companies,
1582
+ * excluding shares in property companies
1583
+ *
1059
1584
  * @generated from enum value: EQUITIES = 8;
1060
1585
  */
1061
1586
  EQUITIES = 8,
1062
1587
 
1063
1588
  /**
1589
+ * Preference shares, ordinary shares and linked units
1590
+ * comprising shares linked to debentures in property
1591
+ * companies, or units in a Collective Investment
1592
+ * Scheme in Property
1593
+ *
1064
1594
  * @generated from enum value: IMMOVABLE_PROPERTY = 10;
1065
1595
  */
1066
1596
  IMMOVABLE_PROPERTY = 10,
1067
1597
 
1068
1598
  /**
1599
+ * Kruger Rands and other commodities listed on an
1600
+ * exchange, including exchange traded commodities.
1601
+ *
1069
1602
  * @generated from enum value: COMMODITIES_GOLD = 12;
1070
1603
  */
1071
1604
  COMMODITIES_GOLD = 12,
1072
1605
 
1073
1606
  /**
1607
+ * All other non-gold commodities
1608
+ *
1074
1609
  * @generated from enum value: COMMODITIES_OTHER = 13;
1075
1610
  */
1076
1611
  COMMODITIES_OTHER = 13,
1077
1612
 
1078
1613
  /**
1614
+ * Investments in the business of a participating employer
1615
+ * inside the republic in terms of Section 19(4) of the Pension Funds Act (PFA)
1616
+ *
1079
1617
  * @generated from enum value: PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4 = 14;
1080
1618
  */
1081
1619
  PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4 = 14,
1082
1620
 
1083
1621
  /**
1622
+ * Investments in the business of a participating employer
1623
+ * inside the republic in terms of the extent it has been allowed by an exemption in terms of
1624
+ * section 19(4A) of the Pension Funds Act
1625
+ *
1084
1626
  * @generated from enum value: PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4A_EXEMPT = 15;
1085
1627
  */
1086
1628
  PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4A_EXEMPT = 15,
1087
1629
 
1088
1630
  /**
1631
+ * Housing loans granted to members in accordance with the provisions of Section 19(5)
1632
+ *
1089
1633
  * @generated from enum value: HOUSING_LOANS = 16;
1090
1634
  */
1091
1635
  HOUSING_LOANS = 16,
1092
1636
 
1093
1637
  /**
1638
+ * Funds of hedge funds
1639
+ *
1094
1640
  * @generated from enum value: OTHER_ASSETS_FUNDS_OF_HEDGE_FUNDS = 17;
1095
1641
  */
1096
1642
  OTHER_ASSETS_FUNDS_OF_HEDGE_FUNDS = 17,
1097
1643
 
1098
1644
  /**
1645
+ * Hedge funds
1646
+ *
1099
1647
  * @generated from enum value: OTHER_ASSETS_HEDGE_FUNDS = 18;
1100
1648
  */
1101
1649
  OTHER_ASSETS_HEDGE_FUNDS = 18,
1102
1650
 
1103
1651
  /**
1652
+ * Funds of private equity funds
1653
+ *
1104
1654
  * @generated from enum value: OTHER_ASSETS_FUNDS_OF_PRIVATE_EQUITY_FUNDS = 19;
1105
1655
  */
1106
1656
  OTHER_ASSETS_FUNDS_OF_PRIVATE_EQUITY_FUNDS = 19,
1107
1657
 
1108
1658
  /**
1659
+ * Private equity funds
1660
+ *
1109
1661
  * @generated from enum value: OTHER_ASSETS_PRIVATE_EQUITY_FUNDS = 20;
1110
1662
  */
1111
1663
  OTHER_ASSETS_PRIVATE_EQUITY_FUNDS = 20,
1112
1664
 
1113
1665
  /**
1666
+ * Other assets not referred to in this schedule and
1667
+ * excluding a hedge fund or private equity fund
1668
+ *
1114
1669
  * @generated from enum value: OTHER_ASSETS_NOT_REFERRED_TO_IN_SCHEDULE = 21;
1115
1670
  */
1116
1671
  OTHER_ASSETS_NOT_REFERRED_TO_IN_SCHEDULE = 21,
1117
1672
 
1118
1673
  /**
1674
+ * Assets excluding from all other categorisations
1675
+ *
1119
1676
  * @generated from enum value: EXCLUDED_ASSETS = 22;
1120
1677
  */
1121
1678
  EXCLUDED_ASSETS = 22,
1122
1679
  }
1123
1680
 
1124
1681
  /**
1682
+ * List of available Reg 28 Categories
1683
+ *
1125
1684
  * @generated from enum alis.open.cx.v1.Instrument.Reg28.Category
1126
1685
  */
1127
1686
  export declare type Instrument_Reg28_CategoryJson = "CATEGORY_UNSPECIFIED" | "CASH_INSIDE_THE_REPUBLIC" | "CASH_FOREIGN_ASSETS" | "DEBT_GUARANTEED_BY_THE_REPUBLIC" | "DEBT_GUARANTEED_BY_FOREIGN_COUNTRY" | "DEBT_GUARANTEED_BY_SOUTH_AFRICAN_BANK" | "DEBT_GUARANTEED_BY_LISTED_OR_PFMA_ENTITY" | "DEBT_OTHER" | "EQUITIES" | "IMMOVABLE_PROPERTY" | "COMMODITIES_GOLD" | "COMMODITIES_OTHER" | "PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4" | "PARTICIPATING_EMPLOYER_BUSINESS_PFA_SECTION_19_4A_EXEMPT" | "HOUSING_LOANS" | "OTHER_ASSETS_FUNDS_OF_HEDGE_FUNDS" | "OTHER_ASSETS_HEDGE_FUNDS" | "OTHER_ASSETS_FUNDS_OF_PRIVATE_EQUITY_FUNDS" | "OTHER_ASSETS_PRIVATE_EQUITY_FUNDS" | "OTHER_ASSETS_NOT_REFERRED_TO_IN_SCHEDULE" | "EXCLUDED_ASSETS";
@@ -1132,80 +1691,116 @@ export declare type Instrument_Reg28_CategoryJson = "CATEGORY_UNSPECIFIED" | "CA
1132
1691
  export declare const Instrument_Reg28_CategorySchema: GenEnum<Instrument_Reg28_Category, Instrument_Reg28_CategoryJson>;
1133
1692
 
1134
1693
  /**
1694
+ * The CISCA set
1695
+ *
1135
1696
  * @generated from message alis.open.cx.v1.Instrument.Cisca
1136
1697
  */
1137
1698
  export declare type Instrument_Cisca = Message<"alis.open.cx.v1.Instrument.Cisca"> & {
1138
1699
  /**
1700
+ * The different categories of securities
1701
+ *
1139
1702
  * @generated from field: alis.open.cx.v1.Instrument.Cisca.Category category = 1;
1140
1703
  */
1141
1704
  category: Instrument_Cisca_Category;
1142
1705
 
1143
1706
  /**
1707
+ * Description of the specific instrument type within its market sector.
1708
+ * This typically depends on the market sector and is fairly flexible
1709
+ *
1144
1710
  * @generated from field: string security_type = 3;
1145
1711
  */
1146
1712
  securityType: string;
1147
1713
 
1148
1714
  /**
1715
+ * Name of the issuing entity of the security.
1716
+ *
1149
1717
  * @generated from field: string issuer = 4;
1150
1718
  */
1151
1719
  issuer: string;
1152
1720
 
1153
1721
  /**
1722
+ * indication if security has embedded leveraged
1723
+ *
1154
1724
  * @generated from field: google.protobuf.BoolValue has_embedded_leverage = 5;
1155
1725
  */
1156
1726
  hasEmbeddedLeverage?: boolean | undefined;
1157
1727
 
1158
1728
  /**
1729
+ * equity security's weighting in its relevant index
1730
+ * e.g. 0.5 = 50%
1731
+ *
1159
1732
  * @generated from field: double index_weight = 6;
1160
1733
  */
1161
1734
  indexWeight: number;
1162
1735
 
1163
1736
  /**
1737
+ * market capitalisation in ZAR
1738
+ *
1164
1739
  * @generated from field: double issuer_market_capitalisation = 7;
1165
1740
  */
1166
1741
  issuerMarketCapitalisation: number;
1167
1742
 
1168
1743
  /**
1744
+ * Details on whether the instrument attributes meet the requirements for the Set
1745
+ *
1169
1746
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
1170
1747
  */
1171
1748
  validation?: Instrument_Validation | undefined;
1172
1749
  };
1173
1750
 
1174
1751
  /**
1752
+ * The CISCA set
1753
+ *
1175
1754
  * @generated from message alis.open.cx.v1.Instrument.Cisca
1176
1755
  */
1177
1756
  export declare type Instrument_CiscaJson = {
1178
1757
  /**
1758
+ * The different categories of securities
1759
+ *
1179
1760
  * @generated from field: alis.open.cx.v1.Instrument.Cisca.Category category = 1;
1180
1761
  */
1181
1762
  category?: Instrument_Cisca_CategoryJson;
1182
1763
 
1183
1764
  /**
1765
+ * Description of the specific instrument type within its market sector.
1766
+ * This typically depends on the market sector and is fairly flexible
1767
+ *
1184
1768
  * @generated from field: string security_type = 3;
1185
1769
  */
1186
1770
  securityType?: string;
1187
1771
 
1188
1772
  /**
1773
+ * Name of the issuing entity of the security.
1774
+ *
1189
1775
  * @generated from field: string issuer = 4;
1190
1776
  */
1191
1777
  issuer?: string;
1192
1778
 
1193
1779
  /**
1780
+ * indication if security has embedded leveraged
1781
+ *
1194
1782
  * @generated from field: google.protobuf.BoolValue has_embedded_leverage = 5;
1195
1783
  */
1196
1784
  hasEmbeddedLeverage?: BoolValueJson;
1197
1785
 
1198
1786
  /**
1787
+ * equity security's weighting in its relevant index
1788
+ * e.g. 0.5 = 50%
1789
+ *
1199
1790
  * @generated from field: double index_weight = 6;
1200
1791
  */
1201
1792
  indexWeight?: number | "NaN" | "Infinity" | "-Infinity";
1202
1793
 
1203
1794
  /**
1795
+ * market capitalisation in ZAR
1796
+ *
1204
1797
  * @generated from field: double issuer_market_capitalisation = 7;
1205
1798
  */
1206
1799
  issuerMarketCapitalisation?: number | "NaN" | "Infinity" | "-Infinity";
1207
1800
 
1208
1801
  /**
1802
+ * Details on whether the instrument attributes meet the requirements for the Set
1803
+ *
1209
1804
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
1210
1805
  */
1211
1806
  validation?: Instrument_ValidationJson;
@@ -1218,161 +1813,227 @@ export declare type Instrument_CiscaJson = {
1218
1813
  export declare const Instrument_CiscaSchema: GenMessage<Instrument_Cisca, {jsonType: Instrument_CiscaJson}>;
1219
1814
 
1220
1815
  /**
1816
+ * List of available CISCA categories
1817
+ *
1221
1818
  * @generated from enum alis.open.cx.v1.Instrument.Cisca.Category
1222
1819
  */
1223
1820
  export enum Instrument_Cisca_Category {
1224
1821
  /**
1822
+ * Category not provided by the user.
1823
+ *
1225
1824
  * @generated from enum value: CATEGORY_UNSPECIFIED = 0;
1226
1825
  */
1227
1826
  CATEGORY_UNSPECIFIED = 0,
1228
1827
 
1229
1828
  /**
1829
+ * Non-Equity security issued/guaranteed by Republic of South Africa
1830
+ *
1230
1831
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_REPUBLIC_OF_SOUTH_AFRICA = 1;
1231
1832
  */
1232
1833
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_REPUBLIC_OF_SOUTH_AFRICA = 1,
1233
1834
 
1234
1835
  /**
1836
+ * Non-Equity security issued/guaranteed by a foreign government whose sovereign currency rating is the same or higher than Republic of South Africa
1837
+ *
1235
1838
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_NOT_LOWER_SOUTH_AFRICA = 2;
1236
1839
  */
1237
1840
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_NOT_LOWER_SOUTH_AFRICA = 2,
1238
1841
 
1239
1842
  /**
1843
+ * Non-Equity security issued/guaranteed by a foreign government whose sovereign currency rating is the lower than Republic of South Africa
1844
+ *
1240
1845
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_LOWER_THAN_SOUTH_AFRICA = 3;
1241
1846
  */
1242
1847
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_LOWER_THAN_SOUTH_AFRICA = 3,
1243
1848
 
1244
1849
  /**
1850
+ * Non-Equity security issued/guaranteed by the South African Reserve Bank (SARB)
1851
+ *
1245
1852
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_SARB = 4;
1246
1853
  */
1247
1854
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_SARB = 4,
1248
1855
 
1249
1856
  /**
1857
+ * Non-Equity security issued/guaranteed by the African Development Bank
1858
+ *
1250
1859
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_AFRICAN_DEVELOPMENT_BANK = 5;
1251
1860
  */
1252
1861
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_AFRICAN_DEVELOPMENT_BANK = 5,
1253
1862
 
1254
1863
  /**
1864
+ * Non-Equity security issued/guaranteed by a bank which is part of a listed holding company
1865
+ *
1255
1866
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_BANK_WITH_LISTED_HOLDING_COMPANY = 6;
1256
1867
  */
1257
1868
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_BANK_WITH_LISTED_HOLDING_COMPANY = 6,
1258
1869
 
1259
1870
  /**
1871
+ * Non-Equity security issued/guaranteed by a public entity that is subject to the Public Finance Management Act 1999 (PFMA)
1872
+ *
1260
1873
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_PUBLIC_ENTITY_UNDER_PFMA = 9;
1261
1874
  */
1262
1875
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_PUBLIC_ENTITY_UNDER_PFMA = 9,
1263
1876
 
1264
1877
  /**
1878
+ * Non-Equity security issued/guaranteed by a municipality that is subject to Local Government Municipal Finance Management Act 2003
1879
+ *
1265
1880
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_MUNICIPALITY_UNDER_LGMFMA = 10;
1266
1881
  */
1267
1882
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_MUNICIPALITY_UNDER_LGMFMA = 10,
1268
1883
 
1269
1884
  /**
1885
+ * Non-Equity security issued/guaranteed by a local or foreign entity that is listed on an exchange
1886
+ *
1270
1887
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_LOCAL_OR_FOREIGN_LISTED_ENTITY = 11;
1271
1888
  */
1272
1889
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_LOCAL_OR_FOREIGN_LISTED_ENTITY = 11,
1273
1890
 
1274
1891
  /**
1892
+ * Non-Equity security which are preference shares not part of the issuers share capital
1893
+ *
1275
1894
  * @generated from enum value: NON_EQUITY_PREFERENCE_SHARES_NOT_PART_OF_ISSUER_SHARE_CAPITAL = 12;
1276
1895
  */
1277
1896
  NON_EQUITY_PREFERENCE_SHARES_NOT_PART_OF_ISSUER_SHARE_CAPITAL = 12,
1278
1897
 
1279
1898
  /**
1899
+ * Non-Equity security that exchange traded debentures/notes that have exposure to physical precious metal/s
1900
+ *
1280
1901
  * @generated from enum value: NON_EQUITY_EXCHANGE_TRADED_NON_DELIVERABLE_PRECIOUS_METAL_DEBENTURE = 13;
1281
1902
  */
1282
1903
  NON_EQUITY_EXCHANGE_TRADED_NON_DELIVERABLE_PRECIOUS_METAL_DEBENTURE = 13,
1283
1904
 
1284
1905
  /**
1906
+ * Non-Equity security that is an exchange traded note (ETN) where the portfolio note represents is itself CISCA compliant
1907
+ *
1285
1908
  * @generated from enum value: NON_EQUITY_CISCA_COMPLIANT_ETN = 14;
1286
1909
  */
1287
1910
  NON_EQUITY_CISCA_COMPLIANT_ETN = 14,
1288
1911
 
1289
1912
  /**
1913
+ * Non-Equity security issued/guaranteed by listed entity not described by any non-equity category
1914
+ *
1290
1915
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_LISTED_AND_EXCHANGE_TRADED_ENTITY_NOT_DESCRIBED_OTHERWISE = 15;
1291
1916
  */
1292
1917
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_LISTED_AND_EXCHANGE_TRADED_ENTITY_NOT_DESCRIBED_OTHERWISE = 15,
1293
1918
 
1294
1919
  /**
1920
+ * Non-Equity security issued/guaranteed by by unlisted entity not described by any non-equity category and may include participatory interests in participation bonds
1921
+ *
1295
1922
  * @generated from enum value: NON_EQUITY_ISSUED_OR_GUARANTEED_BY_UNLISTED_ENTITY_NOT_DESCRIBED_OTHERWISE_INCLUDING_PARTICIPATION_BONDS = 16;
1296
1923
  */
1297
1924
  NON_EQUITY_ISSUED_OR_GUARANTEED_BY_UNLISTED_ENTITY_NOT_DESCRIBED_OTHERWISE_INCLUDING_PARTICIPATION_BONDS = 16,
1298
1925
 
1299
1926
  /**
1927
+ * Equity security issued by any one concern that is listed
1928
+ *
1300
1929
  * @generated from enum value: EQUITY_LISTED = 17;
1301
1930
  */
1302
1931
  EQUITY_LISTED = 17,
1303
1932
 
1304
1933
  /**
1934
+ * Equity security issued by any one concern that is unlisted
1935
+ *
1305
1936
  * @generated from enum value: EQUITY_UNLISTED = 18;
1306
1937
  */
1307
1938
  EQUITY_UNLISTED = 18,
1308
1939
 
1309
1940
  /**
1941
+ * Equity security issued by any one concern which is an investment company (meaning a company that is engaged primarily in the
1942
+ * business of investment in the securities of companies for the purpose of revenue and
1943
+ * profit and not for the purpose of exercising control)
1944
+ *
1310
1945
  * @generated from enum value: EQUITY_INVESTMENT_COMPANY = 19;
1311
1946
  */
1312
1947
  EQUITY_INVESTMENT_COMPANY = 19,
1313
1948
 
1314
1949
  /**
1950
+ * Equity security which are preference shares which are part of the issuers share capital
1951
+ *
1315
1952
  * @generated from enum value: EQUITY_PREFERENCE_SHARES_PART_OF_ISSUER_SHARE_CAPITAL = 20;
1316
1953
  */
1317
1954
  EQUITY_PREFERENCE_SHARES_PART_OF_ISSUER_SHARE_CAPITAL = 20,
1318
1955
 
1319
1956
  /**
1957
+ * Equity security that exchange traded fund (ETF) that have exposure to physical precious metal/s of which there is no obligation for physical delivery
1958
+ *
1320
1959
  * @generated from enum value: EQUITY_EXCHANGE_TRADED_NON_DELIVERABLE_PRECIOUS_METAL_ETF = 21;
1321
1960
  */
1322
1961
  EQUITY_EXCHANGE_TRADED_NON_DELIVERABLE_PRECIOUS_METAL_ETF = 21,
1323
1962
 
1324
1963
  /**
1964
+ * Equity security that is an exchange traded fund (ETF) where the portfolio note represents is itself CISCA compliant
1965
+ *
1325
1966
  * @generated from enum value: EQUITY_CISCA_COMPLIANT_ETF = 22;
1326
1967
  */
1327
1968
  EQUITY_CISCA_COMPLIANT_ETF = 22,
1328
1969
 
1329
1970
  /**
1971
+ * Money market security issued/guaranteed by Republic of South Africa
1972
+ *
1330
1973
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_REPUBLIC_OF_SOUTH_AFRICA = 23;
1331
1974
  */
1332
1975
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_REPUBLIC_OF_SOUTH_AFRICA = 23,
1333
1976
 
1334
1977
  /**
1978
+ * Money market security issued/guaranteed by a foreign government whose sovereign currency rating is the same or higher than Republic of South Africa
1979
+ *
1335
1980
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_NOT_LOWER_SOUTH_AFRICA = 24;
1336
1981
  */
1337
1982
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_NOT_LOWER_SOUTH_AFRICA = 24,
1338
1983
 
1339
1984
  /**
1985
+ * Money market security issued/guaranteed by the South African Reserve Bank (SARB)
1986
+ *
1340
1987
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_SARB = 25;
1341
1988
  */
1342
1989
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_SARB = 25,
1343
1990
 
1344
1991
  /**
1992
+ * Money market security issued/guaranteed by a bank which is part of a listed holding company
1993
+ *
1345
1994
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_BANK_WITH_LISTED_HOLDING_COMPANY = 26;
1346
1995
  */
1347
1996
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_BANK_WITH_LISTED_HOLDING_COMPANY = 26,
1348
1997
 
1349
1998
  /**
1999
+ * Money market security issued/guaranteed by a public entity that is subject to the Public Finance Management Act 1999 (PFMA)
2000
+ *
1350
2001
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_PUBLIC_ENTITY_UNDER_PFMA = 28;
1351
2002
  */
1352
2003
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_PUBLIC_ENTITY_UNDER_PFMA = 28,
1353
2004
 
1354
2005
  /**
2006
+ * Money market security issued/guaranteed by a local or foreign entity that is listed on an exchange
2007
+ *
1355
2008
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_LOCAL_OR_FOREIGN_LISTED_ENTITY = 29;
1356
2009
  */
1357
2010
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_LOCAL_OR_FOREIGN_LISTED_ENTITY = 29,
1358
2011
 
1359
2012
  /**
2013
+ * Money market security issued/guaranteed by by listed entity not described by any money market category
2014
+ *
1360
2015
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_LISTED_AND_EXCHANGE_TRADED_ENTITY_NOT_DESCRIBED_OTHERWISE = 30;
1361
2016
  */
1362
2017
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_LISTED_AND_EXCHANGE_TRADED_ENTITY_NOT_DESCRIBED_OTHERWISE = 30,
1363
2018
 
1364
2019
  /**
2020
+ * Money market security issued/guaranteed by an unlisted entity not described by any money market category
2021
+ *
1365
2022
  * @generated from enum value: MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_UNLISTED_ENTITY = 31;
1366
2023
  */
1367
2024
  MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_UNLISTED_ENTITY = 31,
1368
2025
 
1369
2026
  /**
2027
+ * Assets held in liquid form
2028
+ *
1370
2029
  * @generated from enum value: ASSETS_IN_LIQUID_FORM = 32;
1371
2030
  */
1372
2031
  ASSETS_IN_LIQUID_FORM = 32,
1373
2032
  }
1374
2033
 
1375
2034
  /**
2035
+ * List of available CISCA categories
2036
+ *
1376
2037
  * @generated from enum alis.open.cx.v1.Instrument.Cisca.Category
1377
2038
  */
1378
2039
  export declare type Instrument_Cisca_CategoryJson = "CATEGORY_UNSPECIFIED" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_REPUBLIC_OF_SOUTH_AFRICA" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_NOT_LOWER_SOUTH_AFRICA" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_LOWER_THAN_SOUTH_AFRICA" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_SARB" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_AFRICAN_DEVELOPMENT_BANK" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_BANK_WITH_LISTED_HOLDING_COMPANY" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_PUBLIC_ENTITY_UNDER_PFMA" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_MUNICIPALITY_UNDER_LGMFMA" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_LOCAL_OR_FOREIGN_LISTED_ENTITY" | "NON_EQUITY_PREFERENCE_SHARES_NOT_PART_OF_ISSUER_SHARE_CAPITAL" | "NON_EQUITY_EXCHANGE_TRADED_NON_DELIVERABLE_PRECIOUS_METAL_DEBENTURE" | "NON_EQUITY_CISCA_COMPLIANT_ETN" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_LISTED_AND_EXCHANGE_TRADED_ENTITY_NOT_DESCRIBED_OTHERWISE" | "NON_EQUITY_ISSUED_OR_GUARANTEED_BY_UNLISTED_ENTITY_NOT_DESCRIBED_OTHERWISE_INCLUDING_PARTICIPATION_BONDS" | "EQUITY_LISTED" | "EQUITY_UNLISTED" | "EQUITY_INVESTMENT_COMPANY" | "EQUITY_PREFERENCE_SHARES_PART_OF_ISSUER_SHARE_CAPITAL" | "EQUITY_EXCHANGE_TRADED_NON_DELIVERABLE_PRECIOUS_METAL_ETF" | "EQUITY_CISCA_COMPLIANT_ETF" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_REPUBLIC_OF_SOUTH_AFRICA" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_FOREIGN_GOVERNMENT_WITH_SOVEREIGN_CURRENCY_RATING_NOT_LOWER_SOUTH_AFRICA" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_SARB" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_BANK_WITH_LISTED_HOLDING_COMPANY" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_PUBLIC_ENTITY_UNDER_PFMA" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_LOCAL_OR_FOREIGN_LISTED_ENTITY" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_LISTED_AND_EXCHANGE_TRADED_ENTITY_NOT_DESCRIBED_OTHERWISE" | "MONEY_MARKET_ISSUED_OR_GUARANTEED_BY_UNLISTED_ENTITY" | "ASSETS_IN_LIQUID_FORM";
@@ -1383,40 +2044,62 @@ export declare type Instrument_Cisca_CategoryJson = "CATEGORY_UNSPECIFIED" | "NO
1383
2044
  export declare const Instrument_Cisca_CategorySchema: GenEnum<Instrument_Cisca_Category, Instrument_Cisca_CategoryJson>;
1384
2045
 
1385
2046
  /**
2047
+ * Regulation 30 from Annexure B of the Medical Schemes Act.
2048
+ *
1386
2049
  * @generated from message alis.open.cx.v1.Instrument.Reg30
1387
2050
  */
1388
2051
  export declare type Instrument_Reg30 = Message<"alis.open.cx.v1.Instrument.Reg30"> & {
1389
2052
  /**
2053
+ * The category of the Instrument relates to the Annexure B categorisation
2054
+ * Refer to Page 48 of the Medical Schemes Act 131 of 1998
2055
+ * available at https://www.medicalschemes.com/files/Acts%20and%20Regulations/MSREGS19July2004.pdf
2056
+ * Example: 1.a.ii
2057
+ *
1390
2058
  * @generated from field: string category = 1;
1391
2059
  */
1392
2060
  category: string;
1393
2061
 
1394
2062
  /**
2063
+ * Name of the issuing entity of the security.
2064
+ *
1395
2065
  * @generated from field: string institution = 2;
1396
2066
  */
1397
2067
  institution: string;
1398
2068
 
1399
2069
  /**
2070
+ * Details on whether the instrument attributes meet the requirements for the Set
2071
+ *
1400
2072
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
1401
2073
  */
1402
2074
  validation?: Instrument_Validation | undefined;
1403
2075
  };
1404
2076
 
1405
2077
  /**
2078
+ * Regulation 30 from Annexure B of the Medical Schemes Act.
2079
+ *
1406
2080
  * @generated from message alis.open.cx.v1.Instrument.Reg30
1407
2081
  */
1408
2082
  export declare type Instrument_Reg30Json = {
1409
2083
  /**
2084
+ * The category of the Instrument relates to the Annexure B categorisation
2085
+ * Refer to Page 48 of the Medical Schemes Act 131 of 1998
2086
+ * available at https://www.medicalschemes.com/files/Acts%20and%20Regulations/MSREGS19July2004.pdf
2087
+ * Example: 1.a.ii
2088
+ *
1410
2089
  * @generated from field: string category = 1;
1411
2090
  */
1412
2091
  category?: string;
1413
2092
 
1414
2093
  /**
2094
+ * Name of the issuing entity of the security.
2095
+ *
1415
2096
  * @generated from field: string institution = 2;
1416
2097
  */
1417
2098
  institution?: string;
1418
2099
 
1419
2100
  /**
2101
+ * Details on whether the instrument attributes meet the requirements for the Set
2102
+ *
1420
2103
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
1421
2104
  */
1422
2105
  validation?: Instrument_ValidationJson;
@@ -1429,30 +2112,46 @@ export declare type Instrument_Reg30Json = {
1429
2112
  export declare const Instrument_Reg30Schema: GenMessage<Instrument_Reg30, {jsonType: Instrument_Reg30Json}>;
1430
2113
 
1431
2114
  /**
2115
+ * The SARB C23 set
2116
+ *
1432
2117
  * @generated from message alis.open.cx.v1.Instrument.SarbC23
1433
2118
  */
1434
2119
  export declare type Instrument_SarbC23 = Message<"alis.open.cx.v1.Instrument.SarbC23"> & {
1435
2120
  /**
2121
+ * The different categories of securities
2122
+ * These are defined by the C23 form, essentially each row in the table has a unique row number / id.
2123
+ *
1436
2124
  * @generated from field: repeated int32 category_ids = 1;
1437
2125
  */
1438
2126
  categoryIds: number[];
1439
2127
 
1440
2128
  /**
2129
+ * Details on whether the instrument attributes meet the requirements for the Set
2130
+ * Not yet implemented
2131
+ *
1441
2132
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
1442
2133
  */
1443
2134
  validation?: Instrument_Validation | undefined;
1444
2135
  };
1445
2136
 
1446
2137
  /**
2138
+ * The SARB C23 set
2139
+ *
1447
2140
  * @generated from message alis.open.cx.v1.Instrument.SarbC23
1448
2141
  */
1449
2142
  export declare type Instrument_SarbC23Json = {
1450
2143
  /**
2144
+ * The different categories of securities
2145
+ * These are defined by the C23 form, essentially each row in the table has a unique row number / id.
2146
+ *
1451
2147
  * @generated from field: repeated int32 category_ids = 1;
1452
2148
  */
1453
2149
  categoryIds?: number[];
1454
2150
 
1455
2151
  /**
2152
+ * Details on whether the instrument attributes meet the requirements for the Set
2153
+ * Not yet implemented
2154
+ *
1456
2155
  * @generated from field: alis.open.cx.v1.Instrument.Validation validation = 99;
1457
2156
  */
1458
2157
  validation?: Instrument_ValidationJson;
@@ -1465,30 +2164,42 @@ export declare type Instrument_SarbC23Json = {
1465
2164
  export declare const Instrument_SarbC23Schema: GenMessage<Instrument_SarbC23, {jsonType: Instrument_SarbC23Json}>;
1466
2165
 
1467
2166
  /**
2167
+ * credit rating
2168
+ *
1468
2169
  * @generated from message alis.open.cx.v1.Instrument.CreditRating
1469
2170
  */
1470
2171
  export declare type Instrument_CreditRating = Message<"alis.open.cx.v1.Instrument.CreditRating"> & {
1471
2172
  /**
2173
+ * Agency that has assigned rating to instrument or entity
2174
+ *
1472
2175
  * @generated from field: alis.open.cx.v1.Instrument.RatingAgency rating_agency = 1;
1473
2176
  */
1474
2177
  ratingAgency: Instrument_RatingAgency;
1475
2178
 
1476
2179
  /**
2180
+ * Rating assigned to instrument or entity
2181
+ *
1477
2182
  * @generated from field: alis.open.cx.v1.Instrument.CreditRatingScale credit_rating_scale = 2;
1478
2183
  */
1479
2184
  creditRatingScale: Instrument_CreditRatingScale;
1480
2185
  };
1481
2186
 
1482
2187
  /**
2188
+ * credit rating
2189
+ *
1483
2190
  * @generated from message alis.open.cx.v1.Instrument.CreditRating
1484
2191
  */
1485
2192
  export declare type Instrument_CreditRatingJson = {
1486
2193
  /**
2194
+ * Agency that has assigned rating to instrument or entity
2195
+ *
1487
2196
  * @generated from field: alis.open.cx.v1.Instrument.RatingAgency rating_agency = 1;
1488
2197
  */
1489
2198
  ratingAgency?: Instrument_RatingAgencyJson;
1490
2199
 
1491
2200
  /**
2201
+ * Rating assigned to instrument or entity
2202
+ *
1492
2203
  * @generated from field: alis.open.cx.v1.Instrument.CreditRatingScale credit_rating_scale = 2;
1493
2204
  */
1494
2205
  creditRatingScale?: Instrument_CreditRatingScaleJson;
@@ -1501,30 +2212,44 @@ export declare type Instrument_CreditRatingJson = {
1501
2212
  export declare const Instrument_CreditRatingSchema: GenMessage<Instrument_CreditRating, {jsonType: Instrument_CreditRatingJson}>;
1502
2213
 
1503
2214
  /**
2215
+ * Whether an instrument's attributes meet the requirements for a set, and
2216
+ * which fields need attention.
2217
+ *
1504
2218
  * @generated from message alis.open.cx.v1.Instrument.Validation
1505
2219
  */
1506
2220
  export declare type Instrument_Validation = Message<"alis.open.cx.v1.Instrument.Validation"> & {
1507
2221
  /**
2222
+ * Whether the instrument's attributes meet the requirements for the set.
2223
+ *
1508
2224
  * @generated from field: bool is_valid = 1;
1509
2225
  */
1510
2226
  isValid: boolean;
1511
2227
 
1512
2228
  /**
2229
+ * Fields which require attention
2230
+ *
1513
2231
  * @generated from field: repeated alis.open.cx.v1.Instrument.Validation.Field invalid_fields = 2;
1514
2232
  */
1515
2233
  invalidFields: Instrument_Validation_Field[];
1516
2234
  };
1517
2235
 
1518
2236
  /**
2237
+ * Whether an instrument's attributes meet the requirements for a set, and
2238
+ * which fields need attention.
2239
+ *
1519
2240
  * @generated from message alis.open.cx.v1.Instrument.Validation
1520
2241
  */
1521
2242
  export declare type Instrument_ValidationJson = {
1522
2243
  /**
2244
+ * Whether the instrument's attributes meet the requirements for the set.
2245
+ *
1523
2246
  * @generated from field: bool is_valid = 1;
1524
2247
  */
1525
2248
  isValid?: boolean;
1526
2249
 
1527
2250
  /**
2251
+ * Fields which require attention
2252
+ *
1528
2253
  * @generated from field: repeated alis.open.cx.v1.Instrument.Validation.Field invalid_fields = 2;
1529
2254
  */
1530
2255
  invalidFields?: Instrument_Validation_FieldJson[];
@@ -1537,30 +2262,44 @@ export declare type Instrument_ValidationJson = {
1537
2262
  export declare const Instrument_ValidationSchema: GenMessage<Instrument_Validation, {jsonType: Instrument_ValidationJson}>;
1538
2263
 
1539
2264
  /**
2265
+ * A single Field
2266
+ *
1540
2267
  * @generated from message alis.open.cx.v1.Instrument.Validation.Field
1541
2268
  */
1542
2269
  export declare type Instrument_Validation_Field = Message<"alis.open.cx.v1.Instrument.Validation.Field"> & {
1543
2270
  /**
2271
+ * Name of the field
2272
+ * Examples: reg28.category, cisca.issuer, etc.
2273
+ *
1544
2274
  * @generated from field: string name = 1;
1545
2275
  */
1546
2276
  name: string;
1547
2277
 
1548
2278
  /**
2279
+ * Validation notes for the field.
2280
+ *
1549
2281
  * @generated from field: string notes = 2;
1550
2282
  */
1551
2283
  notes: string;
1552
2284
  };
1553
2285
 
1554
2286
  /**
2287
+ * A single Field
2288
+ *
1555
2289
  * @generated from message alis.open.cx.v1.Instrument.Validation.Field
1556
2290
  */
1557
2291
  export declare type Instrument_Validation_FieldJson = {
1558
2292
  /**
2293
+ * Name of the field
2294
+ * Examples: reg28.category, cisca.issuer, etc.
2295
+ *
1559
2296
  * @generated from field: string name = 1;
1560
2297
  */
1561
2298
  name?: string;
1562
2299
 
1563
2300
  /**
2301
+ * Validation notes for the field.
2302
+ *
1564
2303
  * @generated from field: string notes = 2;
1565
2304
  */
1566
2305
  notes?: string;
@@ -1573,66 +2312,92 @@ export declare type Instrument_Validation_FieldJson = {
1573
2312
  export declare const Instrument_Validation_FieldSchema: GenMessage<Instrument_Validation_Field, {jsonType: Instrument_Validation_FieldJson}>;
1574
2313
 
1575
2314
  /**
2315
+ * The instrument market sector
2316
+ *
1576
2317
  * @generated from enum alis.open.cx.v1.Instrument.MarketSector
1577
2318
  */
1578
2319
  export enum Instrument_MarketSector {
1579
2320
  /**
2321
+ * Market Sector not specified
2322
+ *
1580
2323
  * @generated from enum value: MARKET_SECTOR_UNSPECIFIED = 0;
1581
2324
  */
1582
2325
  MARKET_SECTOR_UNSPECIFIED = 0,
1583
2326
 
1584
2327
  /**
2328
+ * Commodities
2329
+ *
1585
2330
  * @generated from enum value: COMMODITY = 1;
1586
2331
  */
1587
2332
  COMMODITY = 1,
1588
2333
 
1589
2334
  /**
2335
+ * Corporate Bonds
2336
+ *
1590
2337
  * @generated from enum value: CORPORATE = 2;
1591
2338
  */
1592
2339
  CORPORATE = 2,
1593
2340
 
1594
2341
  /**
2342
+ * Currency
2343
+ *
1595
2344
  * @generated from enum value: CURRENCY = 3;
1596
2345
  */
1597
2346
  CURRENCY = 3,
1598
2347
 
1599
2348
  /**
2349
+ * Equity
2350
+ *
1600
2351
  * @generated from enum value: EQUITY = 4;
1601
2352
  */
1602
2353
  EQUITY = 4,
1603
2354
 
1604
2355
  /**
2356
+ * Market index
2357
+ *
1605
2358
  * @generated from enum value: INDEX = 5;
1606
2359
  */
1607
2360
  INDEX = 5,
1608
2361
 
1609
2362
  /**
2363
+ * Money Market
2364
+ *
1610
2365
  * @generated from enum value: MONEY_MARKET = 6;
1611
2366
  */
1612
2367
  MONEY_MARKET = 6,
1613
2368
 
1614
2369
  /**
2370
+ * Government Bonds
2371
+ *
1615
2372
  * @generated from enum value: GOVERNMENT = 7;
1616
2373
  */
1617
2374
  GOVERNMENT = 7,
1618
2375
 
1619
2376
  /**
2377
+ * Mortgage Backed
2378
+ *
1620
2379
  * @generated from enum value: MTGE = 8;
1621
2380
  */
1622
2381
  MTGE = 8,
1623
2382
 
1624
2383
  /**
2384
+ * Municipal Bonds
2385
+ *
1625
2386
  * @generated from enum value: MUNI = 9;
1626
2387
  */
1627
2388
  MUNI = 9,
1628
2389
 
1629
2390
  /**
2391
+ * Preferred Stock
2392
+ *
1630
2393
  * @generated from enum value: PFD = 10;
1631
2394
  */
1632
2395
  PFD = 10,
1633
2396
  }
1634
2397
 
1635
2398
  /**
2399
+ * The instrument market sector
2400
+ *
1636
2401
  * @generated from enum alis.open.cx.v1.Instrument.MarketSector
1637
2402
  */
1638
2403
  export declare type Instrument_MarketSectorJson = "MARKET_SECTOR_UNSPECIFIED" | "COMMODITY" | "CORPORATE" | "CURRENCY" | "EQUITY" | "INDEX" | "MONEY_MARKET" | "GOVERNMENT" | "MTGE" | "MUNI" | "PFD";
@@ -1643,231 +2408,323 @@ export declare type Instrument_MarketSectorJson = "MARKET_SECTOR_UNSPECIFIED" |
1643
2408
  export declare const Instrument_MarketSectorSchema: GenEnum<Instrument_MarketSector, Instrument_MarketSectorJson>;
1644
2409
 
1645
2410
  /**
2411
+ * Credit rating scale
2412
+ *
1646
2413
  * @generated from enum alis.open.cx.v1.Instrument.CreditRatingScale
1647
2414
  */
1648
2415
  export enum Instrument_CreditRatingScale {
1649
2416
  /**
2417
+ * Credit rating scale not provided by the user.
2418
+ *
1650
2419
  * @generated from enum value: CREDIT_RATING_SCALE_UNSPECIFIED = 0;
1651
2420
  */
1652
2421
  CREDIT_RATING_SCALE_UNSPECIFIED = 0,
1653
2422
 
1654
2423
  /**
2424
+ * Prime
2425
+ *
1655
2426
  * @generated from enum value: AAA = 1;
1656
2427
  */
1657
2428
  AAA = 1,
1658
2429
 
1659
2430
  /**
2431
+ * High grade
2432
+ *
1660
2433
  * @generated from enum value: AA1 = 2;
1661
2434
  */
1662
2435
  AA1 = 2,
1663
2436
 
1664
2437
  /**
2438
+ * High grade
2439
+ *
1665
2440
  * @generated from enum value: AA2 = 3;
1666
2441
  */
1667
2442
  AA2 = 3,
1668
2443
 
1669
2444
  /**
2445
+ * High grade
2446
+ *
1670
2447
  * @generated from enum value: AA3 = 4;
1671
2448
  */
1672
2449
  AA3 = 4,
1673
2450
 
1674
2451
  /**
2452
+ * Upper medium grade
2453
+ *
1675
2454
  * @generated from enum value: A1 = 5;
1676
2455
  */
1677
2456
  A1 = 5,
1678
2457
 
1679
2458
  /**
2459
+ * Upper medium grade
2460
+ *
1680
2461
  * @generated from enum value: A2 = 6;
1681
2462
  */
1682
2463
  A2 = 6,
1683
2464
 
1684
2465
  /**
2466
+ * Upper medium grade
2467
+ *
1685
2468
  * @generated from enum value: A3 = 7;
1686
2469
  */
1687
2470
  A3 = 7,
1688
2471
 
1689
2472
  /**
2473
+ * Lower medium grade
2474
+ *
1690
2475
  * @generated from enum value: BAA1 = 8;
1691
2476
  */
1692
2477
  BAA1 = 8,
1693
2478
 
1694
2479
  /**
2480
+ * Lower medium grade
2481
+ *
1695
2482
  * @generated from enum value: BAA2 = 9;
1696
2483
  */
1697
2484
  BAA2 = 9,
1698
2485
 
1699
2486
  /**
2487
+ * Lower medium grade
2488
+ *
1700
2489
  * @generated from enum value: BAA3 = 10;
1701
2490
  */
1702
2491
  BAA3 = 10,
1703
2492
 
1704
2493
  /**
2494
+ * Non-investment grade
2495
+ *
1705
2496
  * @generated from enum value: BA1 = 11;
1706
2497
  */
1707
2498
  BA1 = 11,
1708
2499
 
1709
2500
  /**
2501
+ * Non-investment grade
2502
+ *
1710
2503
  * @generated from enum value: BA2 = 12;
1711
2504
  */
1712
2505
  BA2 = 12,
1713
2506
 
1714
2507
  /**
2508
+ * Non-investment grade
2509
+ *
1715
2510
  * @generated from enum value: BA3 = 13;
1716
2511
  */
1717
2512
  BA3 = 13,
1718
2513
 
1719
2514
  /**
2515
+ * Highly speculative
2516
+ *
1720
2517
  * @generated from enum value: B1 = 14;
1721
2518
  */
1722
2519
  B1 = 14,
1723
2520
 
1724
2521
  /**
2522
+ * Highly speculative
2523
+ *
1725
2524
  * @generated from enum value: B2 = 15;
1726
2525
  */
1727
2526
  B2 = 15,
1728
2527
 
1729
2528
  /**
2529
+ * Highly speculative
2530
+ *
1730
2531
  * @generated from enum value: B3 = 16;
1731
2532
  */
1732
2533
  B3 = 16,
1733
2534
 
1734
2535
  /**
2536
+ * Substantial risk
2537
+ *
1735
2538
  * @generated from enum value: CAA1 = 17;
1736
2539
  */
1737
2540
  CAA1 = 17,
1738
2541
 
1739
2542
  /**
2543
+ * Extremely speculative
2544
+ *
1740
2545
  * @generated from enum value: CAA2 = 18;
1741
2546
  */
1742
2547
  CAA2 = 18,
1743
2548
 
1744
2549
  /**
2550
+ * In default with little prospect of recovery
2551
+ *
1745
2552
  * @generated from enum value: CAA3 = 19;
1746
2553
  */
1747
2554
  CAA3 = 19,
1748
2555
 
1749
2556
  /**
2557
+ * In default with little prospect of recovery
2558
+ *
1750
2559
  * @generated from enum value: CA = 20;
1751
2560
  */
1752
2561
  CA = 20,
1753
2562
 
1754
2563
  /**
2564
+ * In default with little prospect of recovery
2565
+ *
1755
2566
  * @generated from enum value: C = 21;
1756
2567
  */
1757
2568
  C = 21,
1758
2569
 
1759
2570
  /**
2571
+ * High grade
2572
+ *
1760
2573
  * @generated from enum value: AA_PLUS = 23;
1761
2574
  */
1762
2575
  AA_PLUS = 23,
1763
2576
 
1764
2577
  /**
2578
+ * High grade
2579
+ *
1765
2580
  * @generated from enum value: AA = 24;
1766
2581
  */
1767
2582
  AA = 24,
1768
2583
 
1769
2584
  /**
2585
+ * High grade
2586
+ *
1770
2587
  * @generated from enum value: AA_MINUS = 25;
1771
2588
  */
1772
2589
  AA_MINUS = 25,
1773
2590
 
1774
2591
  /**
2592
+ * Upper medium grade
2593
+ *
1775
2594
  * @generated from enum value: A_PLUS = 26;
1776
2595
  */
1777
2596
  A_PLUS = 26,
1778
2597
 
1779
2598
  /**
2599
+ * Upper medium grade
2600
+ *
1780
2601
  * @generated from enum value: A = 27;
1781
2602
  */
1782
2603
  A = 27,
1783
2604
 
1784
2605
  /**
2606
+ * Upper medium grade
2607
+ *
1785
2608
  * @generated from enum value: A_MINUS = 28;
1786
2609
  */
1787
2610
  A_MINUS = 28,
1788
2611
 
1789
2612
  /**
2613
+ * Lower medium grade
2614
+ *
1790
2615
  * @generated from enum value: BBB_PLUS = 29;
1791
2616
  */
1792
2617
  BBB_PLUS = 29,
1793
2618
 
1794
2619
  /**
2620
+ * Lower medium grade
2621
+ *
1795
2622
  * @generated from enum value: BBB = 30;
1796
2623
  */
1797
2624
  BBB = 30,
1798
2625
 
1799
2626
  /**
2627
+ * Lower medium grade
2628
+ *
1800
2629
  * @generated from enum value: BBB_MINUS = 31;
1801
2630
  */
1802
2631
  BBB_MINUS = 31,
1803
2632
 
1804
2633
  /**
2634
+ * Non-investment grade
2635
+ *
1805
2636
  * @generated from enum value: BB_PLUS = 32;
1806
2637
  */
1807
2638
  BB_PLUS = 32,
1808
2639
 
1809
2640
  /**
2641
+ * Non-investment grade
2642
+ *
1810
2643
  * @generated from enum value: BB = 33;
1811
2644
  */
1812
2645
  BB = 33,
1813
2646
 
1814
2647
  /**
2648
+ * Non-investment grade
2649
+ *
1815
2650
  * @generated from enum value: BB_MINUS = 34;
1816
2651
  */
1817
2652
  BB_MINUS = 34,
1818
2653
 
1819
2654
  /**
2655
+ * Highly speculative
2656
+ *
1820
2657
  * @generated from enum value: B_PLUS = 35;
1821
2658
  */
1822
2659
  B_PLUS = 35,
1823
2660
 
1824
2661
  /**
2662
+ * Highly speculative
2663
+ *
1825
2664
  * @generated from enum value: B = 36;
1826
2665
  */
1827
2666
  B = 36,
1828
2667
 
1829
2668
  /**
2669
+ * Highly speculative
2670
+ *
1830
2671
  * @generated from enum value: B_MINUS = 37;
1831
2672
  */
1832
2673
  B_MINUS = 37,
1833
2674
 
1834
2675
  /**
2676
+ * Substantial risk
2677
+ *
1835
2678
  * @generated from enum value: CCC_PLUS = 38;
1836
2679
  */
1837
2680
  CCC_PLUS = 38,
1838
2681
 
1839
2682
  /**
2683
+ * Extremely speculative
2684
+ *
1840
2685
  * @generated from enum value: CCC = 39;
1841
2686
  */
1842
2687
  CCC = 39,
1843
2688
 
1844
2689
  /**
2690
+ * In default with little prospect of recovery
2691
+ *
1845
2692
  * @generated from enum value: CCC_MINUS = 40;
1846
2693
  */
1847
2694
  CCC_MINUS = 40,
1848
2695
 
1849
2696
  /**
2697
+ * In default with little prospect of recovery
2698
+ *
1850
2699
  * @generated from enum value: CC = 41;
1851
2700
  */
1852
2701
  CC = 41,
1853
2702
 
1854
2703
  /**
2704
+ * In default
2705
+ *
1855
2706
  * @generated from enum value: DDD = 42;
1856
2707
  */
1857
2708
  DDD = 42,
1858
2709
 
1859
2710
  /**
2711
+ * In default
2712
+ *
1860
2713
  * @generated from enum value: DD = 43;
1861
2714
  */
1862
2715
  DD = 43,
1863
2716
 
1864
2717
  /**
2718
+ * In default
2719
+ *
1865
2720
  * @generated from enum value: D = 44;
1866
2721
  */
1867
2722
  D = 44,
1868
2723
  }
1869
2724
 
1870
2725
  /**
2726
+ * Credit rating scale
2727
+ *
1871
2728
  * @generated from enum alis.open.cx.v1.Instrument.CreditRatingScale
1872
2729
  */
1873
2730
  export declare type Instrument_CreditRatingScaleJson = "CREDIT_RATING_SCALE_UNSPECIFIED" | "AAA" | "AA1" | "AA2" | "AA3" | "A1" | "A2" | "A3" | "BAA1" | "BAA2" | "BAA3" | "BA1" | "BA2" | "BA3" | "B1" | "B2" | "B3" | "CAA1" | "CAA2" | "CAA3" | "CA" | "C" | "AA_PLUS" | "AA" | "AA_MINUS" | "A_PLUS" | "A" | "A_MINUS" | "BBB_PLUS" | "BBB" | "BBB_MINUS" | "BB_PLUS" | "BB" | "BB_MINUS" | "B_PLUS" | "B" | "B_MINUS" | "CCC_PLUS" | "CCC" | "CCC_MINUS" | "CC" | "DDD" | "DD" | "D";
@@ -1878,31 +2735,43 @@ export declare type Instrument_CreditRatingScaleJson = "CREDIT_RATING_SCALE_UNSP
1878
2735
  export declare const Instrument_CreditRatingScaleSchema: GenEnum<Instrument_CreditRatingScale, Instrument_CreditRatingScaleJson>;
1879
2736
 
1880
2737
  /**
2738
+ * Rating agency
2739
+ *
1881
2740
  * @generated from enum alis.open.cx.v1.Instrument.RatingAgency
1882
2741
  */
1883
2742
  export enum Instrument_RatingAgency {
1884
2743
  /**
2744
+ * Rating agency not provided by the user.
2745
+ *
1885
2746
  * @generated from enum value: RATING_AGENCY_UNSPECIFIED = 0;
1886
2747
  */
1887
2748
  RATING_AGENCY_UNSPECIFIED = 0,
1888
2749
 
1889
2750
  /**
2751
+ * S&P
2752
+ *
1890
2753
  * @generated from enum value: S_AND_P = 1;
1891
2754
  */
1892
2755
  S_AND_P = 1,
1893
2756
 
1894
2757
  /**
2758
+ * Fitch
2759
+ *
1895
2760
  * @generated from enum value: FITCH = 2;
1896
2761
  */
1897
2762
  FITCH = 2,
1898
2763
 
1899
2764
  /**
2765
+ * Moody's
2766
+ *
1900
2767
  * @generated from enum value: MOODYS = 3;
1901
2768
  */
1902
2769
  MOODYS = 3,
1903
2770
  }
1904
2771
 
1905
2772
  /**
2773
+ * Rating agency
2774
+ *
1906
2775
  * @generated from enum alis.open.cx.v1.Instrument.RatingAgency
1907
2776
  */
1908
2777
  export declare type Instrument_RatingAgencyJson = "RATING_AGENCY_UNSPECIFIED" | "S_AND_P" | "FITCH" | "MOODYS";
@@ -1913,26 +2782,36 @@ export declare type Instrument_RatingAgencyJson = "RATING_AGENCY_UNSPECIFIED" |
1913
2782
  export declare const Instrument_RatingAgencySchema: GenEnum<Instrument_RatingAgency, Instrument_RatingAgencyJson>;
1914
2783
 
1915
2784
  /**
2785
+ * The FIGI type.
2786
+ *
1916
2787
  * @generated from enum alis.open.cx.v1.Instrument.FigiType
1917
2788
  */
1918
2789
  export enum Instrument_FigiType {
1919
2790
  /**
2791
+ * Figi Type is not provided
2792
+ *
1920
2793
  * @generated from enum value: FIGI_TYPE_UNSPECIFIED = 0;
1921
2794
  */
1922
2795
  FIGI_TYPE_UNSPECIFIED = 0,
1923
2796
 
1924
2797
  /**
2798
+ * Global FIGI
2799
+ *
1925
2800
  * @generated from enum value: GLOBAL = 1;
1926
2801
  */
1927
2802
  GLOBAL = 1,
1928
2803
 
1929
2804
  /**
2805
+ * Custom generated figi, not available on www.openfigi.com, yet...
2806
+ *
1930
2807
  * @generated from enum value: CUSTOM = 2;
1931
2808
  */
1932
2809
  CUSTOM = 2,
1933
2810
  }
1934
2811
 
1935
2812
  /**
2813
+ * The FIGI type.
2814
+ *
1936
2815
  * @generated from enum alis.open.cx.v1.Instrument.FigiType
1937
2816
  */
1938
2817
  export declare type Instrument_FigiTypeJson = "FIGI_TYPE_UNSPECIFIED" | "GLOBAL" | "CUSTOM";