@canton-network/core-token-standard 0.14.2 → 0.14.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -4,16 +4,55 @@ export { ContractId, Date, Int, Map, Numeric, Optional, Party, Serializable, Tim
4
4
 
5
5
  interface paths$4 {
6
6
  '/registry/allocations/v1/{allocationId}/choice-contexts/execute-transfer': {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ get?: never;
14
+ put?: never;
7
15
  /** @description Get the choice context to execute a transfer on an allocation. */
8
16
  post: operations$3['getAllocationTransferContext'];
17
+ delete?: never;
18
+ options?: never;
19
+ head?: never;
20
+ patch?: never;
21
+ trace?: never;
9
22
  };
10
23
  '/registry/allocations/v1/{allocationId}/choice-contexts/withdraw': {
24
+ parameters: {
25
+ query?: never;
26
+ header?: never;
27
+ path?: never;
28
+ cookie?: never;
29
+ };
30
+ get?: never;
31
+ put?: never;
11
32
  /** @description Get the choice context to withdraw an allocation. */
12
33
  post: operations$3['getAllocationWithdrawContext'];
34
+ delete?: never;
35
+ options?: never;
36
+ head?: never;
37
+ patch?: never;
38
+ trace?: never;
13
39
  };
14
40
  '/registry/allocations/v1/{allocationId}/choice-contexts/cancel': {
41
+ parameters: {
42
+ query?: never;
43
+ header?: never;
44
+ path?: never;
45
+ cookie?: never;
46
+ };
47
+ get?: never;
48
+ put?: never;
15
49
  /** @description Get the choice context to cancel an allocation. */
16
50
  post: operations$3['getAllocationCancelContext'];
51
+ delete?: never;
52
+ options?: never;
53
+ head?: never;
54
+ patch?: never;
55
+ trace?: never;
17
56
  };
18
57
  }
19
58
  interface components$3 {
@@ -22,7 +61,7 @@ interface components$3 {
22
61
  GetChoiceContextRequest: {
23
62
  /**
24
63
  * @description Metadata that will be passed to the choice, and should be incorporated
25
- * into the choice context. Provided for extensibility.
64
+ * into the choice context. Provided for extensibility.
26
65
  */
27
66
  meta?: {
28
67
  [key: string]: string;
@@ -30,15 +69,15 @@ interface components$3 {
30
69
  };
31
70
  /**
32
71
  * @description The context required to exercise a choice on a contract via an interface.
33
- * Used to retrieve additional reference date that is passed in via disclosed contracts,
34
- * which are in turn referred to via their contract ID in the `choiceContextData`.
72
+ * Used to retrieve additional reference date that is passed in via disclosed contracts,
73
+ * which are in turn referred to via their contract ID in the `choiceContextData`.
35
74
  */
36
75
  ChoiceContext: {
37
76
  /** @description The additional data to use when exercising the choice. */
38
77
  choiceContextData: Record<string, never>;
39
78
  /**
40
79
  * @description The contracts that are required to be disclosed to the participant node for exercising
41
- * the choice.
80
+ * the choice.
42
81
  */
43
82
  disclosedContracts: components$3['schemas']['DisclosedContract'][];
44
83
  };
@@ -48,26 +87,26 @@ interface components$3 {
48
87
  createdEventBlob: string;
49
88
  /**
50
89
  * @description The synchronizer to which the contract is currently assigned.
51
- * If the contract is in the process of being reassigned, then a "409" response is returned.
90
+ * If the contract is in the process of being reassigned, then a "409" response is returned.
52
91
  */
53
92
  synchronizerId: string;
54
93
  /**
55
94
  * @description The name of the Daml package that was used to create the contract.
56
- * Use this data only if you trust the provider, as it might not match the data in the
57
- * `createdEventBlob`.
95
+ * Use this data only if you trust the provider, as it might not match the data in the
96
+ * `createdEventBlob`.
58
97
  */
59
98
  debugPackageName?: string;
60
99
  /**
61
100
  * @description The contract arguments that were used to create the contract.
62
- * Use this data only if you trust the provider, as it might not match the data in the
63
- * `createdEventBlob`.
101
+ * Use this data only if you trust the provider, as it might not match the data in the
102
+ * `createdEventBlob`.
64
103
  */
65
104
  debugPayload?: Record<string, never>;
66
105
  /**
67
106
  * Format: date-time
68
107
  * @description The ledger effective time at which the contract was created.
69
- * Use this data only if you trust the provider, as it might not match the data in the
70
- * `createdEventBlob`.
108
+ * Use this data only if you trust the provider, as it might not match the data in the
109
+ * `createdEventBlob`.
71
110
  */
72
111
  debugCreatedAt?: string;
73
112
  };
@@ -78,12 +117,18 @@ interface components$3 {
78
117
  responses: {
79
118
  /** @description bad request */
80
119
  400: {
120
+ headers: {
121
+ [name: string]: unknown;
122
+ };
81
123
  content: {
82
124
  'application/json': components$3['schemas']['ErrorResponse'];
83
125
  };
84
126
  };
85
127
  /** @description not found */
86
128
  404: {
129
+ headers: {
130
+ [name: string]: unknown;
131
+ };
87
132
  content: {
88
133
  'application/json': components$3['schemas']['ErrorResponse'];
89
134
  };
@@ -95,13 +140,15 @@ interface components$3 {
95
140
  pathItems: never;
96
141
  }
97
142
  interface operations$3 {
98
- /** @description Get the choice context to execute a transfer on an allocation. */
99
143
  getAllocationTransferContext: {
100
144
  parameters: {
145
+ query?: never;
146
+ header?: never;
101
147
  path: {
102
148
  /** @description The contract ID of the allocation whose transfer the caller wants to execute. */
103
149
  allocationId: string;
104
150
  };
151
+ cookie?: never;
105
152
  };
106
153
  requestBody: {
107
154
  content: {
@@ -111,6 +158,9 @@ interface operations$3 {
111
158
  responses: {
112
159
  /** @description ok */
113
160
  200: {
161
+ headers: {
162
+ [name: string]: unknown;
163
+ };
114
164
  content: {
115
165
  'application/json': components$3['schemas']['ChoiceContext'];
116
166
  };
@@ -119,13 +169,15 @@ interface operations$3 {
119
169
  404: components$3['responses']['404'];
120
170
  };
121
171
  };
122
- /** @description Get the choice context to withdraw an allocation. */
123
172
  getAllocationWithdrawContext: {
124
173
  parameters: {
174
+ query?: never;
175
+ header?: never;
125
176
  path: {
126
177
  /** @description The contract ID of the allocation to withdraw. */
127
178
  allocationId: string;
128
179
  };
180
+ cookie?: never;
129
181
  };
130
182
  requestBody: {
131
183
  content: {
@@ -135,6 +187,9 @@ interface operations$3 {
135
187
  responses: {
136
188
  /** @description ok */
137
189
  200: {
190
+ headers: {
191
+ [name: string]: unknown;
192
+ };
138
193
  content: {
139
194
  'application/json': components$3['schemas']['ChoiceContext'];
140
195
  };
@@ -143,13 +198,15 @@ interface operations$3 {
143
198
  404: components$3['responses']['404'];
144
199
  };
145
200
  };
146
- /** @description Get the choice context to cancel an allocation. */
147
201
  getAllocationCancelContext: {
148
202
  parameters: {
203
+ query?: never;
204
+ header?: never;
149
205
  path: {
150
206
  /** @description The contract ID of the allocation to cancel. */
151
207
  allocationId: string;
152
208
  };
209
+ cookie?: never;
153
210
  };
154
211
  requestBody: {
155
212
  content: {
@@ -159,6 +216,9 @@ interface operations$3 {
159
216
  responses: {
160
217
  /** @description ok */
161
218
  200: {
219
+ headers: {
220
+ [name: string]: unknown;
221
+ };
162
222
  content: {
163
223
  'application/json': components$3['schemas']['ChoiceContext'];
164
224
  };
@@ -171,8 +231,21 @@ interface operations$3 {
171
231
 
172
232
  interface paths$3 {
173
233
  '/registry/allocation-instruction/v1/allocation-factory': {
234
+ parameters: {
235
+ query?: never;
236
+ header?: never;
237
+ path?: never;
238
+ cookie?: never;
239
+ };
240
+ get?: never;
241
+ put?: never;
174
242
  /** @description Get the factory and choice context for creating allocations using the `AllocationFactory_Allocate` choice. */
175
243
  post: operations$2['getAllocationFactory'];
244
+ delete?: never;
245
+ options?: never;
246
+ head?: never;
247
+ patch?: never;
248
+ trace?: never;
176
249
  };
177
250
  }
178
251
  interface components$2 {
@@ -180,27 +253,27 @@ interface components$2 {
180
253
  GetFactoryRequest: {
181
254
  /**
182
255
  * @description The arguments that are intended to be passed to the choice provided by the factory.
183
- * To avoid repeating the Daml type definitions, they are specified as JSON objects.
184
- * However the concrete format is given by how the choice arguments are encoded using the Daml JSON API
185
- * (with the `extraArgs.context` and `extraArgs.meta` fields set to the empty object).
256
+ * To avoid repeating the Daml type definitions, they are specified as JSON objects.
257
+ * However the concrete format is given by how the choice arguments are encoded using the Daml JSON API
258
+ * (with the `extraArgs.context` and `extraArgs.meta` fields set to the empty object).
186
259
  *
187
- * The choice arguments are provided so that the registry can also provide choice-argument
188
- * specific contracts, e.g., the configuration for a specific instrument-id.
260
+ * The choice arguments are provided so that the registry can also provide choice-argument
261
+ * specific contracts, e.g., the configuration for a specific instrument-id.
189
262
  */
190
263
  choiceArguments: Record<string, never>;
191
264
  /**
192
265
  * @description If set to true, the response will not include debug fields.
193
266
  * @default false
194
267
  */
195
- excludeDebugFields?: boolean;
268
+ excludeDebugFields: boolean;
196
269
  };
197
270
  /**
198
271
  * @description A factory contract together with the choice context required to exercise the choice
199
- * provided by the factory. Typically used to implement the generic initiation of on-ledger workflows
200
- * via a Daml interface.
272
+ * provided by the factory. Typically used to implement the generic initiation of on-ledger workflows
273
+ * via a Daml interface.
201
274
  *
202
- * Clients SHOULD avoid reusing the same `FactoryWithChoiceContext` for exercising multiple choices,
203
- * as the choice context MAY be specific to the choice being exercised.
275
+ * Clients SHOULD avoid reusing the same `FactoryWithChoiceContext` for exercising multiple choices,
276
+ * as the choice context MAY be specific to the choice being exercised.
204
277
  */
205
278
  FactoryWithChoiceContext: {
206
279
  /** @description The contract ID of the contract implementing the factory interface. */
@@ -209,15 +282,15 @@ interface components$2 {
209
282
  };
210
283
  /**
211
284
  * @description The context required to exercise a choice on a contract via an interface.
212
- * Used to retrieve additional reference date that is passed in via disclosed contracts,
213
- * which are in turn referred to via their contract ID in the `choiceContextData`.
285
+ * Used to retrieve additional reference date that is passed in via disclosed contracts,
286
+ * which are in turn referred to via their contract ID in the `choiceContextData`.
214
287
  */
215
288
  ChoiceContext: {
216
289
  /** @description The additional data to use when exercising the choice. */
217
290
  choiceContextData: Record<string, never>;
218
291
  /**
219
292
  * @description The contracts that are required to be disclosed to the participant node for exercising
220
- * the choice.
293
+ * the choice.
221
294
  */
222
295
  disclosedContracts: components$2['schemas']['DisclosedContract'][];
223
296
  };
@@ -227,26 +300,26 @@ interface components$2 {
227
300
  createdEventBlob: string;
228
301
  /**
229
302
  * @description The synchronizer to which the contract is currently assigned.
230
- * If the contract is in the process of being reassigned, then a "409" response is returned.
303
+ * If the contract is in the process of being reassigned, then a "409" response is returned.
231
304
  */
232
305
  synchronizerId: string;
233
306
  /**
234
307
  * @description The name of the Daml package that was used to create the contract.
235
- * Use this data only if you trust the provider, as it might not match the data in the
236
- * `createdEventBlob`.
308
+ * Use this data only if you trust the provider, as it might not match the data in the
309
+ * `createdEventBlob`.
237
310
  */
238
311
  debugPackageName?: string;
239
312
  /**
240
313
  * @description The contract arguments that were used to create the contract.
241
- * Use this data only if you trust the provider, as it might not match the data in the
242
- * `createdEventBlob`.
314
+ * Use this data only if you trust the provider, as it might not match the data in the
315
+ * `createdEventBlob`.
243
316
  */
244
317
  debugPayload?: Record<string, never>;
245
318
  /**
246
319
  * Format: date-time
247
320
  * @description The ledger effective time at which the contract was created.
248
- * Use this data only if you trust the provider, as it might not match the data in the
249
- * `createdEventBlob`.
321
+ * Use this data only if you trust the provider, as it might not match the data in the
322
+ * `createdEventBlob`.
250
323
  */
251
324
  debugCreatedAt?: string;
252
325
  };
@@ -257,12 +330,18 @@ interface components$2 {
257
330
  responses: {
258
331
  /** @description bad request */
259
332
  400: {
333
+ headers: {
334
+ [name: string]: unknown;
335
+ };
260
336
  content: {
261
337
  'application/json': components$2['schemas']['ErrorResponse'];
262
338
  };
263
339
  };
264
340
  /** @description not found */
265
341
  404: {
342
+ headers: {
343
+ [name: string]: unknown;
344
+ };
266
345
  content: {
267
346
  'application/json': components$2['schemas']['ErrorResponse'];
268
347
  };
@@ -274,8 +353,13 @@ interface components$2 {
274
353
  pathItems: never;
275
354
  }
276
355
  interface operations$2 {
277
- /** @description Get the factory and choice context for creating allocations using the `AllocationFactory_Allocate` choice. */
278
356
  getAllocationFactory: {
357
+ parameters: {
358
+ query?: never;
359
+ header?: never;
360
+ path?: never;
361
+ cookie?: never;
362
+ };
279
363
  requestBody: {
280
364
  content: {
281
365
  'application/json': components$2['schemas']['GetFactoryRequest'];
@@ -284,6 +368,9 @@ interface operations$2 {
284
368
  responses: {
285
369
  /** @description ok */
286
370
  200: {
371
+ headers: {
372
+ [name: string]: unknown;
373
+ };
287
374
  content: {
288
375
  'application/json': components$2['schemas']['FactoryWithChoiceContext'];
289
376
  };
@@ -296,19 +383,58 @@ interface operations$2 {
296
383
 
297
384
  interface paths$2 {
298
385
  '/registry/metadata/v1/info': {
386
+ parameters: {
387
+ query?: never;
388
+ header?: never;
389
+ path?: never;
390
+ cookie?: never;
391
+ };
299
392
  /**
300
393
  * @description Get information about the registry.
301
- * The response includes the standards supported by the registry.
394
+ * The response includes the standards supported by the registry.
302
395
  */
303
396
  get: operations$1['getRegistryInfo'];
397
+ put?: never;
398
+ post?: never;
399
+ delete?: never;
400
+ options?: never;
401
+ head?: never;
402
+ patch?: never;
403
+ trace?: never;
304
404
  };
305
405
  '/registry/metadata/v1/instruments': {
406
+ parameters: {
407
+ query?: never;
408
+ header?: never;
409
+ path?: never;
410
+ cookie?: never;
411
+ };
306
412
  /** @description List all instruments managed by this instrument admin. */
307
413
  get: operations$1['listInstruments'];
414
+ put?: never;
415
+ post?: never;
416
+ delete?: never;
417
+ options?: never;
418
+ head?: never;
419
+ patch?: never;
420
+ trace?: never;
308
421
  };
309
422
  '/registry/metadata/v1/instruments/{instrumentId}': {
423
+ parameters: {
424
+ query?: never;
425
+ header?: never;
426
+ path?: never;
427
+ cookie?: never;
428
+ };
310
429
  /** @description Retrieve an instrument's metadata. */
311
430
  get: operations$1['getInstrument'];
431
+ put?: never;
432
+ post?: never;
433
+ delete?: never;
434
+ options?: never;
435
+ head?: never;
436
+ patch?: never;
437
+ trace?: never;
312
438
  };
313
439
  }
314
440
  interface components$1 {
@@ -337,13 +463,12 @@ interface components$1 {
337
463
  * Format: int8
338
464
  * @description The number of decimal places used by the instrument.
339
465
  *
340
- * Must be a number between 0 and 10, as the Daml interfaces represent holding amounts as
341
- * `Decimal` values, which use 10 decimal places and are precise for 38 digits.
342
- * Setting this to 0 means that the instrument can only be held in whole units.
343
- *
344
- * This number SHOULD be used for display purposes in a wallet to decide how many
345
- * decimal places to show and accept when displaying or entering amounts.
466
+ * Must be a number between 0 and 10, as the Daml interfaces represent holding amounts as
467
+ * `Decimal` values, which use 10 decimal places and are precise for 38 digits.
468
+ * Setting this to 0 means that the instrument can only be held in whole units.
346
469
  *
470
+ * This number SHOULD be used for display purposes in a wallet to decide how many
471
+ * decimal places to show and accept when displaying or entering amounts.
347
472
  * @default 10
348
473
  */
349
474
  decimals: number;
@@ -359,7 +484,7 @@ interface components$1 {
359
484
  };
360
485
  /**
361
486
  * @description Map from token standard API name to the minor version of the API supported, e.g.,
362
- * splice-api-token-metadata-v1 -> 1 where the `1` corresponds to the minor version.
487
+ * splice-api-token-metadata-v1 -> 1 where the `1` corresponds to the minor version.
363
488
  */
364
489
  SupportedApis: {
365
490
  [key: string]: number;
@@ -368,24 +493,36 @@ interface components$1 {
368
493
  responses: {
369
494
  /** @description bad request */
370
495
  400: {
496
+ headers: {
497
+ [name: string]: unknown;
498
+ };
371
499
  content: {
372
500
  'application/json': components$1['schemas']['ErrorResponse'];
373
501
  };
374
502
  };
375
503
  /** @description not found */
376
504
  404: {
505
+ headers: {
506
+ [name: string]: unknown;
507
+ };
377
508
  content: {
378
509
  'application/json': components$1['schemas']['ErrorResponse'];
379
510
  };
380
511
  };
381
512
  /** @description conflict */
382
513
  409: {
514
+ headers: {
515
+ [name: string]: unknown;
516
+ };
383
517
  content: {
384
518
  'application/json': components$1['schemas']['ErrorResponse'];
385
519
  };
386
520
  };
387
521
  /** @description Internal server error */
388
522
  500: {
523
+ headers: {
524
+ [name: string]: unknown;
525
+ };
389
526
  content: {
390
527
  'application/json': components$1['schemas']['ErrorResponse'];
391
528
  };
@@ -397,14 +534,20 @@ interface components$1 {
397
534
  pathItems: never;
398
535
  }
399
536
  interface operations$1 {
400
- /**
401
- * @description Get information about the registry.
402
- * The response includes the standards supported by the registry.
403
- */
404
537
  getRegistryInfo: {
538
+ parameters: {
539
+ query?: never;
540
+ header?: never;
541
+ path?: never;
542
+ cookie?: never;
543
+ };
544
+ requestBody?: never;
405
545
  responses: {
406
546
  /** @description ok */
407
547
  200: {
548
+ headers: {
549
+ [name: string]: unknown;
550
+ };
408
551
  content: {
409
552
  'application/json': components$1['schemas']['GetRegistryInfoResponse'];
410
553
  };
@@ -413,7 +556,6 @@ interface operations$1 {
413
556
  500: components$1['responses']['500'];
414
557
  };
415
558
  };
416
- /** @description List all instruments managed by this instrument admin. */
417
559
  listInstruments: {
418
560
  parameters: {
419
561
  query?: {
@@ -422,10 +564,17 @@ interface operations$1 {
422
564
  /** @description The `nextPageToken` received from the response for the previous page. */
423
565
  pageToken?: string;
424
566
  };
567
+ header?: never;
568
+ path?: never;
569
+ cookie?: never;
425
570
  };
571
+ requestBody?: never;
426
572
  responses: {
427
573
  /** @description ok */
428
574
  200: {
575
+ headers: {
576
+ [name: string]: unknown;
577
+ };
429
578
  content: {
430
579
  'application/json': components$1['schemas']['ListInstrumentsResponse'];
431
580
  };
@@ -434,16 +583,22 @@ interface operations$1 {
434
583
  500: components$1['responses']['500'];
435
584
  };
436
585
  };
437
- /** @description Retrieve an instrument's metadata. */
438
586
  getInstrument: {
439
587
  parameters: {
588
+ query?: never;
589
+ header?: never;
440
590
  path: {
441
591
  instrumentId: string;
442
592
  };
593
+ cookie?: never;
443
594
  };
595
+ requestBody?: never;
444
596
  responses: {
445
597
  /** @description ok */
446
598
  200: {
599
+ headers: {
600
+ [name: string]: unknown;
601
+ };
447
602
  content: {
448
603
  'application/json': components$1['schemas']['Instrument'];
449
604
  };
@@ -456,20 +611,72 @@ interface operations$1 {
456
611
 
457
612
  interface paths$1 {
458
613
  '/registry/transfer-instruction/v1/transfer-factory': {
614
+ parameters: {
615
+ query?: never;
616
+ header?: never;
617
+ path?: never;
618
+ cookie?: never;
619
+ };
620
+ get?: never;
621
+ put?: never;
459
622
  /** @description Get the factory and choice context for executing a direct transfer. */
460
623
  post: operations['getTransferFactory'];
624
+ delete?: never;
625
+ options?: never;
626
+ head?: never;
627
+ patch?: never;
628
+ trace?: never;
461
629
  };
462
630
  '/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/accept': {
631
+ parameters: {
632
+ query?: never;
633
+ header?: never;
634
+ path?: never;
635
+ cookie?: never;
636
+ };
637
+ get?: never;
638
+ put?: never;
463
639
  /** @description Get the choice context to accept a transfer instruction. */
464
640
  post: operations['getTransferInstructionAcceptContext'];
641
+ delete?: never;
642
+ options?: never;
643
+ head?: never;
644
+ patch?: never;
645
+ trace?: never;
465
646
  };
466
647
  '/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/reject': {
648
+ parameters: {
649
+ query?: never;
650
+ header?: never;
651
+ path?: never;
652
+ cookie?: never;
653
+ };
654
+ get?: never;
655
+ put?: never;
467
656
  /** @description Get the choice context to reject a transfer instruction. */
468
657
  post: operations['getTransferInstructionRejectContext'];
658
+ delete?: never;
659
+ options?: never;
660
+ head?: never;
661
+ patch?: never;
662
+ trace?: never;
469
663
  };
470
664
  '/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw': {
665
+ parameters: {
666
+ query?: never;
667
+ header?: never;
668
+ path?: never;
669
+ cookie?: never;
670
+ };
671
+ get?: never;
672
+ put?: never;
471
673
  /** @description Get the choice context to withdraw a transfer instruction. */
472
674
  post: operations['getTransferInstructionWithdrawContext'];
675
+ delete?: never;
676
+ options?: never;
677
+ head?: never;
678
+ patch?: never;
679
+ trace?: never;
473
680
  };
474
681
  }
475
682
  interface components {
@@ -477,25 +684,25 @@ interface components {
477
684
  GetFactoryRequest: {
478
685
  /**
479
686
  * @description The arguments that are intended to be passed to the choice provided by the factory.
480
- * To avoid repeating the Daml type definitions, they are specified as JSON objects.
481
- * However the concrete format is given by how the choice arguments are encoded using the Daml JSON API
482
- * (with the `extraArgs.context` and `extraArgs.meta` fields set to the empty object).
687
+ * To avoid repeating the Daml type definitions, they are specified as JSON objects.
688
+ * However the concrete format is given by how the choice arguments are encoded using the Daml JSON API
689
+ * (with the `extraArgs.context` and `extraArgs.meta` fields set to the empty object).
483
690
  *
484
- * The choice arguments are provided so that the registry can also provide choice-argument
485
- * specific contracts, e.g., the configuration for a specific instrument-id.
691
+ * The choice arguments are provided so that the registry can also provide choice-argument
692
+ * specific contracts, e.g., the configuration for a specific instrument-id.
486
693
  */
487
694
  choiceArguments: Record<string, never>;
488
695
  /**
489
696
  * @description If set to true, the response will not include debug fields.
490
697
  * @default false
491
698
  */
492
- excludeDebugFields?: boolean;
699
+ excludeDebugFields: boolean;
493
700
  };
494
701
  /** @description A request to get the context for executing a choice on a contract. */
495
702
  GetChoiceContextRequest: {
496
703
  /**
497
704
  * @description Metadata that will be passed to the choice, and should be incorporated
498
- * into the choice context. Provided for extensibility.
705
+ * into the choice context. Provided for extensibility.
499
706
  */
500
707
  meta?: {
501
708
  [key: string]: string;
@@ -503,23 +710,22 @@ interface components {
503
710
  };
504
711
  /**
505
712
  * @description The transfer factory contract together with the choice context required to exercise the choice
506
- * provided by the factory. Typically used to implement the generic initiation of on-ledger workflows
507
- * via a Daml interface.
713
+ * provided by the factory. Typically used to implement the generic initiation of on-ledger workflows
714
+ * via a Daml interface.
508
715
  *
509
- * Clients SHOULD avoid reusing the same `FactoryWithChoiceContext` for exercising multiple choices,
510
- * as the choice context MAY be specific to the choice being exercised.
716
+ * Clients SHOULD avoid reusing the same `FactoryWithChoiceContext` for exercising multiple choices,
717
+ * as the choice context MAY be specific to the choice being exercised.
511
718
  */
512
719
  TransferFactoryWithChoiceContext: {
513
720
  /** @description The contract ID of the contract implementing the factory interface. */
514
721
  factoryId: string;
515
722
  /**
516
723
  * @description The kind of transfer workflow that will be used:
517
- * * `offer`: offer a transfer to the receiver and only transfer if they accept
518
- * * `direct`: transfer directly to the receiver without asking them for approval.
519
- * Only chosen if the receiver has pre-approved direct transfers.
520
- * * `self`: a self-transfer where the sender and receiver are the same party.
521
- * No approval is required, and the transfer is typically immediate.
522
- *
724
+ * * `offer`: offer a transfer to the receiver and only transfer if they accept
725
+ * * `direct`: transfer directly to the receiver without asking them for approval.
726
+ * Only chosen if the receiver has pre-approved direct transfers.
727
+ * * `self`: a self-transfer where the sender and receiver are the same party.
728
+ * No approval is required, and the transfer is typically immediate.
523
729
  * @enum {string}
524
730
  */
525
731
  transferKind: 'self' | 'direct' | 'offer';
@@ -527,15 +733,15 @@ interface components {
527
733
  };
528
734
  /**
529
735
  * @description The context required to exercise a choice on a contract via an interface.
530
- * Used to retrieve additional reference data that is passed in via disclosed contracts,
531
- * which are in turn referred to via their contract ID in the `choiceContextData`.
736
+ * Used to retrieve additional reference data that is passed in via disclosed contracts,
737
+ * which are in turn referred to via their contract ID in the `choiceContextData`.
532
738
  */
533
739
  ChoiceContext: {
534
740
  /** @description The additional data to use when exercising the choice. */
535
741
  choiceContextData: Record<string, never>;
536
742
  /**
537
743
  * @description The contracts that are required to be disclosed to the participant node for exercising
538
- * the choice.
744
+ * the choice.
539
745
  */
540
746
  disclosedContracts: components['schemas']['DisclosedContract'][];
541
747
  };
@@ -545,26 +751,26 @@ interface components {
545
751
  createdEventBlob: string;
546
752
  /**
547
753
  * @description The synchronizer to which the contract is currently assigned.
548
- * If the contract is in the process of being reassigned, then a "409" response is returned.
754
+ * If the contract is in the process of being reassigned, then a "409" response is returned.
549
755
  */
550
756
  synchronizerId: string;
551
757
  /**
552
758
  * @description The name of the Daml package that was used to create the contract.
553
- * Use this data only if you trust the provider, as it might not match the data in the
554
- * `createdEventBlob`.
759
+ * Use this data only if you trust the provider, as it might not match the data in the
760
+ * `createdEventBlob`.
555
761
  */
556
762
  debugPackageName?: string;
557
763
  /**
558
764
  * @description The contract arguments that were used to create the contract.
559
- * Use this data only if you trust the provider, as it might not match the data in the
560
- * `createdEventBlob`.
765
+ * Use this data only if you trust the provider, as it might not match the data in the
766
+ * `createdEventBlob`.
561
767
  */
562
768
  debugPayload?: Record<string, never>;
563
769
  /**
564
770
  * Format: date-time
565
771
  * @description The ledger effective time at which the contract was created.
566
- * Use this data only if you trust the provider, as it might not match the data in the
567
- * `createdEventBlob`.
772
+ * Use this data only if you trust the provider, as it might not match the data in the
773
+ * `createdEventBlob`.
568
774
  */
569
775
  debugCreatedAt?: string;
570
776
  };
@@ -575,12 +781,18 @@ interface components {
575
781
  responses: {
576
782
  /** @description bad request */
577
783
  400: {
784
+ headers: {
785
+ [name: string]: unknown;
786
+ };
578
787
  content: {
579
788
  'application/json': components['schemas']['ErrorResponse'];
580
789
  };
581
790
  };
582
791
  /** @description not found */
583
792
  404: {
793
+ headers: {
794
+ [name: string]: unknown;
795
+ };
584
796
  content: {
585
797
  'application/json': components['schemas']['ErrorResponse'];
586
798
  };
@@ -592,8 +804,13 @@ interface components {
592
804
  pathItems: never;
593
805
  }
594
806
  interface operations {
595
- /** @description Get the factory and choice context for executing a direct transfer. */
596
807
  getTransferFactory: {
808
+ parameters: {
809
+ query?: never;
810
+ header?: never;
811
+ path?: never;
812
+ cookie?: never;
813
+ };
597
814
  requestBody: {
598
815
  content: {
599
816
  'application/json': components['schemas']['GetFactoryRequest'];
@@ -602,6 +819,9 @@ interface operations {
602
819
  responses: {
603
820
  /** @description ok */
604
821
  200: {
822
+ headers: {
823
+ [name: string]: unknown;
824
+ };
605
825
  content: {
606
826
  'application/json': components['schemas']['TransferFactoryWithChoiceContext'];
607
827
  };
@@ -610,13 +830,15 @@ interface operations {
610
830
  404: components['responses']['404'];
611
831
  };
612
832
  };
613
- /** @description Get the choice context to accept a transfer instruction. */
614
833
  getTransferInstructionAcceptContext: {
615
834
  parameters: {
835
+ query?: never;
836
+ header?: never;
616
837
  path: {
617
838
  /** @description The contract ID of the transfer instruction to accept. */
618
839
  transferInstructionId: string;
619
840
  };
841
+ cookie?: never;
620
842
  };
621
843
  requestBody: {
622
844
  content: {
@@ -626,6 +848,9 @@ interface operations {
626
848
  responses: {
627
849
  /** @description ok */
628
850
  200: {
851
+ headers: {
852
+ [name: string]: unknown;
853
+ };
629
854
  content: {
630
855
  'application/json': components['schemas']['ChoiceContext'];
631
856
  };
@@ -634,13 +859,15 @@ interface operations {
634
859
  404: components['responses']['404'];
635
860
  };
636
861
  };
637
- /** @description Get the choice context to reject a transfer instruction. */
638
862
  getTransferInstructionRejectContext: {
639
863
  parameters: {
864
+ query?: never;
865
+ header?: never;
640
866
  path: {
641
867
  /** @description The contract ID of the transfer instruction to reject. */
642
868
  transferInstructionId: string;
643
869
  };
870
+ cookie?: never;
644
871
  };
645
872
  requestBody: {
646
873
  content: {
@@ -650,6 +877,9 @@ interface operations {
650
877
  responses: {
651
878
  /** @description ok */
652
879
  200: {
880
+ headers: {
881
+ [name: string]: unknown;
882
+ };
653
883
  content: {
654
884
  'application/json': components['schemas']['ChoiceContext'];
655
885
  };
@@ -658,13 +888,15 @@ interface operations {
658
888
  404: components['responses']['404'];
659
889
  };
660
890
  };
661
- /** @description Get the choice context to withdraw a transfer instruction. */
662
891
  getTransferInstructionWithdrawContext: {
663
892
  parameters: {
893
+ query?: never;
894
+ header?: never;
664
895
  path: {
665
896
  /** @description The contract ID of the transfer instruction to withdraw. */
666
897
  transferInstructionId: string;
667
898
  };
899
+ cookie?: never;
668
900
  };
669
901
  requestBody: {
670
902
  content: {
@@ -674,6 +906,9 @@ interface operations {
674
906
  responses: {
675
907
  /** @description ok */
676
908
  200: {
909
+ headers: {
910
+ [name: string]: unknown;
911
+ };
677
912
  content: {
678
913
  'application/json': components['schemas']['ChoiceContext'];
679
914
  };