@n1xyz/nord-ts 0.6.2 → 0.6.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.
Files changed (2) hide show
  1. package/dist/gen/openapi.d.ts +660 -326
  2. package/package.json +1 -1
@@ -105,9 +105,11 @@ export interface paths {
105
105
  path?: never;
106
106
  cookie?: never;
107
107
  };
108
- /** @description UNSTABLE: operational health endpoint for history catchup progress.
108
+ /**
109
+ * @description UNSTABLE: operational health endpoint for history catchup progress.
109
110
  *
110
- * Returns 503 on any partial degradation. Do not use as a liveness probe. */
111
+ * Returns 503 on any partial degradation. Do not use as a liveness probe.
112
+ */
111
113
  get: {
112
114
  parameters: {
113
115
  query?: never;
@@ -311,10 +313,12 @@ export interface paths {
311
313
  };
312
314
  };
313
315
  put?: never;
314
- /** @description Send an action to nord to execute.
316
+ /**
317
+ * @description Send an action to nord to execute.
315
318
  * This doesn't use `Protobuf<T>` since we want to length-delimit this message.
316
319
  * `body` - (length prefix of action, action data protobuf, and signature). signature has exact length, but depend on action kind.
317
- * body is exact payload used via other transports and journalled for rexecution */
320
+ * body is exact payload used via other transports and journalled for rexecution
321
+ */
318
322
  post: {
319
323
  parameters: {
320
324
  query?: never;
@@ -428,9 +432,11 @@ export interface paths {
428
432
  };
429
433
  requestBody?: never;
430
434
  responses: {
431
- /** @description Non negative time in seconds (oracle precision).
435
+ /**
436
+ * @description Non negative time in seconds (oracle precision).
432
437
  * In production within engine determinsitic code,
433
- * this time can only go forward and cannot be `Default`. */
438
+ * this time can only go forward and cannot be `Default`.
439
+ */
434
440
  200: {
435
441
  headers: {
436
442
  [name: string]: unknown;
@@ -456,8 +462,10 @@ export interface paths {
456
462
  path?: never;
457
463
  cookie?: never;
458
464
  };
459
- /** @description The last acknowledged event nonce. Use this to ascertain if a given
460
- * withdrawal was processed by nord. */
465
+ /**
466
+ * @description The last acknowledged event nonce. Use this to ascertain if a given
467
+ * withdrawal was processed by nord.
468
+ */
461
469
  get: {
462
470
  parameters: {
463
471
  query?: never;
@@ -498,8 +506,10 @@ export interface paths {
498
506
  query?: never;
499
507
  header?: never;
500
508
  path: {
501
- /** @description where `streams` is `trades@{symbol} | deltas@{symbol} | account@{account id} | candle@{symbol}:{resolution} [&, ...]`
502
- * e.g. `/ws/trades@BTCUSDC&deltas@BTCUSDC&account@42&candle@BTCUSDC:60` */
509
+ /**
510
+ * @description where `streams` is `trades@{symbol} | deltas@{symbol} | account@{account id} | candle@{symbol}:{resolution} [&, ...]`
511
+ * e.g. `/ws/trades@BTCUSDC&deltas@BTCUSDC&account@42&candle@BTCUSDC:60`
512
+ */
503
513
  streams: string;
504
514
  };
505
515
  cookie?: never;
@@ -763,10 +773,12 @@ export interface paths {
763
773
  path?: never;
764
774
  cookie?: never;
765
775
  };
766
- /** @description If protocol is healthy, it will be some amount expressed in USDC unit, like 1 USDC or 0.1 USDC.
776
+ /**
777
+ * @description If protocol is healthy, it will be some amount expressed in USDC unit, like 1 USDC or 0.1 USDC.
767
778
  * For example if 1 ETH is 10_000 USDC price, and fee 1 USDC, that means that user will get 0.9999 ETH instead of 1 ETH.
768
779
  *
769
- * If protocol in unhealthy, withdrawal fee will be proportional to protocol debt. */
780
+ * If protocol in unhealthy, withdrawal fee will be proportional to protocol debt.
781
+ */
770
782
  get: {
771
783
  parameters: {
772
784
  query?: never;
@@ -981,10 +993,12 @@ export interface paths {
981
993
  };
982
994
  requestBody?: never;
983
995
  responses: {
984
- /** @description Owner share and withdrawal state
996
+ /**
997
+ * @description Owner share and withdrawal state
985
998
  *
986
999
  * Withdrawals are owner side `Q_owner,current`, `Q_owner,previous`, and
987
- * `Q_owner,claimable` */
1000
+ * `Q_owner,claimable`
1001
+ */
988
1002
  200: {
989
1003
  headers: {
990
1004
  [name: string]: unknown;
@@ -1599,8 +1613,10 @@ export interface paths {
1599
1613
  };
1600
1614
  requestBody?: never;
1601
1615
  responses: {
1602
- /** @description Solana base58 address with private key (must have private side so that can create session after).
1603
- * Basically fix for solana-pubkey is array of bytes in serde https://github.com/anza-xyz/solana-sdk/pull/76 */
1616
+ /**
1617
+ * @description Solana base58 address with private key (must have private side so that can create session after).
1618
+ * Basically fix for solana-pubkey is array of bytes in serde https://github.com/anza-xyz/solana-sdk/pull/76
1619
+ */
1604
1620
  200: {
1605
1621
  headers: {
1606
1622
  [name: string]: unknown;
@@ -1634,8 +1650,10 @@ export interface paths {
1634
1650
  path?: never;
1635
1651
  cookie?: never;
1636
1652
  };
1637
- /** @description Given order identifier, return order summary.
1638
- * Works for order which were immediately filled, partially filled, cancelled or fully filled. */
1653
+ /**
1654
+ * @description Given order identifier, return order summary.
1655
+ * Works for order which were immediately filled, partially filled, cancelled or fully filled.
1656
+ */
1639
1657
  get: {
1640
1658
  parameters: {
1641
1659
  query?: never;
@@ -1647,8 +1665,10 @@ export interface paths {
1647
1665
  };
1648
1666
  requestBody?: never;
1649
1667
  responses: {
1650
- /** @description Order summary.
1651
- * Use order_id to application side join with trades as needed. */
1668
+ /**
1669
+ * @description Order summary.
1670
+ * Use order_id to application side join with trades as needed.
1671
+ */
1652
1672
  200: {
1653
1673
  headers: {
1654
1674
  [name: string]: unknown;
@@ -1724,7 +1744,8 @@ export interface paths {
1724
1744
  path?: never;
1725
1745
  cookie?: never;
1726
1746
  };
1727
- /** @description Ordered from present to past.
1747
+ /**
1748
+ * @description Ordered from present to past.
1728
1749
  *
1729
1750
  * Pagination
1730
1751
  * Besides set of trades in `trades` array, endpoint returns `accountId` and actual values for `since` and `until`
@@ -1733,7 +1754,8 @@ export interface paths {
1733
1754
  * To fetch it, client should pass `since` and `until` returned and add `nextStartInclusive`'s value as `startInclusive` parameter.
1734
1755
  * By default, `startInclusive` and `nextStartInclusive` are trade ids. When `paginationMode=actionId`,
1735
1756
  * they are action ids, and `pageSize` counts distinct action ids instead of individual trade rows.
1736
- * If `nextStartInclusive` is absent, it means there's no more data to fetch, even if 50 entries were returned. */
1757
+ * If `nextStartInclusive` is absent, it means there's no more data to fetch, even if 50 entries were returned.
1758
+ */
1737
1759
  get: {
1738
1760
  parameters: {
1739
1761
  query?: {
@@ -1782,7 +1804,8 @@ export interface paths {
1782
1804
  path?: never;
1783
1805
  cookie?: never;
1784
1806
  };
1785
- /** @description Returns state download link and metadata,
1807
+ /**
1808
+ * @description Returns state download link and metadata,
1786
1809
  * as defined by nearest(up to equality) snapshot `time` or `action_id`` or `timestamp`.
1787
1810
  * If not specified, returns latest snapshot.
1788
1811
  * Example: /state/download?actionId=1
@@ -1791,7 +1814,8 @@ export interface paths {
1791
1814
  * To get the latest snap use:
1792
1815
  * /state/download - w/o any params.
1793
1816
  *
1794
- * The link from responce can be inserted to search bar in browser to download. */
1817
+ * The link from responce can be inserted to search bar in browser to download.
1818
+ */
1795
1819
  get: {
1796
1820
  parameters: {
1797
1821
  query?: never;
@@ -1834,10 +1858,12 @@ export interface paths {
1834
1858
  path?: never;
1835
1859
  cookie?: never;
1836
1860
  };
1837
- /** @description Typical HTTP file download endpoint.
1861
+ /**
1862
+ * @description Typical HTTP file download endpoint.
1838
1863
  * Actually same as provided by S3 storages.
1839
1864
  * Means supports Range header, Content-Length, Content-Type, ETag and so on,
1840
- * and relevant headers. */
1865
+ * and relevant headers.
1866
+ */
1841
1867
  get: {
1842
1868
  parameters: {
1843
1869
  query?: never;
@@ -2107,12 +2133,14 @@ export interface paths {
2107
2133
  path?: never;
2108
2134
  cookie?: never;
2109
2135
  };
2110
- /** @description Get trading volume for an account
2136
+ /**
2137
+ * @description Get trading volume for an account
2111
2138
  *
2112
2139
  * Optionally, you can specify a market to get volume for.
2113
2140
  * If not specified, array of (MarketId, Volume) is returned.
2114
2141
  *
2115
- * Returns raw values, caller must rescale to base token decimals */
2142
+ * Returns raw values, caller must rescale to base token decimals
2143
+ */
2116
2144
  get: {
2117
2145
  parameters: {
2118
2146
  query: {
@@ -2811,8 +2839,10 @@ export interface paths {
2811
2839
  path?: never;
2812
2840
  cookie?: never;
2813
2841
  };
2814
- /** @description Gets market updates history for some period of time.
2815
- * Default is hourly for last 24 hours */
2842
+ /**
2843
+ * @description Gets market updates history for some period of time.
2844
+ * Default is hourly for last 24 hours
2845
+ */
2816
2846
  get: {
2817
2847
  parameters: {
2818
2848
  query?: {
@@ -2859,74 +2889,94 @@ export interface components {
2859
2889
  schemas: {
2860
2890
  OpenApi: {
2861
2891
  openapi: string;
2862
- /** @description REQUIRED. Provides metadata about the API.
2863
- * The metadata MAY be used by tooling as required. */
2892
+ /**
2893
+ * @description REQUIRED. Provides metadata about the API.
2894
+ * The metadata MAY be used by tooling as required.
2895
+ */
2864
2896
  info: components["schemas"]["Info"];
2865
- /** @description The default value for the `$schema` keyword within Schema Objects
2866
- * contained within this OAS document. This MUST be in the form of a URI. */
2897
+ /**
2898
+ * @description The default value for the `$schema` keyword within Schema Objects
2899
+ * contained within this OAS document. This MUST be in the form of a URI.
2900
+ */
2867
2901
  jsonSchemaDialect?: string | null;
2868
- /** @description An array of Server Objects, which provide connectivity information to a
2902
+ /**
2903
+ * @description An array of Server Objects, which provide connectivity information to a
2869
2904
  * target server. If the servers property is not provided, or is an empty
2870
- * array, the default value would be a Server Object with a url value of /. */
2905
+ * array, the default value would be a Server Object with a url value of /.
2906
+ */
2871
2907
  servers?: components["schemas"]["Server"][];
2872
2908
  /** @description The available paths and operations for the API. */
2873
2909
  paths?: components["schemas"]["Paths"] | null;
2874
- /** @description The incoming webhooks that MAY be received as part of this API and that
2910
+ /**
2911
+ * @description The incoming webhooks that MAY be received as part of this API and that
2875
2912
  * the API consumer MAY choose to implement. Closely related to the
2876
2913
  * `callbacks` feature, this section describes requests initiated other
2877
2914
  * than by an API call, for example by an out of band registration. The key
2878
2915
  * name is a unique string to refer to each webhook, while the (optionally
2879
2916
  * referenced) Path Item Object describes a request that may be initiated
2880
- * by the API provider and the expected responses. */
2917
+ * by the API provider and the expected responses.
2918
+ */
2881
2919
  webhooks?: {
2882
2920
  [key: string]: components["schemas"]["ReferenceOr"];
2883
2921
  };
2884
2922
  /** @description An element to hold various schemas for the document. */
2885
2923
  components?: components["schemas"]["Components"] | null;
2886
- /** @description A declaration of which security mechanisms can be used across the API.
2924
+ /**
2925
+ * @description A declaration of which security mechanisms can be used across the API.
2887
2926
  *
2888
2927
  * The list of values includes alternative security requirement objects
2889
2928
  * that can be used. Only one of the security requirement objects need to
2890
2929
  * be satisfied to authorize a request. Individual operations can override
2891
2930
  * this definition. Global security settings may be overridden on a
2892
- * per-path basis. */
2931
+ * per-path basis.
2932
+ */
2893
2933
  security?: {
2894
2934
  [key: string]: string[];
2895
2935
  }[];
2896
- /** @description A list of tags used by the document with additional metadata.
2936
+ /**
2937
+ * @description A list of tags used by the document with additional metadata.
2897
2938
  *
2898
2939
  * The order of the tags can be used to reflect on their order by the
2899
2940
  * parsing tools. Not all tags that are used by the Operation Object
2900
2941
  * must be declared. The tags that are not declared MAY be organized
2901
2942
  * randomly or based on the tool's logic. Each tag name in the list
2902
- * MUST be unique. */
2943
+ * MUST be unique.
2944
+ */
2903
2945
  tags?: components["schemas"]["Tag"][];
2904
2946
  /** @description Additional external documentation. */
2905
2947
  externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
2906
2948
  } & {
2907
2949
  [key: string]: unknown;
2908
2950
  };
2909
- /** @description The object provides metadata about the API.
2951
+ /**
2952
+ * @description The object provides metadata about the API.
2910
2953
  * The metadata MAY be used by the clients if needed,
2911
2954
  * and MAY be presented in editing or documentation generation tools for
2912
- * convenience. */
2955
+ * convenience.
2956
+ */
2913
2957
  Info: {
2914
2958
  /** @description REQUIRED. The title of the application. */
2915
2959
  title: string;
2916
2960
  /** @description A short summary of the API. */
2917
2961
  summary?: string | null;
2918
- /** @description A description of the API.
2919
- * CommonMark syntax MAY be used for rich text representation. */
2962
+ /**
2963
+ * @description A description of the API.
2964
+ * CommonMark syntax MAY be used for rich text representation.
2965
+ */
2920
2966
  description?: string | null;
2921
- /** @description A URL to the Terms of Service for the API.
2922
- * This MUST be in the format of a URL. */
2967
+ /**
2968
+ * @description A URL to the Terms of Service for the API.
2969
+ * This MUST be in the format of a URL.
2970
+ */
2923
2971
  termsOfService?: string | null;
2924
2972
  /** @description The contact information for the exposed API. */
2925
2973
  contact?: components["schemas"]["Contact"] | null;
2926
2974
  /** @description The license information for the exposed API. */
2927
2975
  license?: components["schemas"]["License"] | null;
2928
- /** @description REQUIRED. The version of the OpenAPI document (which is distinct from
2929
- * the OpenAPI Specification version or the API implementation version). */
2976
+ /**
2977
+ * @description REQUIRED. The version of the OpenAPI document (which is distinct from
2978
+ * the OpenAPI Specification version or the API implementation version).
2979
+ */
2930
2980
  version: string;
2931
2981
  } & {
2932
2982
  [key: string]: unknown;
@@ -2935,11 +2985,15 @@ export interface components {
2935
2985
  Contact: {
2936
2986
  /** @description The identifying name of the contact person/organization. */
2937
2987
  name?: string | null;
2938
- /** @description The URL pointing to the contact information.
2939
- * This MUST be in the format of a URL. */
2988
+ /**
2989
+ * @description The URL pointing to the contact information.
2990
+ * This MUST be in the format of a URL.
2991
+ */
2940
2992
  url?: string | null;
2941
- /** @description The email address of the contact person/organization.
2942
- * This MUST be in the format of an email address. */
2993
+ /**
2994
+ * @description The email address of the contact person/organization.
2995
+ * This MUST be in the format of an email address.
2996
+ */
2943
2997
  email?: string | null;
2944
2998
  } & {
2945
2999
  [key: string]: unknown;
@@ -2950,89 +3004,121 @@ export interface components {
2950
3004
  name: string;
2951
3005
  /** @description An [SPDX](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. */
2952
3006
  identifier?: string | null;
2953
- /** @description A URL to the license used for the API. This MUST be in the form of a
2954
- * URL. The `url` field is mutually exclusive of the `identifier` field. */
3007
+ /**
3008
+ * @description A URL to the license used for the API. This MUST be in the form of a
3009
+ * URL. The `url` field is mutually exclusive of the `identifier` field.
3010
+ */
2955
3011
  url?: string | null;
2956
3012
  } & {
2957
3013
  [key: string]: unknown;
2958
3014
  };
2959
3015
  /** @description An object representing a Server. */
2960
3016
  Server: {
2961
- /** @description REQUIRED. A URL to the target host.
3017
+ /**
3018
+ * @description REQUIRED. A URL to the target host.
2962
3019
  * This URL supports Server Variables and MAY be relative,
2963
3020
  * to indicate that the host location is relative to the
2964
3021
  * location where the OpenAPI document is being served.
2965
3022
  * Variable substitutions will be made when a variable
2966
- * is named in {brackets}. */
3023
+ * is named in {brackets}.
3024
+ */
2967
3025
  url: string;
2968
- /** @description An optional string describing the host designated
3026
+ /**
3027
+ * @description An optional string describing the host designated
2969
3028
  * by the URL. CommonMark syntax MAY be used for rich
2970
- * text representation. */
3029
+ * text representation.
3030
+ */
2971
3031
  description?: string | null;
2972
- /** @description A map between a variable name and its value.
2973
- * The value is used for substitution in the server's URL template. */
3032
+ /**
3033
+ * @description A map between a variable name and its value.
3034
+ * The value is used for substitution in the server's URL template.
3035
+ */
2974
3036
  variables?: {
2975
3037
  [key: string]: components["schemas"]["ServerVariable"];
2976
3038
  };
2977
3039
  } & {
2978
3040
  [key: string]: unknown;
2979
3041
  };
2980
- /** @description An object representing a Server Variable
2981
- * for server URL template substitution. */
3042
+ /**
3043
+ * @description An object representing a Server Variable
3044
+ * for server URL template substitution.
3045
+ */
2982
3046
  ServerVariable: {
2983
- /** @description An enumeration of string values to be
2984
- * used if the substitution options are from a limited set. */
3047
+ /**
3048
+ * @description An enumeration of string values to be
3049
+ * used if the substitution options are from a limited set.
3050
+ */
2985
3051
  enum?: string[];
2986
- /** @description REQUIRED. The default value to use for substitution,
3052
+ /**
3053
+ * @description REQUIRED. The default value to use for substitution,
2987
3054
  * and to send, if an alternate value is not supplied.
2988
3055
  * Unlike the Schema Object's default, this value MUST
2989
- * be provided by the consumer. */
3056
+ * be provided by the consumer.
3057
+ */
2990
3058
  default: string;
2991
- /** @description An optional description for the server
3059
+ /**
3060
+ * @description An optional description for the server
2992
3061
  * variable. CommonMark syntax MAY be used
2993
- * for rich text representation. */
3062
+ * for rich text representation.
3063
+ */
2994
3064
  description?: string | null;
2995
3065
  } & {
2996
3066
  [key: string]: unknown;
2997
3067
  };
2998
- /** @description Holds the relative paths to the individual endpoints and
3068
+ /**
3069
+ * @description Holds the relative paths to the individual endpoints and
2999
3070
  * their operations. The path is appended to the URL from the
3000
3071
  * Server Object in order to construct the full URL. The Paths
3001
- * MAY be empty, due to Access Control List (ACL) constraints. */
3072
+ * MAY be empty, due to Access Control List (ACL) constraints.
3073
+ */
3002
3074
  Paths: {
3003
3075
  [key: string]: components["schemas"]["ReferenceOr"];
3004
3076
  };
3005
3077
  ReferenceOr: {
3006
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3007
- * URI. */
3078
+ /**
3079
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3080
+ * URI.
3081
+ */
3008
3082
  $ref: string;
3009
- /** @description A short summary which by default SHOULD override that of the
3083
+ /**
3084
+ * @description A short summary which by default SHOULD override that of the
3010
3085
  * referenced component. If the referenced object-type does not allow a
3011
- * `summary` field, then this field has no effect. */
3086
+ * `summary` field, then this field has no effect.
3087
+ */
3012
3088
  summary?: string | null;
3013
- /** @description A description which by default SHOULD override that of the
3089
+ /**
3090
+ * @description A description which by default SHOULD override that of the
3014
3091
  * referenced component. CommonMark syntax MAY be used for rich text
3015
3092
  * representation. If the referenced object-type does not allow a
3016
- * `description` field, then this field has no effect. */
3093
+ * `description` field, then this field has no effect.
3094
+ */
3017
3095
  description?: string | null;
3018
3096
  } | components["schemas"]["PathItem"];
3019
- /** @description Describes the operations available on a single path.
3097
+ /**
3098
+ * @description Describes the operations available on a single path.
3020
3099
  * A Path Item MAY be empty, due to ACL constraints.
3021
3100
  * The path itself is still exposed to the documentation
3022
3101
  * viewer but they will not know which operations and
3023
- * parameters are available. */
3102
+ * parameters are available.
3103
+ */
3024
3104
  PathItem: {
3025
- /** @description Allows for a referenced definition of this path item. The referenced
3105
+ /**
3106
+ * @description Allows for a referenced definition of this path item. The referenced
3026
3107
  * structure MUST be in the form of a Path Item Object. In case a Path
3027
3108
  * Item Object field appears both in the defined object and the referenced
3028
3109
  * object, the behavior is undefined. See the rules for resolving Relative
3029
- * References. */
3110
+ * References.
3111
+ */
3030
3112
  $ref?: string | null;
3031
- /** @description An optional, string summary, intended to apply to all operations in
3032
- * this path. */
3113
+ /**
3114
+ * @description An optional, string summary, intended to apply to all operations in
3115
+ * this path.
3116
+ */
3033
3117
  summary?: string | null;
3034
- /** @description An optional, string description, intended to apply to all operations in
3035
- * this path. CommonMark syntax MAY be used for rich text representation. */
3118
+ /**
3119
+ * @description An optional, string description, intended to apply to all operations in
3120
+ * this path. CommonMark syntax MAY be used for rich text representation.
3121
+ */
3036
3122
  description?: string | null;
3037
3123
  get?: components["schemas"]["Operation"] | null;
3038
3124
  put?: components["schemas"]["Operation"] | null;
@@ -3044,45 +3130,56 @@ export interface components {
3044
3130
  trace?: components["schemas"]["Operation"] | null;
3045
3131
  /** @description An alternative server array to service all operations in this path. */
3046
3132
  servers?: components["schemas"]["Server"][];
3047
- /** @description A list of parameters that are applicable for all the
3133
+ /**
3134
+ * @description A list of parameters that are applicable for all the
3048
3135
  * operations described under this path. These parameters
3049
3136
  * can be overridden at the operation level, but cannot be
3050
3137
  * removed there. The list MUST NOT include duplicated parameters.
3051
3138
  * A unique parameter is defined by a combination of a name and location.
3052
3139
  * The list can use the Reference Object to link to parameters that
3053
- * are defined at the OpenAPI Object's components/parameters. */
3140
+ * are defined at the OpenAPI Object's components/parameters.
3141
+ */
3054
3142
  parameters?: components["schemas"]["ReferenceOr2"][];
3055
3143
  } & {
3056
3144
  [key: string]: unknown;
3057
3145
  };
3058
3146
  /** @description Describes a single API operation on a path. */
3059
3147
  Operation: {
3060
- /** @description A list of tags for API documentation control.
3148
+ /**
3149
+ * @description A list of tags for API documentation control.
3061
3150
  * Tags can be used for logical grouping of operations
3062
- * by resources or any other qualifier. */
3151
+ * by resources or any other qualifier.
3152
+ */
3063
3153
  tags?: string[];
3064
3154
  /** @description A short summary of what the operation does. */
3065
3155
  summary?: string | null;
3066
- /** @description A verbose explanation of the operation behavior.
3067
- * CommonMark syntax MAY be used for rich text representation. */
3156
+ /**
3157
+ * @description A verbose explanation of the operation behavior.
3158
+ * CommonMark syntax MAY be used for rich text representation.
3159
+ */
3068
3160
  description?: string | null;
3069
3161
  /** @description Additional external documentation for this operation. */
3070
3162
  externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
3071
- /** @description Unique string used to identify the operation.
3163
+ /**
3164
+ * @description Unique string used to identify the operation.
3072
3165
  * The id MUST be unique among all operations described in the API.
3073
3166
  * Tools and libraries MAY use the operationId to uniquely identify
3074
3167
  * an operation, therefore, it is RECOMMENDED to follow common
3075
- * programming naming conventions. */
3168
+ * programming naming conventions.
3169
+ */
3076
3170
  operationId?: string | null;
3077
- /** @description A list of parameters that are applicable for this operation.
3171
+ /**
3172
+ * @description A list of parameters that are applicable for this operation.
3078
3173
  * If a parameter is already defined at the Path Item, the new
3079
3174
  * definition will override it but can never remove it.
3080
3175
  * The list MUST NOT include duplicated parameters. A unique
3081
3176
  * parameter is defined by a combination of a name and location.
3082
3177
  * The list can use the Reference Object to link to parameters
3083
- * that are defined at the OpenAPI Object's components/parameters. */
3178
+ * that are defined at the OpenAPI Object's components/parameters.
3179
+ */
3084
3180
  parameters?: components["schemas"]["ReferenceOr2"][];
3085
- /** @description The request body applicable for this operation.
3181
+ /**
3182
+ * @description The request body applicable for this operation.
3086
3183
  * The requestBody is fully supported in HTTP methods
3087
3184
  * where the HTTP 1.1 specification RFC7231 has explicitly
3088
3185
  * defined semantics for request bodies. In other cases where
@@ -3091,25 +3188,32 @@ export interface components {
3091
3188
  * [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and
3092
3189
  * [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)),
3093
3190
  * requestBody is permitted but does not have well-defined semantics and
3094
- * SHOULD be avoided if possible. */
3191
+ * SHOULD be avoided if possible.
3192
+ */
3095
3193
  requestBody?: components["schemas"]["ReferenceOr5"] | null;
3096
- /** @description The list of possible responses as they are returned
3097
- * from executing this operation. */
3194
+ /**
3195
+ * @description The list of possible responses as they are returned
3196
+ * from executing this operation.
3197
+ */
3098
3198
  responses?: components["schemas"]["Responses"] | null;
3099
3199
  /** @description Declares this operation to be deprecated.Default value is false. */
3100
3200
  deprecated?: boolean;
3101
- /** @description A declaration of which security mechanisms can be used for this
3201
+ /**
3202
+ * @description A declaration of which security mechanisms can be used for this
3102
3203
  * operation. The list of values includes alternative security
3103
3204
  * requirement objects that can be used. Only one of the security
3104
3205
  * requirement objects need to be satisfied to authorize a request.
3105
3206
  * This definition overrides any declared top-level security. To remove
3106
- * a top-level security declaration, an empty array can be used. */
3207
+ * a top-level security declaration, an empty array can be used.
3208
+ */
3107
3209
  security?: {
3108
3210
  [key: string]: string[];
3109
3211
  }[];
3110
- /** @description An alternative server array to service this operation.
3212
+ /**
3213
+ * @description An alternative server array to service this operation.
3111
3214
  * If an alternative server object is specified at the
3112
- * Path Item Object or Root level, it will be overridden by this value. */
3215
+ * Path Item Object or Root level, it will be overridden by this value.
3216
+ */
3113
3217
  servers?: components["schemas"]["Server"][];
3114
3218
  /** @description Callbacks for the operation. */
3115
3219
  callbacks?: {
@@ -3120,31 +3224,42 @@ export interface components {
3120
3224
  };
3121
3225
  /** @description Allows referencing an external resource for extended documentation. */
3122
3226
  ExternalDocumentation: {
3123
- /** @description A description of the target documentation.
3124
- * CommonMark syntax MAY be used for rich text representation. */
3227
+ /**
3228
+ * @description A description of the target documentation.
3229
+ * CommonMark syntax MAY be used for rich text representation.
3230
+ */
3125
3231
  description?: string | null;
3126
- /** @description REQUIRED. The URL for the target documentation.
3127
- * This MUST be in the format of a URL. */
3232
+ /**
3233
+ * @description REQUIRED. The URL for the target documentation.
3234
+ * This MUST be in the format of a URL.
3235
+ */
3128
3236
  url: string;
3129
3237
  } & {
3130
3238
  [key: string]: unknown;
3131
3239
  };
3132
3240
  ReferenceOr2: {
3133
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3134
- * URI. */
3241
+ /**
3242
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3243
+ * URI.
3244
+ */
3135
3245
  $ref: string;
3136
- /** @description A short summary which by default SHOULD override that of the
3246
+ /**
3247
+ * @description A short summary which by default SHOULD override that of the
3137
3248
  * referenced component. If the referenced object-type does not allow a
3138
- * `summary` field, then this field has no effect. */
3249
+ * `summary` field, then this field has no effect.
3250
+ */
3139
3251
  summary?: string | null;
3140
- /** @description A description which by default SHOULD override that of the
3252
+ /**
3253
+ * @description A description which by default SHOULD override that of the
3141
3254
  * referenced component. CommonMark syntax MAY be used for rich text
3142
3255
  * representation. If the referenced object-type does not allow a
3143
- * `description` field, then this field has no effect. */
3256
+ * `description` field, then this field has no effect.
3257
+ */
3144
3258
  description?: string | null;
3145
3259
  } | components["schemas"]["Parameter"];
3146
3260
  Parameter: (({
3147
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3261
+ /**
3262
+ * @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3148
3263
  * If in is "path", the name field MUST correspond to the associated path
3149
3264
  * segment from the path field in the Paths Object. See Path Templating for
3150
3265
  * further information.
@@ -3153,41 +3268,54 @@ export interface components {
3153
3268
  * "Authorization", the parameter definition SHALL be ignored.
3154
3269
  *
3155
3270
  * For all other cases, the name corresponds to the parameter name
3156
- * used by the in property. */
3271
+ * used by the in property.
3272
+ */
3157
3273
  name: string;
3158
- /** @description A brief description of the parameter. This could
3274
+ /**
3275
+ * @description A brief description of the parameter. This could
3159
3276
  * contain examples of use. CommonMark syntax MAY be
3160
- * used for rich text representation. */
3277
+ * used for rich text representation.
3278
+ */
3161
3279
  description?: string | null;
3162
- /** @description Determines whether this parameter is mandatory.
3280
+ /**
3281
+ * @description Determines whether this parameter is mandatory.
3163
3282
  * If the parameter location is "path", this property
3164
3283
  * is REQUIRED and its value MUST be true. Otherwise,
3165
3284
  * the property MAY be included and its default value
3166
- * is false. */
3285
+ * is false.
3286
+ */
3167
3287
  required?: boolean;
3168
- /** @description Specifies that a parameter is deprecated and SHOULD
3169
- * be transitioned out of usage. */
3288
+ /**
3289
+ * @description Specifies that a parameter is deprecated and SHOULD
3290
+ * be transitioned out of usage.
3291
+ */
3170
3292
  deprecated?: boolean | null;
3171
3293
  example?: unknown;
3172
3294
  examples?: {
3173
3295
  [key: string]: components["schemas"]["ReferenceOr3"];
3174
3296
  };
3175
3297
  explode?: boolean | null;
3176
- /** @description Determines whether the parameter value SHOULD allow reserved
3298
+ /**
3299
+ * @description Determines whether the parameter value SHOULD allow reserved
3177
3300
  * characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included
3178
3301
  * without percent-encoding. This property only applies to parameters
3179
- * with an in value of query. The default value is false. */
3302
+ * with an in value of query. The default value is false.
3303
+ */
3180
3304
  allow_reserved?: boolean;
3181
- /** @description Describes how the parameter value will be serialized depending on
3305
+ /**
3306
+ * @description Describes how the parameter value will be serialized depending on
3182
3307
  * the type of the parameter value. Default values (based on value of
3183
3308
  * in): for query - form; for path - simple; for header - simple; for
3184
- * cookie - form. */
3309
+ * cookie - form.
3310
+ */
3185
3311
  style?: components["schemas"]["QueryStyle"];
3186
- /** @description Sets the ability to pass empty-valued parameters. This is
3312
+ /**
3313
+ * @description Sets the ability to pass empty-valued parameters. This is
3187
3314
  * valid only for query parameters and allows sending a parameter
3188
3315
  * with an empty value. Default value is false. If style is used,
3189
3316
  * and if behavior is n/a (cannot be serialized), the value of
3190
- * allowEmptyValue SHALL be ignored. */
3317
+ * allowEmptyValue SHALL be ignored.
3318
+ */
3191
3319
  allow_empty_value?: boolean | null;
3192
3320
  /** @constant */
3193
3321
  in: "query";
@@ -3202,7 +3330,8 @@ export interface components {
3202
3330
  [key: string]: components["schemas"]["MediaType"];
3203
3331
  };
3204
3332
  })) | (({
3205
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3333
+ /**
3334
+ * @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3206
3335
  * If in is "path", the name field MUST correspond to the associated path
3207
3336
  * segment from the path field in the Paths Object. See Path Templating for
3208
3337
  * further information.
@@ -3211,30 +3340,39 @@ export interface components {
3211
3340
  * "Authorization", the parameter definition SHALL be ignored.
3212
3341
  *
3213
3342
  * For all other cases, the name corresponds to the parameter name
3214
- * used by the in property. */
3343
+ * used by the in property.
3344
+ */
3215
3345
  name: string;
3216
- /** @description A brief description of the parameter. This could
3346
+ /**
3347
+ * @description A brief description of the parameter. This could
3217
3348
  * contain examples of use. CommonMark syntax MAY be
3218
- * used for rich text representation. */
3349
+ * used for rich text representation.
3350
+ */
3219
3351
  description?: string | null;
3220
- /** @description Determines whether this parameter is mandatory.
3352
+ /**
3353
+ * @description Determines whether this parameter is mandatory.
3221
3354
  * If the parameter location is "path", this property
3222
3355
  * is REQUIRED and its value MUST be true. Otherwise,
3223
3356
  * the property MAY be included and its default value
3224
- * is false. */
3357
+ * is false.
3358
+ */
3225
3359
  required?: boolean;
3226
- /** @description Specifies that a parameter is deprecated and SHOULD
3227
- * be transitioned out of usage. */
3360
+ /**
3361
+ * @description Specifies that a parameter is deprecated and SHOULD
3362
+ * be transitioned out of usage.
3363
+ */
3228
3364
  deprecated?: boolean | null;
3229
3365
  example?: unknown;
3230
3366
  examples?: {
3231
3367
  [key: string]: components["schemas"]["ReferenceOr3"];
3232
3368
  };
3233
3369
  explode?: boolean | null;
3234
- /** @description Describes how the parameter value will be serialized depending on
3370
+ /**
3371
+ * @description Describes how the parameter value will be serialized depending on
3235
3372
  * the type of the parameter value. Default values (based on value of
3236
3373
  * in): for query - form; for path - simple; for header - simple; for
3237
- * cookie - form. */
3374
+ * cookie - form.
3375
+ */
3238
3376
  style?: components["schemas"]["HeaderStyle"];
3239
3377
  /** @constant */
3240
3378
  in: "header";
@@ -3249,7 +3387,8 @@ export interface components {
3249
3387
  [key: string]: components["schemas"]["MediaType"];
3250
3388
  };
3251
3389
  })) | (({
3252
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3390
+ /**
3391
+ * @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3253
3392
  * If in is "path", the name field MUST correspond to the associated path
3254
3393
  * segment from the path field in the Paths Object. See Path Templating for
3255
3394
  * further information.
@@ -3258,30 +3397,39 @@ export interface components {
3258
3397
  * "Authorization", the parameter definition SHALL be ignored.
3259
3398
  *
3260
3399
  * For all other cases, the name corresponds to the parameter name
3261
- * used by the in property. */
3400
+ * used by the in property.
3401
+ */
3262
3402
  name: string;
3263
- /** @description A brief description of the parameter. This could
3403
+ /**
3404
+ * @description A brief description of the parameter. This could
3264
3405
  * contain examples of use. CommonMark syntax MAY be
3265
- * used for rich text representation. */
3406
+ * used for rich text representation.
3407
+ */
3266
3408
  description?: string | null;
3267
- /** @description Determines whether this parameter is mandatory.
3409
+ /**
3410
+ * @description Determines whether this parameter is mandatory.
3268
3411
  * If the parameter location is "path", this property
3269
3412
  * is REQUIRED and its value MUST be true. Otherwise,
3270
3413
  * the property MAY be included and its default value
3271
- * is false. */
3414
+ * is false.
3415
+ */
3272
3416
  required?: boolean;
3273
- /** @description Specifies that a parameter is deprecated and SHOULD
3274
- * be transitioned out of usage. */
3417
+ /**
3418
+ * @description Specifies that a parameter is deprecated and SHOULD
3419
+ * be transitioned out of usage.
3420
+ */
3275
3421
  deprecated?: boolean | null;
3276
3422
  example?: unknown;
3277
3423
  examples?: {
3278
3424
  [key: string]: components["schemas"]["ReferenceOr3"];
3279
3425
  };
3280
3426
  explode?: boolean | null;
3281
- /** @description Describes how the parameter value will be serialized depending on
3427
+ /**
3428
+ * @description Describes how the parameter value will be serialized depending on
3282
3429
  * the type of the parameter value. Default values (based on value of
3283
3430
  * in): for query - form; for path - simple; for header - simple; for
3284
- * cookie - form. */
3431
+ * cookie - form.
3432
+ */
3285
3433
  style?: components["schemas"]["PathStyle"];
3286
3434
  /** @constant */
3287
3435
  in: "path";
@@ -3296,7 +3444,8 @@ export interface components {
3296
3444
  [key: string]: components["schemas"]["MediaType"];
3297
3445
  };
3298
3446
  })) | (({
3299
- /** @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3447
+ /**
3448
+ * @description REQUIRED. The name of the parameter. Parameter names are case sensitive.
3300
3449
  * If in is "path", the name field MUST correspond to the associated path
3301
3450
  * segment from the path field in the Paths Object. See Path Templating for
3302
3451
  * further information.
@@ -3305,30 +3454,39 @@ export interface components {
3305
3454
  * "Authorization", the parameter definition SHALL be ignored.
3306
3455
  *
3307
3456
  * For all other cases, the name corresponds to the parameter name
3308
- * used by the in property. */
3457
+ * used by the in property.
3458
+ */
3309
3459
  name: string;
3310
- /** @description A brief description of the parameter. This could
3460
+ /**
3461
+ * @description A brief description of the parameter. This could
3311
3462
  * contain examples of use. CommonMark syntax MAY be
3312
- * used for rich text representation. */
3463
+ * used for rich text representation.
3464
+ */
3313
3465
  description?: string | null;
3314
- /** @description Determines whether this parameter is mandatory.
3466
+ /**
3467
+ * @description Determines whether this parameter is mandatory.
3315
3468
  * If the parameter location is "path", this property
3316
3469
  * is REQUIRED and its value MUST be true. Otherwise,
3317
3470
  * the property MAY be included and its default value
3318
- * is false. */
3471
+ * is false.
3472
+ */
3319
3473
  required?: boolean;
3320
- /** @description Specifies that a parameter is deprecated and SHOULD
3321
- * be transitioned out of usage. */
3474
+ /**
3475
+ * @description Specifies that a parameter is deprecated and SHOULD
3476
+ * be transitioned out of usage.
3477
+ */
3322
3478
  deprecated?: boolean | null;
3323
3479
  example?: unknown;
3324
3480
  examples?: {
3325
3481
  [key: string]: components["schemas"]["ReferenceOr3"];
3326
3482
  };
3327
3483
  explode?: boolean | null;
3328
- /** @description Describes how the parameter value will be serialized depending on
3484
+ /**
3485
+ * @description Describes how the parameter value will be serialized depending on
3329
3486
  * the type of the parameter value. Default values (based on value of
3330
3487
  * in): for query - form; for path - simple; for header - simple; for
3331
- * cookie - form. */
3488
+ * cookie - form.
3489
+ */
3332
3490
  style?: components["schemas"]["CookieStyle"];
3333
3491
  /** @constant */
3334
3492
  in: "cookie";
@@ -3346,13 +3504,15 @@ export interface components {
3346
3504
  SchemaObject: {
3347
3505
  /** @description Additional external documentation for this schema. */
3348
3506
  externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
3349
- /** @description A free-form property to include an example of an instance for this
3507
+ /**
3508
+ * @description A free-form property to include an example of an instance for this
3350
3509
  * schema. To represent examples that cannot be naturally represented in
3351
3510
  * JSON or YAML, a string value can be used to contain the example with
3352
3511
  * escaping where necessary. **Deprecated:** The `example` property has
3353
3512
  * been deprecated in favor of the JSON Schema `examples` keyword. Use
3354
3513
  * of `example` is discouraged, and later versions of this
3355
- * specification may remove it. */
3514
+ * specification may remove it.
3515
+ */
3356
3516
  example?: unknown;
3357
3517
  };
3358
3518
  MediaType: {
@@ -3368,66 +3528,85 @@ export interface components {
3368
3528
  [key: string]: unknown;
3369
3529
  };
3370
3530
  ReferenceOr3: {
3371
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3372
- * URI. */
3531
+ /**
3532
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3533
+ * URI.
3534
+ */
3373
3535
  $ref: string;
3374
- /** @description A short summary which by default SHOULD override that of the
3536
+ /**
3537
+ * @description A short summary which by default SHOULD override that of the
3375
3538
  * referenced component. If the referenced object-type does not allow a
3376
- * `summary` field, then this field has no effect. */
3539
+ * `summary` field, then this field has no effect.
3540
+ */
3377
3541
  summary?: string | null;
3378
- /** @description A description which by default SHOULD override that of the
3542
+ /**
3543
+ * @description A description which by default SHOULD override that of the
3379
3544
  * referenced component. CommonMark syntax MAY be used for rich text
3380
3545
  * representation. If the referenced object-type does not allow a
3381
- * `description` field, then this field has no effect. */
3546
+ * `description` field, then this field has no effect.
3547
+ */
3382
3548
  description?: string | null;
3383
3549
  } | components["schemas"]["Example"];
3384
3550
  Example: {
3385
3551
  /** @description Short description for the example. */
3386
3552
  summary?: string | null;
3387
- /** @description Long description for the example.
3388
- * CommonMark syntax MAY be used for rich text representation. */
3553
+ /**
3554
+ * @description Long description for the example.
3555
+ * CommonMark syntax MAY be used for rich text representation.
3556
+ */
3389
3557
  description?: string | null;
3390
- /** @description Embedded literal example. The `value` field and `externalValue`
3558
+ /**
3559
+ * @description Embedded literal example. The `value` field and `externalValue`
3391
3560
  * field are mutually exclusive. To represent examples of
3392
3561
  * media types that cannot naturally represented in JSON or YAML,
3393
- * use a string value to contain the example, escaping where necessary. */
3562
+ * use a string value to contain the example, escaping where necessary.
3563
+ */
3394
3564
  value?: unknown;
3395
- /** @description A URI that points to the literal example.
3565
+ /**
3566
+ * @description A URI that points to the literal example.
3396
3567
  * This provides the capability to reference examples that cannot
3397
3568
  * easily be included in JSON or YAML documents. The `value` field and
3398
3569
  * `externalValue` field are mutually exclusive. See the rules for
3399
- * resolving Relative References. */
3570
+ * resolving Relative References.
3571
+ */
3400
3572
  externalValue?: string | null;
3401
3573
  } & {
3402
3574
  [key: string]: unknown;
3403
3575
  };
3404
3576
  /** @description A single encoding definition applied to a single schema property. */
3405
3577
  Encoding: {
3406
- /** @description The Content-Type for encoding a specific property.
3578
+ /**
3579
+ * @description The Content-Type for encoding a specific property.
3407
3580
  * Default value depends on the property type:
3408
3581
  * for object - application/json;
3409
3582
  * for array – the default is defined based on the inner type.
3410
3583
  * for all other cases the default is `application/octet-stream`.
3411
3584
  * The value can be a specific media type (e.g. application/json),
3412
3585
  * a wildcard media type (e.g. image/*), or a comma-separated list of the
3413
- * two types. */
3586
+ * two types.
3587
+ */
3414
3588
  contentType?: string | null;
3415
- /** @description A map allowing additional information to be provided as headers,
3589
+ /**
3590
+ * @description A map allowing additional information to be provided as headers,
3416
3591
  * for example Content-Disposition. Content-Type is described separately
3417
3592
  * and SHALL be ignored in this section. This property SHALL be ignored
3418
- * if the request body media type is not a multipart. */
3593
+ * if the request body media type is not a multipart.
3594
+ */
3419
3595
  headers?: {
3420
3596
  [key: string]: components["schemas"]["ReferenceOr4"];
3421
3597
  };
3422
- /** @description Describes how a specific property value will be serialized depending
3598
+ /**
3599
+ * @description Describes how a specific property value will be serialized depending
3423
3600
  * on its type. See Parameter Object for details on the style property.
3424
3601
  * The behavior follows the same values as query parameters, including
3425
3602
  * default values. This property SHALL be ignored if the request body
3426
3603
  * media type is not application/x-www-form-urlencoded or
3427
3604
  * multipart/form-data. If a value is explicitly defined, then the value of
3428
- * `contentType` (implicit or explicit) SHALL be ignored. */
3605
+ * `contentType` (implicit or explicit) SHALL be ignored.
3606
+ */
3429
3607
  style?: components["schemas"]["QueryStyle"] | null;
3430
- /** @description When this is true, property values of type array or object generate
3608
+ /**
3609
+ * @description When this is true, property values of type array or object generate
3431
3610
  * separate parameters for each value of the array, or key-value-pair
3432
3611
  * of the map. For other types of properties this property has no effect.
3433
3612
  * When style is form, the default value is true.
@@ -3438,55 +3617,72 @@ export interface components {
3438
3617
  * explicit) SHALL be ignored.
3439
3618
  *
3440
3619
  * In this Library this value defaults to false always despite the
3441
- * specification. */
3620
+ * specification.
3621
+ */
3442
3622
  explode?: boolean;
3443
- /** @description Determines whether the parameter value SHOULD allow reserved characters,
3623
+ /**
3624
+ * @description Determines whether the parameter value SHOULD allow reserved characters,
3444
3625
  * as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without
3445
3626
  * percent-encoding. The default value is false. This property SHALL be
3446
3627
  * ignored if the request body media type is not
3447
3628
  * application/x-www-form-urlencoded or multipart/form-data. If a value is
3448
3629
  * explicitly defined, then the value of `contentType` (implicit or
3449
- * explicit) SHALL be ignored. */
3630
+ * explicit) SHALL be ignored.
3631
+ */
3450
3632
  allowReserved?: boolean;
3451
3633
  } & {
3452
3634
  [key: string]: unknown;
3453
3635
  };
3454
3636
  ReferenceOr4: {
3455
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3456
- * URI. */
3637
+ /**
3638
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3639
+ * URI.
3640
+ */
3457
3641
  $ref: string;
3458
- /** @description A short summary which by default SHOULD override that of the
3642
+ /**
3643
+ * @description A short summary which by default SHOULD override that of the
3459
3644
  * referenced component. If the referenced object-type does not allow a
3460
- * `summary` field, then this field has no effect. */
3645
+ * `summary` field, then this field has no effect.
3646
+ */
3461
3647
  summary?: string | null;
3462
- /** @description A description which by default SHOULD override that of the
3648
+ /**
3649
+ * @description A description which by default SHOULD override that of the
3463
3650
  * referenced component. CommonMark syntax MAY be used for rich text
3464
3651
  * representation. If the referenced object-type does not allow a
3465
- * `description` field, then this field has no effect. */
3652
+ * `description` field, then this field has no effect.
3653
+ */
3466
3654
  description?: string | null;
3467
3655
  } | components["schemas"]["Header"];
3468
- /** @description The Header Object follows the structure of the Parameter Object with the
3656
+ /**
3657
+ * @description The Header Object follows the structure of the Parameter Object with the
3469
3658
  * following changes:
3470
3659
  *
3471
3660
  * 1) name MUST NOT be specified, it is given in the corresponding headers map.
3472
3661
  * 2) in MUST NOT be specified, it is implicitly in header.
3473
3662
  * 3) All traits that are affected by the location MUST be applicable to a
3474
- * location of header (for example, style). */
3663
+ * location of header (for example, style).
3664
+ */
3475
3665
  Header: ({
3476
- /** @description A brief description of the parameter. This could
3666
+ /**
3667
+ * @description A brief description of the parameter. This could
3477
3668
  * contain examples of use. CommonMark syntax MAY be
3478
- * used for rich text representation. */
3669
+ * used for rich text representation.
3670
+ */
3479
3671
  description?: string | null;
3480
3672
  /** @default simple */
3481
3673
  style: components["schemas"]["HeaderStyle"];
3482
- /** @description Determines whether this parameter is mandatory.
3674
+ /**
3675
+ * @description Determines whether this parameter is mandatory.
3483
3676
  * If the parameter location is "path", this property
3484
3677
  * is REQUIRED and its value MUST be true. Otherwise,
3485
3678
  * the property MAY be included and its default value
3486
- * is false. */
3679
+ * is false.
3680
+ */
3487
3681
  required?: boolean;
3488
- /** @description Specifies that a parameter is deprecated and SHOULD
3489
- * be transitioned out of usage. */
3682
+ /**
3683
+ * @description Specifies that a parameter is deprecated and SHOULD
3684
+ * be transitioned out of usage.
3685
+ */
3490
3686
  deprecated?: boolean | null;
3491
3687
  example?: unknown;
3492
3688
  examples?: {
@@ -3512,82 +3708,110 @@ export interface components {
3512
3708
  /** @enum {string} */
3513
3709
  CookieStyle: "form";
3514
3710
  ReferenceOr5: {
3515
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3516
- * URI. */
3711
+ /**
3712
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3713
+ * URI.
3714
+ */
3517
3715
  $ref: string;
3518
- /** @description A short summary which by default SHOULD override that of the
3716
+ /**
3717
+ * @description A short summary which by default SHOULD override that of the
3519
3718
  * referenced component. If the referenced object-type does not allow a
3520
- * `summary` field, then this field has no effect. */
3719
+ * `summary` field, then this field has no effect.
3720
+ */
3521
3721
  summary?: string | null;
3522
- /** @description A description which by default SHOULD override that of the
3722
+ /**
3723
+ * @description A description which by default SHOULD override that of the
3523
3724
  * referenced component. CommonMark syntax MAY be used for rich text
3524
3725
  * representation. If the referenced object-type does not allow a
3525
- * `description` field, then this field has no effect. */
3726
+ * `description` field, then this field has no effect.
3727
+ */
3526
3728
  description?: string | null;
3527
3729
  } | components["schemas"]["RequestBody"];
3528
3730
  RequestBody: {
3529
- /** @description A brief description of the request body.
3731
+ /**
3732
+ * @description A brief description of the request body.
3530
3733
  * This could contain examples of use.
3531
- * CommonMark syntax MAY be used for rich text representation. */
3734
+ * CommonMark syntax MAY be used for rich text representation.
3735
+ */
3532
3736
  description?: string | null;
3533
- /** @description REQUIRED. The content of the request body.
3737
+ /**
3738
+ * @description REQUIRED. The content of the request body.
3534
3739
  * The key is a media type or media type range and
3535
3740
  * the value describes it. For requests that match
3536
3741
  * multiple keys, only the most specific key is applicable.
3537
- * e.g. text/plain overrides text/* */
3742
+ * e.g. text/plain overrides text/*
3743
+ */
3538
3744
  content?: {
3539
3745
  [key: string]: components["schemas"]["MediaType"];
3540
3746
  };
3541
- /** @description Determines if the request body is required in the
3542
- * request. Defaults to false. */
3747
+ /**
3748
+ * @description Determines if the request body is required in the
3749
+ * request. Defaults to false.
3750
+ */
3543
3751
  required?: boolean;
3544
3752
  } & {
3545
3753
  [key: string]: unknown;
3546
3754
  };
3547
3755
  Responses: {
3548
- /** @description The documentation of responses other than the ones declared
3756
+ /**
3757
+ * @description The documentation of responses other than the ones declared
3549
3758
  * for specific HTTP response codes. Use this field to cover
3550
- * undeclared responses. */
3759
+ * undeclared responses.
3760
+ */
3551
3761
  default?: components["schemas"]["ReferenceOr6"] | null;
3552
3762
  } & {
3553
3763
  [key: string]: components["schemas"]["ReferenceOr6"];
3554
3764
  };
3555
3765
  ReferenceOr6: {
3556
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3557
- * URI. */
3766
+ /**
3767
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3768
+ * URI.
3769
+ */
3558
3770
  $ref: string;
3559
- /** @description A short summary which by default SHOULD override that of the
3771
+ /**
3772
+ * @description A short summary which by default SHOULD override that of the
3560
3773
  * referenced component. If the referenced object-type does not allow a
3561
- * `summary` field, then this field has no effect. */
3774
+ * `summary` field, then this field has no effect.
3775
+ */
3562
3776
  summary?: string | null;
3563
- /** @description A description which by default SHOULD override that of the
3777
+ /**
3778
+ * @description A description which by default SHOULD override that of the
3564
3779
  * referenced component. CommonMark syntax MAY be used for rich text
3565
3780
  * representation. If the referenced object-type does not allow a
3566
- * `description` field, then this field has no effect. */
3781
+ * `description` field, then this field has no effect.
3782
+ */
3567
3783
  description?: string | null;
3568
3784
  } | components["schemas"]["Response"];
3569
3785
  Response: {
3570
- /** @description REQUIRED. A description of the response.
3571
- * CommonMark syntax MAY be used for rich text representation. */
3786
+ /**
3787
+ * @description REQUIRED. A description of the response.
3788
+ * CommonMark syntax MAY be used for rich text representation.
3789
+ */
3572
3790
  description: string;
3573
- /** @description Maps a header name to its definition.
3791
+ /**
3792
+ * @description Maps a header name to its definition.
3574
3793
  * RFC7230 states header names are case insensitive.
3575
3794
  * If a response header is defined with the name "Content-Type",
3576
- * it SHALL be ignored. */
3795
+ * it SHALL be ignored.
3796
+ */
3577
3797
  headers?: {
3578
3798
  [key: string]: components["schemas"]["ReferenceOr4"];
3579
3799
  };
3580
- /** @description A map containing descriptions of potential response payloads.
3800
+ /**
3801
+ * @description A map containing descriptions of potential response payloads.
3581
3802
  * The key is a media type or media type range and the value
3582
3803
  * describes it. For responses that match multiple keys,
3583
3804
  * only the most specific key is applicable. e.g. text/plain
3584
- * overrides text/* */
3805
+ * overrides text/*
3806
+ */
3585
3807
  content?: {
3586
3808
  [key: string]: components["schemas"]["MediaType"];
3587
3809
  };
3588
- /** @description A map of operations links that can be followed from the response.
3810
+ /**
3811
+ * @description A map of operations links that can be followed from the response.
3589
3812
  * The key of the map is a short name for the link, following
3590
- * the naming constraints of the names for Component Objects. */
3813
+ * the naming constraints of the names for Component Objects.
3814
+ */
3591
3815
  links?: {
3592
3816
  [key: string]: components["schemas"]["ReferenceOr7"];
3593
3817
  };
@@ -3595,20 +3819,27 @@ export interface components {
3595
3819
  [key: string]: unknown;
3596
3820
  };
3597
3821
  ReferenceOr7: {
3598
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3599
- * URI. */
3822
+ /**
3823
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3824
+ * URI.
3825
+ */
3600
3826
  $ref: string;
3601
- /** @description A short summary which by default SHOULD override that of the
3827
+ /**
3828
+ * @description A short summary which by default SHOULD override that of the
3602
3829
  * referenced component. If the referenced object-type does not allow a
3603
- * `summary` field, then this field has no effect. */
3830
+ * `summary` field, then this field has no effect.
3831
+ */
3604
3832
  summary?: string | null;
3605
- /** @description A description which by default SHOULD override that of the
3833
+ /**
3834
+ * @description A description which by default SHOULD override that of the
3606
3835
  * referenced component. CommonMark syntax MAY be used for rich text
3607
3836
  * representation. If the referenced object-type does not allow a
3608
- * `description` field, then this field has no effect. */
3837
+ * `description` field, then this field has no effect.
3838
+ */
3609
3839
  description?: string | null;
3610
3840
  } | components["schemas"]["Link"];
3611
- /** @description The Link object represents a possible design-time link for a response.
3841
+ /**
3842
+ * @description The Link object represents a possible design-time link for a response.
3612
3843
  * The presence of a link does not guarantee the caller's ability to
3613
3844
  * successfully invoke it, rather it provides a known relationship and
3614
3845
  * traversal mechanism between responses and other operations.
@@ -3619,21 +3850,28 @@ export interface components {
3619
3850
  *
3620
3851
  * For computing links, and providing instructions to execute them,
3621
3852
  * a runtime expression is used for accessing values in an operation
3622
- * and using them as parameters while invoking the linked operation. */
3853
+ * and using them as parameters while invoking the linked operation.
3854
+ */
3623
3855
  Link: ({
3624
- /** @description A description of the link.
3625
- * CommonMark syntax MAY be used for rich text representation. */
3856
+ /**
3857
+ * @description A description of the link.
3858
+ * CommonMark syntax MAY be used for rich text representation.
3859
+ */
3626
3860
  description?: string | null;
3627
- /** @description A literal value or {expression} to use as a request body
3628
- * when calling the target operation. */
3861
+ /**
3862
+ * @description A literal value or {expression} to use as a request body
3863
+ * when calling the target operation.
3864
+ */
3629
3865
  requestBody?: unknown;
3630
- /** @description A map representing parameters to pass to an operation
3866
+ /**
3867
+ * @description A map representing parameters to pass to an operation
3631
3868
  * as specified with operationId or identified via operationRef.
3632
3869
  * The key is the parameter name to be used, whereas the value
3633
3870
  * can be a constant or an expression to be evaluated and passed
3634
3871
  * to the linked operation. The parameter name can be qualified
3635
3872
  * using the parameter location [{in}.]{name} for operations
3636
- * that use the same parameter name in different locations (e.g. path.id). */
3873
+ * that use the same parameter name in different locations (e.g. path.id).
3874
+ */
3637
3875
  parameters?: {
3638
3876
  [key: string]: unknown;
3639
3877
  };
@@ -3649,25 +3887,33 @@ export interface components {
3649
3887
  operationId: string;
3650
3888
  });
3651
3889
  ReferenceOr8: {
3652
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3653
- * URI. */
3890
+ /**
3891
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3892
+ * URI.
3893
+ */
3654
3894
  $ref: string;
3655
- /** @description A short summary which by default SHOULD override that of the
3895
+ /**
3896
+ * @description A short summary which by default SHOULD override that of the
3656
3897
  * referenced component. If the referenced object-type does not allow a
3657
- * `summary` field, then this field has no effect. */
3898
+ * `summary` field, then this field has no effect.
3899
+ */
3658
3900
  summary?: string | null;
3659
- /** @description A description which by default SHOULD override that of the
3901
+ /**
3902
+ * @description A description which by default SHOULD override that of the
3660
3903
  * referenced component. CommonMark syntax MAY be used for rich text
3661
3904
  * representation. If the referenced object-type does not allow a
3662
- * `description` field, then this field has no effect. */
3905
+ * `description` field, then this field has no effect.
3906
+ */
3663
3907
  description?: string | null;
3664
3908
  } | {
3665
3909
  [key: string]: components["schemas"]["ReferenceOr"];
3666
3910
  };
3667
- /** @description Holds a set of reusable objects for different aspects of the OAS.
3911
+ /**
3912
+ * @description Holds a set of reusable objects for different aspects of the OAS.
3668
3913
  * All objects defined within the components object will have no effect
3669
3914
  * on the API unless they are explicitly referenced from properties
3670
- * outside the components object. */
3915
+ * outside the components object.
3916
+ */
3671
3917
  Components: {
3672
3918
  /** @description An object to hold reusable Security Scheme Objects. */
3673
3919
  securitySchemes?: {
@@ -3713,24 +3959,32 @@ export interface components {
3713
3959
  [key: string]: unknown;
3714
3960
  };
3715
3961
  ReferenceOr9: {
3716
- /** @description REQUIRED. The reference identifier. This MUST be in the form of a
3717
- * URI. */
3962
+ /**
3963
+ * @description REQUIRED. The reference identifier. This MUST be in the form of a
3964
+ * URI.
3965
+ */
3718
3966
  $ref: string;
3719
- /** @description A short summary which by default SHOULD override that of the
3967
+ /**
3968
+ * @description A short summary which by default SHOULD override that of the
3720
3969
  * referenced component. If the referenced object-type does not allow a
3721
- * `summary` field, then this field has no effect. */
3970
+ * `summary` field, then this field has no effect.
3971
+ */
3722
3972
  summary?: string | null;
3723
- /** @description A description which by default SHOULD override that of the
3973
+ /**
3974
+ * @description A description which by default SHOULD override that of the
3724
3975
  * referenced component. CommonMark syntax MAY be used for rich text
3725
3976
  * representation. If the referenced object-type does not allow a
3726
- * `description` field, then this field has no effect. */
3977
+ * `description` field, then this field has no effect.
3978
+ */
3727
3979
  description?: string | null;
3728
3980
  } | components["schemas"]["SecurityScheme"];
3729
- /** @description Defines a security scheme that can be used by the operations.
3981
+ /**
3982
+ * @description Defines a security scheme that can be used by the operations.
3730
3983
  * Supported schemes are HTTP authentication, an API key (either as a
3731
3984
  * header or as a query parameter), OAuth2's common flows (implicit, password,
3732
3985
  * application and access code) as defined in RFC6749, and OpenID Connect
3733
- * Discovery. */
3986
+ * Discovery.
3987
+ */
3734
3988
  SecurityScheme: ({
3735
3989
  in: components["schemas"]["ApiKeyLocation"];
3736
3990
  name: string;
@@ -3919,14 +4173,18 @@ export interface components {
3919
4173
  };
3920
4174
  };
3921
4175
  }) | unknown);
3922
- /** @description Adds metadata to a single tag that is used by the
4176
+ /**
4177
+ * @description Adds metadata to a single tag that is used by the
3923
4178
  * Operation Object. It is not mandatory to have a
3924
- * Tag Object per tag defined in the Operation Object instances. */
4179
+ * Tag Object per tag defined in the Operation Object instances.
4180
+ */
3925
4181
  Tag: {
3926
4182
  /** @description REQUIRED. The name of the tag. */
3927
4183
  name: string;
3928
- /** @description A description for the tag.
3929
- * CommonMark syntax MAY be used for rich text representation. */
4184
+ /**
4185
+ * @description A description for the tag.
4186
+ * CommonMark syntax MAY be used for rich text representation.
4187
+ */
3930
4188
  description?: string | null;
3931
4189
  /** @description Additional external documentation for this tag. */
3932
4190
  externalDocs?: components["schemas"]["ExternalDocumentation"] | null;
@@ -4024,9 +4282,11 @@ export interface components {
4024
4282
  MarketLiveInfo: {
4025
4283
  /** Format: uint32 */
4026
4284
  marketId: number;
4027
- /** @description Admin can freeze market.
4285
+ /**
4286
+ * @description Admin can freeze market.
4028
4287
  * Can happen when there are issues with market setup and need to stop operations.
4029
- * Or if market permanently delisted (orderbook l2 is zero and perpetuals open interest would be zero in this case). */
4288
+ * Or if market permanently delisted (orderbook l2 is zero and perpetuals open interest would be zero in this case).
4289
+ */
4030
4290
  frozen?: boolean;
4031
4291
  /** Format: double */
4032
4292
  indexPrice?: number | null;
@@ -4047,8 +4307,10 @@ export interface components {
4047
4307
  * funding rate.
4048
4308
  */
4049
4309
  projectedFundingRate?: number | null;
4050
- /** @description The next time at which funding will be paid. Locked to the hour, though
4051
- * may be delayed if oracle updates are delayed. */
4310
+ /**
4311
+ * @description The next time at which funding will be paid. Locked to the hour, though
4312
+ * may be delayed if oracle updates are delayed.
4313
+ */
4052
4314
  nextFundingTime: string;
4053
4315
  /**
4054
4316
  * Format: double
@@ -4106,9 +4368,11 @@ export interface components {
4106
4368
  * this time can only go forward and cannot be `Default`.
4107
4369
  */
4108
4370
  Timestamp: number;
4109
- /** @description Returns fee parts per market per balance change per action per account.
4371
+ /**
4372
+ * @description Returns fee parts per market per balance change per action per account.
4110
4373
  * Fee is taken from user without return.
4111
- * Please note that some operations need some deposit which will be returned - these are not part of fees. */
4374
+ * Please note that some operations need some deposit which will be returned - these are not part of fees.
4375
+ */
4112
4376
  FillRole: "maker" | "taker";
4113
4377
  /** @description 31 bit account id */
4114
4378
  AccountId: number;
@@ -4185,12 +4449,16 @@ export interface components {
4185
4449
  confidence: number;
4186
4450
  };
4187
4451
  TokenNotFound: null;
4188
- /** @description Solana base58 address with private key (must have private side so that can create session after).
4189
- * Basically fix for solana-pubkey is array of bytes in serde https://github.com/anza-xyz/solana-sdk/pull/76 */
4452
+ /**
4453
+ * @description Solana base58 address with private key (must have private side so that can create session after).
4454
+ * Basically fix for solana-pubkey is array of bytes in serde https://github.com/anza-xyz/solana-sdk/pull/76
4455
+ */
4190
4456
  RegistrationKey: string;
4191
4457
  User: {
4192
4458
  accountIds: components["schemas"]["AccountId"][];
4193
- sessions: Record<string, never>;
4459
+ sessions: {
4460
+ [key: string]: components["schemas"]["UserSession"];
4461
+ };
4194
4462
  };
4195
4463
  UserSession: {
4196
4464
  pubkey: components["schemas"]["RegistrationKey"];
@@ -4220,8 +4488,10 @@ export interface components {
4220
4488
  */
4221
4489
  nextStartInclusive?: number | null;
4222
4490
  };
4223
- /** @description Order summary.
4224
- * Use order_id to application side join with trades as needed. */
4491
+ /**
4492
+ * @description Order summary.
4493
+ * Use order_id to application side join with trades as needed.
4494
+ */
4225
4495
  OrderInfo: {
4226
4496
  addedAt: string;
4227
4497
  updatedAt: string;
@@ -4280,8 +4550,10 @@ export interface components {
4280
4550
  /** Format: uint64 */
4281
4551
  clientOrderId?: number | null;
4282
4552
  };
4283
- /** @description Summary of position.
4284
- * Does not provide details information about specific orders. */
4553
+ /**
4554
+ * @description Summary of position.
4555
+ * Does not provide details information about specific orders.
4556
+ */
4285
4557
  PositionSummary: {
4286
4558
  /** Format: uint32 */
4287
4559
  marketId: number;
@@ -4321,13 +4593,15 @@ export interface components {
4321
4593
  /** Format: double */
4322
4594
  amount: number;
4323
4595
  };
4324
- /** @description Represents account health state.
4596
+ /**
4597
+ * @description Represents account health state.
4325
4598
  * Each field expressed in USD basis points per account.
4326
4599
  * For example:
4327
4600
  * - value of 1.0000 means 1 USD.
4328
4601
  * - value of 123.0004 means 123 USD and 0.04 cent.
4329
4602
  *
4330
- * All values are actual only at specific moment in time - because both market and oracle prices fluctuate all the time */
4603
+ * All values are actual only at specific moment in time - because both market and oracle prices fluctuate all the time
4604
+ */
4331
4605
  AccountMarginsView: {
4332
4606
  /**
4333
4607
  * Format: double
@@ -4379,20 +4653,24 @@ export interface components {
4379
4653
  * @description Similar to `pon`. See PN in MARKETS.md.
4380
4654
  */
4381
4655
  pn: number;
4382
- /** @description See `bankruptcy` in MARKETS.md.
4656
+ /**
4657
+ * @description See `bankruptcy` in MARKETS.md.
4383
4658
  * In general happens if account does not have enough weighted tokens to
4384
- * covert his debt and negative PnL. */
4659
+ * covert his debt and negative PnL.
4660
+ */
4385
4661
  bankruptcy: boolean;
4386
4662
  };
4387
4663
  VaultViewState: {
4388
4664
  state: components["schemas"]["VaultState"];
4389
4665
  status: components["schemas"]["VaultStatus"];
4390
4666
  };
4391
- /** @description Wrapper around one normal engine account.
4667
+ /**
4668
+ * @description Wrapper around one normal engine account.
4392
4669
  *
4393
4670
  * The account keeps balances, positions, orders, triggers, funding,
4394
4671
  * liquidation, and account health. This state adds manager, config, shares,
4395
- * epochs, and owner accounting. */
4672
+ * epochs, and owner accounting.
4673
+ */
4396
4674
  VaultState: {
4397
4675
  vault_id: components["schemas"]["VaultId"];
4398
4676
  account_id: components["schemas"]["AccountId"];
@@ -4401,7 +4679,9 @@ export interface components {
4401
4679
  /** Format: uint128 */
4402
4680
  live_share_supply: number;
4403
4681
  epochs: components["schemas"]["VaultEpochs"];
4404
- users: Record<string, never>;
4682
+ users: {
4683
+ [key: string]: components["schemas"]["VaultUserState"];
4684
+ };
4405
4685
  };
4406
4686
  /**
4407
4687
  * Format: uint32
@@ -4432,8 +4712,10 @@ export interface components {
4432
4712
  * combined decimals (price_decimals + size_decimals).
4433
4713
  */
4434
4714
  PositiveQuoteSize: number;
4435
- /** @description Drawdown measures how far current price per share is below a stored epoch
4436
- * price per share reference. */
4715
+ /**
4716
+ * @description Drawdown measures how far current price per share is below a stored epoch
4717
+ * price per share reference.
4718
+ */
4437
4719
  DrawdownConfig: {
4438
4720
  /**
4439
4721
  * Format: uint16
@@ -4458,9 +4740,11 @@ export interface components {
4458
4740
  * (cannot limit what is possible with traits well).
4459
4741
  */
4460
4742
  Duration: number;
4461
- /** @description Aggregate withdrawal bucket and epoch state
4743
+ /**
4744
+ * @description Aggregate withdrawal bucket and epoch state
4462
4745
  *
4463
- * Withdrawals are aggregate `Q_current`, `Q_previous`, and `Q_claimable` */
4746
+ * Withdrawals are aggregate `Q_current`, `Q_previous`, and `Q_claimable`
4747
+ */
4464
4748
  VaultEpochs: {
4465
4749
  current_epoch_id: components["schemas"]["EpochId"];
4466
4750
  current_epoch_started_at: components["schemas"]["Timestamp"];
@@ -4474,9 +4758,11 @@ export interface components {
4474
4758
  * @description EpochId is a 31 bit id for vault withdrawal epochs.
4475
4759
  */
4476
4760
  EpochId: number;
4477
- /** @description Withdrawal buckets
4761
+ /**
4762
+ * @description Withdrawal buckets
4478
4763
  *
4479
- * Buckets store `Q_current`, `Q_previous`, and `Q_claimable` */
4764
+ * Buckets store `Q_current`, `Q_previous`, and `Q_claimable`
4765
+ */
4480
4766
  WithdrawalBuckets: {
4481
4767
  /** Format: uint64 */
4482
4768
  current_epoch: number;
@@ -4485,11 +4771,13 @@ export interface components {
4485
4771
  /** Format: uint64 */
4486
4772
  claimable: number;
4487
4773
  };
4488
- /** @description Price per share reference stored when an epoch closes.
4774
+ /**
4775
+ * @description Price per share reference stored when an epoch closes.
4489
4776
  *
4490
4777
  * It stores `AV_safe,ref` and `S_ref`.
4491
4778
  *
4492
- * `PPS_ref = AV_safe,ref / S_ref` */
4779
+ * `PPS_ref = AV_safe,ref / S_ref`
4780
+ */
4493
4781
  VaultPpsRef: {
4494
4782
  epoch_id: components["schemas"]["EpochId"];
4495
4783
  /**
@@ -4501,10 +4789,12 @@ export interface components {
4501
4789
  /** Format: uint128 */
4502
4790
  share_supply: number;
4503
4791
  };
4504
- /** @description Owner share and withdrawal state
4792
+ /**
4793
+ * @description Owner share and withdrawal state
4505
4794
  *
4506
4795
  * Withdrawals are owner side `Q_owner,current`, `Q_owner,previous`, and
4507
- * `Q_owner,claimable` */
4796
+ * `Q_owner,claimable`
4797
+ */
4508
4798
  VaultUserState: {
4509
4799
  /** Format: uint128 */
4510
4800
  shares: number;
@@ -4552,9 +4842,11 @@ export interface components {
4552
4842
  PageResult_for_ActionIdSubActionIdMarketIdCursor_and_AccountPnlInfo: {
4553
4843
  /** @description Set of items for requested by query. */
4554
4844
  items: components["schemas"]["AccountPnlInfo"][];
4555
- /** @description If request contains more data,
4845
+ /**
4846
+ * @description If request contains more data,
4556
4847
  * this is the id is set with which next request should be performed to get next page.
4557
- * If no more data, then it is undefined. */
4848
+ * If no more data, then it is undefined.
4849
+ */
4558
4850
  nextStartInclusive?: components["schemas"]["ActionIdSubActionIdMarketIdCursor"] | null;
4559
4851
  };
4560
4852
  AccountPnlInfo: {
@@ -4631,9 +4923,11 @@ export interface components {
4631
4923
  PageResult_for_ActionIdSubActionIdMarketIdCursor_and_AccountPositionHistoryInfo: {
4632
4924
  /** @description Set of items for requested by query. */
4633
4925
  items: components["schemas"]["AccountPositionHistoryInfo"][];
4634
- /** @description If request contains more data,
4926
+ /**
4927
+ * @description If request contains more data,
4635
4928
  * this is the id is set with which next request should be performed to get next page.
4636
- * If no more data, then it is undefined. */
4929
+ * If no more data, then it is undefined.
4930
+ */
4637
4931
  nextStartInclusive?: components["schemas"]["ActionIdSubActionIdMarketIdCursor"] | null;
4638
4932
  };
4639
4933
  AccountPositionHistoryInfo: {
@@ -4729,9 +5023,11 @@ export interface components {
4729
5023
  PageResult_for_string_and_AccountFundingInfo: {
4730
5024
  /** @description Set of items for requested by query. */
4731
5025
  items: components["schemas"]["AccountFundingInfo"][];
4732
- /** @description If request contains more data,
5026
+ /**
5027
+ * @description If request contains more data,
4733
5028
  * this is the id is set with which next request should be performed to get next page.
4734
- * If no more data, then it is undefined. */
5029
+ * If no more data, then it is undefined.
5030
+ */
4735
5031
  nextStartInclusive?: string | null;
4736
5032
  };
4737
5033
  AccountFundingInfo: {
@@ -4826,9 +5122,11 @@ export interface components {
4826
5122
  PageResult_for_AtomicActionIdCursor_and_PlaceTriggerRow: {
4827
5123
  /** @description Set of items for requested by query. */
4828
5124
  items: components["schemas"]["PlaceTriggerRow"][];
4829
- /** @description If request contains more data,
5125
+ /**
5126
+ * @description If request contains more data,
4830
5127
  * this is the id is set with which next request should be performed to get next page.
4831
- * If no more data, then it is undefined. */
5128
+ * If no more data, then it is undefined.
5129
+ */
4832
5130
  nextStartInclusive?: components["schemas"]["AtomicActionIdCursor"] | null;
4833
5131
  };
4834
5132
  PlaceTriggerRow: {
@@ -4934,9 +5232,11 @@ export interface components {
4934
5232
  trigger_price: components["schemas"]["PositivePriceMantissa"];
4935
5233
  limits?: components["schemas"]["OrderLimits"] | null;
4936
5234
  };
4937
- /** @description At least one limit to be presented.
5235
+ /**
5236
+ * @description At least one limit to be presented.
4938
5237
  * Logically limit is min value obtained executing.
4939
- * `final_limit = min(base_size, quote_size, price)` */
5238
+ * `final_limit = min(base_size, quote_size, price)`
5239
+ */
4940
5240
  OrderLimits: {
4941
5241
  /**
4942
5242
  * Format: uint64
@@ -5055,17 +5355,21 @@ export interface components {
5055
5355
  le: components["schemas"]["Timestamp"];
5056
5356
  };
5057
5357
  StateDownloadMeta: {
5058
- /** @description Hash of the state file.
5059
- * Used as ETag. */
5358
+ /**
5359
+ * @description Hash of the state file.
5360
+ * Used as ETag.
5361
+ */
5060
5362
  hash: number[];
5061
5363
  /**
5062
5364
  * Format: uri
5063
5365
  * @description Link to download the state file.
5064
5366
  */
5065
5367
  link: string;
5066
- /** @description Version of binary which produced this state snapshot.
5368
+ /**
5369
+ * @description Version of binary which produced this state snapshot.
5067
5370
  * So can decide whether it is compatible with client.
5068
- * todo(repl): After upgrade release make it non-optional. */
5371
+ * todo(repl): After upgrade release make it non-optional.
5372
+ */
5069
5373
  version?: components["schemas"]["BinaryId"] | null;
5070
5374
  };
5071
5375
  BinaryId: string;
@@ -5090,7 +5394,8 @@ export interface components {
5090
5394
  components["schemas"]["ExecutableVersion"]
5091
5395
  ][];
5092
5396
  };
5093
- /** @description Use 1/1_000_000 granularity (ppm)
5397
+ /**
5398
+ * @description Use 1/1_000_000 granularity (ppm)
5094
5399
  *
5095
5400
  * | ppm | decimal | percent |
5096
5401
  * |------|----------|---------|
@@ -5102,7 +5407,8 @@ export interface components {
5102
5407
  * | 500 | 0.0005 | 0.05% |
5103
5408
  * | 1000 | 0.001 | 0.10% |
5104
5409
  * | 5000 | 0.005 | 0.50% |
5105
- * | 10000| 0.01 | 1.00% | */
5410
+ * | 10000| 0.01 | 1.00% |
5411
+ */
5106
5412
  FeeTierConfig: {
5107
5413
  /** Format: uint32 */
5108
5414
  maker_fee_ppm: number;
@@ -5124,9 +5430,11 @@ export interface components {
5124
5430
  PageResult_for_AccountId_and_AccountFeeTier: {
5125
5431
  /** @description Set of items for requested by query. */
5126
5432
  items: components["schemas"]["AccountFeeTier"][];
5127
- /** @description If request contains more data,
5433
+ /**
5434
+ * @description If request contains more data,
5128
5435
  * this is the id is set with which next request should be performed to get next page.
5129
- * If no more data, then it is undefined. */
5436
+ * If no more data, then it is undefined.
5437
+ */
5130
5438
  nextStartInclusive?: components["schemas"]["AccountId"] | null;
5131
5439
  };
5132
5440
  AccountFeeTier: {
@@ -5479,8 +5787,10 @@ export interface components {
5479
5787
  /** Format: double */
5480
5788
  bankruptcyPrice: number;
5481
5789
  };
5482
- /** @description TV config query response
5483
- * https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#data-feed-configuration-data */
5790
+ /**
5791
+ * @description TV config query response
5792
+ * https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#data-feed-configuration-data
5793
+ */
5484
5794
  TvConfigResponse: {
5485
5795
  supported_resolutions: components["schemas"]["Resolution"][];
5486
5796
  supports_group_request: boolean;
@@ -5535,13 +5845,15 @@ export interface components {
5535
5845
  ticker: string;
5536
5846
  type: string;
5537
5847
  };
5538
- /** @description History query
5848
+ /**
5849
+ * @description History query
5539
5850
  * https://www.tradingview.com/charting-library-docs/latest/connecting_data/UDF/#bars
5540
5851
  *
5541
5852
  * # Extension:
5542
5853
  * Accepts either:
5543
5854
  * * `market_id` - raw market identifier
5544
- * * `symbol` - market symbol from original spec, picks first market which matches it */
5855
+ * * `symbol` - market symbol from original spec, picks first market which matches it
5856
+ */
5545
5857
  TvHistoryQuery: {
5546
5858
  market_id?: number | null;
5547
5859
  symbol?: string | null;
@@ -5575,8 +5887,10 @@ export interface components {
5575
5887
  ok: {
5576
5888
  d: components["schemas"]["TvQuotesItem"][];
5577
5889
  };
5578
- /** @description Quotes entry,
5579
- * see https://www.tradingview.com/charting-library-docs/latest/api/modules/Datafeed/#quotedata */
5890
+ /**
5891
+ * @description Quotes entry,
5892
+ * see https://www.tradingview.com/charting-library-docs/latest/api/modules/Datafeed/#quotedata
5893
+ */
5580
5894
  TvQuotesItem: {
5581
5895
  n: string;
5582
5896
  v: components["schemas"]["TvQuotesValues"];
@@ -5588,9 +5902,11 @@ export interface components {
5588
5902
  /** @constant */
5589
5903
  s: "error";
5590
5904
  };
5591
- /** @description Datafeed quote values,
5905
+ /**
5906
+ * @description Datafeed quote values,
5592
5907
  * see https://www.tradingview.com/charting-library-docs/latest/api/interfaces/Datafeed.DatafeedQuoteValues/ for details
5593
- * Field renames are due to spec */
5908
+ * Field renames are due to spec
5909
+ */
5594
5910
  TvQuotesValues: {
5595
5911
  /**
5596
5912
  * Format: double
@@ -5754,14 +6070,26 @@ export interface components {
5754
6070
  /** Format: uint64 */
5755
6071
  update_id: number;
5756
6072
  account_id: components["schemas"]["AccountId"];
5757
- fills: Record<string, never>;
5758
- places: Record<string, never>;
5759
- cancels: Record<string, never>;
6073
+ fills: {
6074
+ [key: string]: components["schemas"]["FillUpdate"];
6075
+ };
6076
+ places: {
6077
+ [key: string]: components["schemas"]["OrderUpdate"];
6078
+ };
6079
+ cancels: {
6080
+ [key: string]: components["schemas"]["OrderUpdate"];
6081
+ };
5760
6082
  /** @description Reduce orders: fully cancelled or partially cancelled (shrunk in-place). */
5761
- reduced_orders?: Record<string, never>;
6083
+ reduced_orders?: {
6084
+ [key: string]: components["schemas"]["OrderUpdate"];
6085
+ };
5762
6086
  /** @description Maker orders removed by self-trade prevention. */
5763
- self_trade_cancels?: Record<string, never>;
5764
- balances: Record<string, never>;
6087
+ self_trade_cancels?: {
6088
+ [key: string]: components["schemas"]["OrderUpdate"];
6089
+ };
6090
+ balances: {
6091
+ [key: string]: number;
6092
+ };
5765
6093
  };
5766
6094
  FillUpdate: {
5767
6095
  /**
@@ -5770,8 +6098,10 @@ export interface components {
5770
6098
  */
5771
6099
  action_id: number;
5772
6100
  physical_time: string;
5773
- /** @description All trade ids folded into this update. Account fills are keyed by order id,
5774
- * so a websocket batch may coalesce multiple fills for the same order. */
6101
+ /**
6102
+ * @description All trade ids folded into this update. Account fills are keyed by order id,
6103
+ * so a websocket batch may coalesce multiple fills for the same order.
6104
+ */
5775
6105
  trade_ids: number[];
5776
6106
  side: components["schemas"]["Side"];
5777
6107
  /** Format: double */
@@ -5790,10 +6120,12 @@ export interface components {
5790
6120
  sender_tracking_id?: string | null;
5791
6121
  /** @description Maker order's client_order_id (cloid of the resting order being filled). */
5792
6122
  client_order_id?: string | null;
5793
- /** @description Taker order client_order_ids for the trades folded into this update.
6123
+ /**
6124
+ * @description Taker order client_order_ids for the trades folded into this update.
5794
6125
  * Account fills are keyed by maker order id, so a websocket batch may
5795
6126
  * coalesce trades taken by different takers; this collects each taker's
5796
- * cloid. Empty when no taker in this update supplied a cloid. */
6127
+ * cloid. Empty when no taker in this update supplied a cloid.
6128
+ */
5797
6129
  taker_client_order_id?: string[];
5798
6130
  };
5799
6131
  OrderUpdate: {
@@ -5895,14 +6227,16 @@ export interface components {
5895
6227
  };
5896
6228
  /** @enum {string} */
5897
6229
  SelfTradePrevention: "expireMaker";
5898
- /** @description Placement intent requested by an atomic subaction.
6230
+ /**
6231
+ * @description Placement intent requested by an atomic subaction.
5899
6232
  *
5900
6233
  * This is auth input, not the resolved permission. `authorize_placement` turns
5901
6234
  * it into `PlacementPermit { target_account_id, authority }`.
5902
6235
  *
5903
6236
  * This makes delegation explicit: atomic execution should not guess whether a
5904
6237
  * subaction is normal account placement, vault placement, or liquidation from
5905
- * account ids/fallbacks. */
6238
+ * account ids/fallbacks.
6239
+ */
5906
6240
  PlacementRequest: "accountOwner" | {
5907
6241
  vault: components["schemas"]["VaultId"];
5908
6242
  } | {