wapi-client 0.4.1 → 0.5.1

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 (238) hide show
  1. package/dist/api/auth/auth.enums.d.ts +4 -4
  2. package/dist/api/base-client.d.ts +354 -335
  3. package/dist/api/connection/connection.enums.d.ts +19 -7
  4. package/dist/api/http-client.d.ts +15 -0
  5. package/dist/api/index.d.ts +22 -16
  6. package/dist/api/jsonrpc/jsonrpc.enums.d.ts +53 -25
  7. package/dist/api/ws-client.d.ts +26 -25
  8. package/dist/client.d.ts +1725 -1714
  9. package/dist/db/consts.enums.d.ts +274 -272
  10. package/dist/db/index.d.ts +31 -31
  11. package/dist/db/token/token.enums.d.ts +148 -148
  12. package/dist/db/transfer/transfer.enums.d.ts +236 -236
  13. package/dist/db/transfer-group/transfer-group.enums.d.ts +160 -160
  14. package/dist/db/transfer-log/transfer-log.enums.d.ts +193 -193
  15. package/dist/db/wallet/wallet.enums.d.ts +148 -148
  16. package/dist/db/wallet-token-setting/wallet-token-setting.enums.d.ts +96 -96
  17. package/dist/db/wapi-setting/wapi-setting.enums.d.ts +88 -88
  18. package/dist/fns/aggregate-transfers/aggregate-transfers.d.ts +18 -18
  19. package/dist/fns/aggregate-transfers/aggregate-transfers.enums.d.ts +52 -52
  20. package/dist/fns/aggregate-transfers/aggregate-transfers.guards.d.ts +4 -4
  21. package/dist/fns/create-access-token/create-access-token.d.ts +8 -0
  22. package/dist/fns/create-access-token/create-access-token.enums.d.ts +21 -0
  23. package/dist/fns/create-access-token/create-access-token.guards.d.ts +4 -0
  24. package/dist/fns/create-contract/create-contract.d.ts +8 -8
  25. package/dist/fns/create-contract/create-contract.enums.d.ts +63 -63
  26. package/dist/fns/create-contract/create-contract.guards.d.ts +4 -4
  27. package/dist/fns/create-deposit/create-deposit.d.ts +9 -9
  28. package/dist/fns/create-deposit/create-deposit.enums.d.ts +63 -63
  29. package/dist/fns/create-deposit/create-deposit.guards.d.ts +4 -4
  30. package/dist/fns/create-exchange/create-exchange.d.ts +10 -10
  31. package/dist/fns/create-exchange/create-exchange.enums.d.ts +133 -133
  32. package/dist/fns/create-exchange/create-exchange.guards.d.ts +4 -4
  33. package/dist/fns/create-token/create-token.d.ts +9 -9
  34. package/dist/fns/create-token/create-token.enums.d.ts +46 -46
  35. package/dist/fns/create-token/create-token.guards.d.ts +4 -4
  36. package/dist/fns/create-transfer/create-transfer.d.ts +11 -11
  37. package/dist/fns/create-transfer/create-transfer.enums.d.ts +145 -145
  38. package/dist/fns/create-transfer/create-transfer.guards.d.ts +4 -4
  39. package/dist/fns/create-transfer-group/create-transfer-group.d.ts +12 -12
  40. package/dist/fns/create-transfer-group/create-transfer-group.enums.d.ts +142 -142
  41. package/dist/fns/create-transfer-group/create-transfer-group.guards.d.ts +4 -4
  42. package/dist/fns/create-transfers/create-transfers.d.ts +10 -10
  43. package/dist/fns/create-transfers/create-transfers.enums.d.ts +19 -19
  44. package/dist/fns/create-transfers/create-transfers.guards.d.ts +4 -4
  45. package/dist/fns/create-wallet/create-wallet.d.ts +9 -9
  46. package/dist/fns/create-wallet/create-wallet.enums.d.ts +41 -41
  47. package/dist/fns/create-wallet/create-wallet.guards.d.ts +4 -4
  48. package/dist/fns/create-withdrawal/create-withdrawal.d.ts +10 -10
  49. package/dist/fns/create-withdrawal/create-withdrawal.enums.d.ts +63 -63
  50. package/dist/fns/create-withdrawal/create-withdrawal.guards.d.ts +4 -4
  51. package/dist/fns/find-balances/find-balances.d.ts +17 -17
  52. package/dist/fns/find-balances/find-balances.enums.d.ts +30 -30
  53. package/dist/fns/find-balances/find-balances.guards.d.ts +4 -4
  54. package/dist/fns/find-tokens/find-tokens.d.ts +18 -18
  55. package/dist/fns/find-tokens/find-tokens.enums.d.ts +39 -39
  56. package/dist/fns/find-tokens/find-tokens.guards.d.ts +4 -4
  57. package/dist/fns/find-transfer-groups/find-transfer-groups.d.ts +17 -17
  58. package/dist/fns/find-transfer-groups/find-transfer-groups.enums.d.ts +52 -52
  59. package/dist/fns/find-transfer-groups/find-transfer-groups.guards.d.ts +4 -4
  60. package/dist/fns/find-transfers/find-transfers.d.ts +18 -18
  61. package/dist/fns/find-transfers/find-transfers.enums.d.ts +72 -72
  62. package/dist/fns/find-transfers/find-transfers.guards.d.ts +4 -4
  63. package/dist/fns/find-wallets/find-wallets.d.ts +18 -18
  64. package/dist/fns/find-wallets/find-wallets.enums.d.ts +48 -48
  65. package/dist/fns/find-wallets/find-wallets.guards.d.ts +4 -4
  66. package/dist/fns/fn-consts.enums.d.ts +14 -14
  67. package/dist/fns/get-balance/get-balance.d.ts +9 -9
  68. package/dist/fns/get-balance/get-balance.enums.d.ts +30 -30
  69. package/dist/fns/get-balance/get-balance.guards.d.ts +4 -4
  70. package/dist/fns/get-balance-history/get-balance-history.d.ts +9 -9
  71. package/dist/fns/get-balance-history/get-balance-history.enums.d.ts +29 -29
  72. package/dist/fns/get-balance-history/get-balance-history.guards.d.ts +4 -4
  73. package/dist/fns/get-flags/get-flags.d.ts +9 -9
  74. package/dist/fns/get-flags/get-flags.enums.d.ts +17 -17
  75. package/dist/fns/get-flags/get-flags.guards.d.ts +4 -4
  76. package/dist/fns/get-statistics/get-statistics.d.ts +9 -9
  77. package/dist/fns/get-statistics/get-statistics.enums.d.ts +24 -24
  78. package/dist/fns/get-statistics/get-statistics.guards.d.ts +4 -4
  79. package/dist/fns/get-token/get-token.d.ts +9 -9
  80. package/dist/fns/get-token/get-token.enums.d.ts +21 -21
  81. package/dist/fns/get-token/get-token.guards.d.ts +4 -4
  82. package/dist/fns/get-transfer/get-transfer.d.ts +9 -9
  83. package/dist/fns/get-transfer/get-transfer.enums.d.ts +25 -25
  84. package/dist/fns/get-transfer/get-transfer.guards.d.ts +4 -4
  85. package/dist/fns/get-transfer-group/get-transfer-group.d.ts +9 -9
  86. package/dist/fns/get-transfer-group/get-transfer-group.enums.d.ts +25 -25
  87. package/dist/fns/get-transfer-group/get-transfer-group.guards.d.ts +4 -4
  88. package/dist/fns/get-wallet/get-wallet.d.ts +9 -9
  89. package/dist/fns/get-wallet/get-wallet.enums.d.ts +25 -25
  90. package/dist/fns/get-wallet/get-wallet.guards.d.ts +4 -4
  91. package/dist/fns/import-data/import-data.d.ts +11 -11
  92. package/dist/fns/import-data/import-data.enums.d.ts +230 -230
  93. package/dist/fns/import-data/import-data.guards.d.ts +8 -8
  94. package/dist/fns/import-data/import-data.node.d.ts +11 -11
  95. package/dist/fns/index.d.ts +280 -273
  96. package/dist/fns/reverse-transfer/reverse-transfer.d.ts +10 -10
  97. package/dist/fns/reverse-transfer/reverse-transfer.enums.d.ts +48 -48
  98. package/dist/fns/reverse-transfer/reverse-transfer.guards.d.ts +4 -4
  99. package/dist/fns/reverse-transfer-group/reverse-transfer-group.d.ts +10 -10
  100. package/dist/fns/reverse-transfer-group/reverse-transfer-group.enums.d.ts +64 -64
  101. package/dist/fns/reverse-transfer-group/reverse-transfer-group.guards.d.ts +4 -4
  102. package/dist/fns/reverse-transfers/reverse-transfers.d.ts +16 -16
  103. package/dist/fns/reverse-transfers/reverse-transfers.enums.d.ts +55 -55
  104. package/dist/fns/reverse-transfers/reverse-transfers.guards.d.ts +4 -4
  105. package/dist/fns/set-flags/set-flags.d.ts +10 -10
  106. package/dist/fns/set-flags/set-flags.enums.d.ts +21 -21
  107. package/dist/fns/set-flags/set-flags.guards.d.ts +4 -4
  108. package/dist/fns/update-token/update-token.d.ts +8 -8
  109. package/dist/fns/update-token/update-token.enums.d.ts +43 -43
  110. package/dist/fns/update-token/update-token.guards.d.ts +4 -4
  111. package/dist/fns/update-transfer/update-transfer.d.ts +9 -9
  112. package/dist/fns/update-transfer/update-transfer.enums.d.ts +32 -32
  113. package/dist/fns/update-transfer/update-transfer.guards.d.ts +4 -4
  114. package/dist/fns/update-transfer-group/update-transfer-group.d.ts +9 -9
  115. package/dist/fns/update-transfer-group/update-transfer-group.enums.d.ts +46 -46
  116. package/dist/fns/update-transfer-group/update-transfer-group.guards.d.ts +4 -4
  117. package/dist/fns/update-transfer-groups/update-transfer-groups.d.ts +15 -15
  118. package/dist/fns/update-transfer-groups/update-transfer-groups.enums.d.ts +44 -44
  119. package/dist/fns/update-transfer-groups/update-transfer-groups.guards.d.ts +4 -4
  120. package/dist/fns/update-transfers/update-transfers.d.ts +15 -15
  121. package/dist/fns/update-transfers/update-transfers.enums.d.ts +52 -52
  122. package/dist/fns/update-transfers/update-transfers.guards.d.ts +4 -4
  123. package/dist/fns/update-wallet/update-wallet.d.ts +8 -8
  124. package/dist/fns/update-wallet/update-wallet.enums.d.ts +43 -43
  125. package/dist/fns/update-wallet/update-wallet.guards.d.ts +4 -4
  126. package/dist/index.d.ts +80 -73
  127. package/dist/lib/debug.d.ts +1 -1
  128. package/dist/lib/errors.d.ts +317 -310
  129. package/dist/lib/isomorphic/node/get-random-hex.d.ts +1 -1
  130. package/dist/lib/isomorphic/node/streams.d.ts +28 -29
  131. package/dist/lib/isomorphic/node/ws.d.ts +2 -2
  132. package/dist/lib/query-builder.d.ts +252 -252
  133. package/dist/lib/stream-promise-input.d.ts +33 -33
  134. package/dist/lib/stream-promise.d.ts +40 -40
  135. package/dist/lib/utils.d.ts +48 -48
  136. package/dist/lib/validator.d.ts +259 -253
  137. package/dist/txs/aggregate-transfer-many/aggregate-transfer-many.enums.d.ts +64 -64
  138. package/dist/txs/aggregate-transfer-many/aggregate-transfer-many.guards.d.ts +4 -4
  139. package/dist/txs/authentication-check/authentication-check.enums.d.ts +22 -0
  140. package/dist/txs/authentication-check/authentication-check.guards.d.ts +4 -0
  141. package/dist/txs/create-access-token/create-access-token.enums.d.ts +51 -0
  142. package/dist/txs/create-access-token/create-access-token.guards.d.ts +4 -0
  143. package/dist/txs/create-contract/create-contract.enums.d.ts +79 -79
  144. package/dist/txs/create-contract/create-contract.guards.d.ts +4 -4
  145. package/dist/txs/create-deposit/create-deposit.enums.d.ts +19 -19
  146. package/dist/txs/create-deposit/create-deposit.guards.d.ts +4 -4
  147. package/dist/txs/create-distribution/create-distribution.enums.d.ts +107 -104
  148. package/dist/txs/create-distribution/create-distribution.guards.d.ts +4 -4
  149. package/dist/txs/create-token/create-token.enums.d.ts +54 -54
  150. package/dist/txs/create-token/create-token.guards.d.ts +4 -4
  151. package/dist/txs/create-transfer/create-transfer.enums.d.ts +209 -209
  152. package/dist/txs/create-transfer/create-transfer.guards.d.ts +4 -4
  153. package/dist/txs/create-transfer-group/create-transfer-group.enums.d.ts +200 -200
  154. package/dist/txs/create-transfer-group/create-transfer-group.guards.d.ts +4 -4
  155. package/dist/txs/create-transfer-many/create-transfer-many.enums.d.ts +53 -53
  156. package/dist/txs/create-transfer-many/create-transfer-many.guards.d.ts +4 -4
  157. package/dist/txs/create-wallet/create-wallet.enums.d.ts +20 -20
  158. package/dist/txs/create-wallet/create-wallet.guards.d.ts +4 -4
  159. package/dist/txs/create-withdrawal/create-withdrawal.enums.d.ts +19 -19
  160. package/dist/txs/create-withdrawal/create-withdrawal.guards.d.ts +4 -4
  161. package/dist/txs/find-balance-many/find-balance-many.enums.d.ts +97 -97
  162. package/dist/txs/find-balance-many/find-balance-many.guards.d.ts +4 -4
  163. package/dist/txs/find-token-many/find-token-many.enums.d.ts +81 -81
  164. package/dist/txs/find-token-many/find-token-many.guards.d.ts +4 -4
  165. package/dist/txs/find-transfer-group-many/find-transfer-group-many.enums.d.ts +90 -90
  166. package/dist/txs/find-transfer-group-many/find-transfer-group-many.guards.d.ts +4 -4
  167. package/dist/txs/find-transfer-many/find-transfer-many.enums.d.ts +93 -93
  168. package/dist/txs/find-transfer-many/find-transfer-many.guards.d.ts +4 -4
  169. package/dist/txs/find-wallet-many/find-wallet-many.enums.d.ts +181 -179
  170. package/dist/txs/find-wallet-many/find-wallet-many.guards.d.ts +4 -4
  171. package/dist/txs/finish-transaction/finish-transaction.enums.d.ts +33 -29
  172. package/dist/txs/finish-transaction/finish-transaction.guards.d.ts +4 -4
  173. package/dist/txs/get-balance/get-balance.enums.d.ts +107 -107
  174. package/dist/txs/get-balance/get-balance.guards.d.ts +4 -4
  175. package/dist/txs/get-balance-history/get-balance-history.enums.d.ts +188 -188
  176. package/dist/txs/get-balance-history/get-balance-history.guards.d.ts +4 -4
  177. package/dist/txs/get-flags/get-flags.enums.d.ts +19 -19
  178. package/dist/txs/get-flags/get-flags.guards.d.ts +4 -4
  179. package/dist/txs/get-statistics/get-statistics.enums.d.ts +58 -58
  180. package/dist/txs/get-statistics/get-statistics.guards.d.ts +4 -4
  181. package/dist/txs/get-token/get-token.enums.d.ts +114 -114
  182. package/dist/txs/get-token/get-token.guards.d.ts +4 -4
  183. package/dist/txs/get-token-many/get-token-many.enums.d.ts +36 -36
  184. package/dist/txs/get-token-many/get-token-many.guards.d.ts +4 -4
  185. package/dist/txs/get-transfer/get-transfer.enums.d.ts +283 -283
  186. package/dist/txs/get-transfer/get-transfer.guards.d.ts +4 -4
  187. package/dist/txs/get-transfer-group/get-transfer-group.enums.d.ts +121 -121
  188. package/dist/txs/get-transfer-group/get-transfer-group.guards.d.ts +4 -4
  189. package/dist/txs/get-wallet/get-wallet.enums.d.ts +67 -67
  190. package/dist/txs/get-wallet/get-wallet.guards.d.ts +4 -4
  191. package/dist/txs/get-wallet-many/get-wallet-many.enums.d.ts +36 -36
  192. package/dist/txs/get-wallet-many/get-wallet-many.guards.d.ts +4 -4
  193. package/dist/txs/import-actions/import-actions.enums.d.ts +179 -206
  194. package/dist/txs/import-actions/import-actions.guards.d.ts +8 -8
  195. package/dist/txs/index.d.ts +271 -259
  196. package/dist/txs/query/query.enums.d.ts +30 -30
  197. package/dist/txs/query/query.guards.d.ts +4 -4
  198. package/dist/txs/query-logs/query-logs.enums.d.ts +54 -50
  199. package/dist/txs/query-logs/query-logs.guards.d.ts +4 -4
  200. package/dist/txs/reset-database/reset-database.enums.d.ts +34 -34
  201. package/dist/txs/reset-database/reset-database.guards.d.ts +4 -4
  202. package/dist/txs/reverse-transfer/reverse-transfer.enums.d.ts +72 -72
  203. package/dist/txs/reverse-transfer/reverse-transfer.guards.d.ts +4 -4
  204. package/dist/txs/reverse-transfer-group/reverse-transfer-group.enums.d.ts +95 -95
  205. package/dist/txs/reverse-transfer-group/reverse-transfer-group.guards.d.ts +4 -4
  206. package/dist/txs/reverse-transfer-group-many/reverse-transfer-group-many.enums.d.ts +77 -77
  207. package/dist/txs/reverse-transfer-group-many/reverse-transfer-group-many.guards.d.ts +4 -4
  208. package/dist/txs/reverse-transfer-many/reverse-transfer-many.enums.d.ts +58 -58
  209. package/dist/txs/reverse-transfer-many/reverse-transfer-many.guards.d.ts +4 -4
  210. package/dist/txs/set-flags/set-flags.enums.d.ts +24 -24
  211. package/dist/txs/set-flags/set-flags.guards.d.ts +4 -4
  212. package/dist/txs/start-transaction/start-transaction.enums.d.ts +18 -18
  213. package/dist/txs/start-transaction/start-transaction.guards.d.ts +4 -4
  214. package/dist/txs/tx-consts.enums.d.ts +236 -236
  215. package/dist/txs/update-token/update-token.enums.d.ts +51 -51
  216. package/dist/txs/update-token/update-token.guards.d.ts +4 -4
  217. package/dist/txs/update-transfer/update-transfer.enums.d.ts +78 -78
  218. package/dist/txs/update-transfer/update-transfer.guards.d.ts +4 -4
  219. package/dist/txs/update-transfer-group/update-transfer-group.enums.d.ts +91 -91
  220. package/dist/txs/update-transfer-group/update-transfer-group.guards.d.ts +4 -4
  221. package/dist/txs/update-transfer-group-many/update-transfer-group-many.enums.d.ts +40 -40
  222. package/dist/txs/update-transfer-group-many/update-transfer-group-many.guards.d.ts +4 -4
  223. package/dist/txs/update-transfer-many/update-transfer-many.enums.d.ts +36 -36
  224. package/dist/txs/update-transfer-many/update-transfer-many.guards.d.ts +4 -4
  225. package/dist/txs/update-wallet/update-wallet.enums.d.ts +54 -54
  226. package/dist/txs/update-wallet/update-wallet.guards.d.ts +4 -4
  227. package/dist/wapi-client.cjs.development.js +30183 -21451
  228. package/dist/wapi-client.cjs.js +17 -7
  229. package/package.json +9 -5
  230. package/dist/fns/import-data/import-data.web.d.ts +0 -11
  231. package/dist/lib/isomorphic/web/get-random-hex.d.ts +0 -1
  232. package/dist/lib/isomorphic/web/streams.d.ts +0 -26
  233. package/dist/lib/isomorphic/web/ws.d.ts +0 -18
  234. package/dist/wapi-client.cjs.development.js.map +0 -1
  235. package/dist/wapi-client.cjs.production.js +0 -2
  236. package/dist/wapi-client.cjs.production.js.map +0 -1
  237. package/dist/wapi-client.esm.js +0 -21329
  238. package/dist/wapi-client.esm.js.map +0 -1
@@ -1,236 +1,236 @@
1
- /**
2
- * Generic flags for input
3
- */
4
- export interface ITxGeneralOptionsWithoutTx {
5
- /**
6
- * User provided id added to logs for debugging
7
- */
8
- tracking_id?: string;
9
- }
10
- /**
11
- * Generic flags for input
12
- */
13
- export interface ITxGeneralOptions {
14
- /**
15
- * Id of the transaction context to run the query in
16
- */
17
- transaction_id?: string;
18
- /**
19
- * User provided id added to logs for debugging
20
- */
21
- tracking_id?: string;
22
- }
23
- /**
24
- * Metadata flags for input
25
- */
26
- export interface ITxMetadataOptions {
27
- /**
28
- * Return the total rows count in metadata
29
- */
30
- return_metadata_total?: boolean;
31
- }
32
- /**
33
- * Optional flags for input limiting
34
- */
35
- export interface ITxLimitingOptions {
36
- /**
37
- * Number of records to return
38
- */
39
- limit?: number;
40
- /**
41
- * Number of records to omit from the beginning
42
- */
43
- offset?: number;
44
- }
45
- /**
46
- * Optional flags for input ordering
47
- */
48
- export interface ITxOrderingOptions {
49
- /**
50
- * Ordering options
51
- */
52
- order?: ITxOrderingInput[];
53
- }
54
- /**
55
- * Optional flags to limit search result
56
- */
57
- export interface ITxSelectOptions {
58
- /**
59
- * Select options
60
- */
61
- select?: string[];
62
- }
63
- /**
64
- * Optional flag to remove field from select
65
- */
66
- export interface ITxDeselectOptions {
67
- /**
68
- * Deselect options
69
- */
70
- deselect?: string[];
71
- }
72
- /**
73
- * Optional flags to aggregate data
74
- */
75
- export interface ITxAggregatingOptions {
76
- aggregator?: ITxAggregator;
77
- aggregators?: ITxAggregator[];
78
- groups?: ITxGroups;
79
- }
80
- /**
81
- * Metadata about the search
82
- */
83
- export interface ITxFindMetadata {
84
- /**
85
- * Total number of records matching the query
86
- */
87
- total?: number;
88
- /**
89
- * Current query offset
90
- */
91
- offset: number;
92
- /**
93
- * Current query limit
94
- */
95
- limit: number;
96
- /**
97
- * Boolean showing if there would be more rows to return with a higher offset/limit
98
- */
99
- more_rows: boolean;
100
- /**
101
- * Ordering options
102
- */
103
- order?: ITxOrderingInput[];
104
- }
105
- /**
106
- * Metadata about the aggregation
107
- */
108
- export interface ITxAggregatingMetadata {
109
- aggregators: ITxAggregator[];
110
- groups?: ITxGroups;
111
- }
112
- /**
113
- * Input for orderBy
114
- */
115
- export interface ITxOrderingInput {
116
- /**
117
- * Field to order by
118
- */
119
- field: string;
120
- /**
121
- * Direction to order
122
- */
123
- direction?: 'asc' | 'desc';
124
- /**
125
- * Should nulls be first or last
126
- */
127
- nulls?: 'first' | 'last';
128
- }
129
- export declare type ITxGroup = ITxGroupPeriod | ITxGroupField | ITxGroupMetadataField;
130
- export declare type ITxGroups = ITxGroup[];
131
- export interface ITxGroupPeriod {
132
- type: 'period';
133
- field: ITxPeriod;
134
- alias?: string;
135
- }
136
- export interface ITxGroupField {
137
- type: 'field';
138
- field: string;
139
- alias?: string;
140
- }
141
- export interface ITxGroupMetadataField {
142
- type: 'metadata_field';
143
- field: string;
144
- alias?: string;
145
- }
146
- export declare type ITxPeriod = ITxPeriodSimple | ITxPeriodTimezone;
147
- /**
148
- * Time period rows should be grouped by
149
- */
150
- export declare type ITxPeriodSimple = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
151
- /**
152
- * Time period rows should be grouped by
153
- */
154
- export interface ITxPeriodTimezone {
155
- period: ITxPeriodSimple;
156
- timezone: string;
157
- }
158
- export interface ITxTimeFilter {
159
- start_time?: string;
160
- end_time?: string;
161
- }
162
- /**
163
- * Aggregator description
164
- */
165
- export declare type ITxAggregator = ITxAggregatorSimple | ITxAggregatorComplex;
166
- /**
167
- * Function to use for grouping
168
- */
169
- export declare type ITxAggregatorSimple = 'count' | 'countDistinct' | 'sum' | 'average' | 'min' | 'max';
170
- /**
171
- * Function to use for grouping
172
- */
173
- /**
174
- * Function and field to group
175
- */
176
- export interface ITxAggregatorComplex {
177
- function?: ITxAggregatorSimple;
178
- /**
179
- * Field to group by
180
- */
181
- field?: string;
182
- /**
183
- * Alias to group under
184
- */
185
- alias?: string;
186
- }
187
- export declare type ITxAggregateResults = ITxAggregateResult[];
188
- export interface ITxAggregateResult {
189
- [k: string]: string | number;
190
- }
191
- /**
192
- * Rule for distribution grouping
193
- */
194
- export declare type ITxDistributorLeftoverRule = 'keep' | 'random' | 'largest' | 'target';
195
- /**
196
- * Whether to replace or extend current metadata with new value
197
- */
198
- export declare type ITxMetadataAction = 'replace' | 'extend';
199
- /**
200
- * Whether to replace or extend current metadata with new value
201
- */
202
- export declare type ITxMetadataActionForReverse = 'replace' | 'replace_create_only' | 'replace_cancel_only' | 'extend' | 'extend_create_only' | 'extend_cancel_only';
203
- export declare enum ITxPeriodSimpleEnum {
204
- year = 'year',
205
- month = 'month',
206
- week = 'week',
207
- day = 'day',
208
- hour = 'hour',
209
- minute = 'minute'
210
- }
211
- export declare enum ITxAggregatorSimpleEnum {
212
- count = 'count',
213
- countDistinct = 'countDistinct',
214
- sum = 'sum',
215
- average = 'average',
216
- min = 'min',
217
- max = 'max'
218
- }
219
- export declare enum ITxDistributorLeftoverRuleEnum {
220
- keep = 'keep',
221
- random = 'random',
222
- largest = 'largest',
223
- target = 'target'
224
- }
225
- export declare enum ITxMetadataActionEnum {
226
- replace = 'replace',
227
- extend = 'extend'
228
- }
229
- export declare enum ITxMetadataActionForReverseEnum {
230
- replace = 'replace',
231
- replace_create_only = 'replace_create_only',
232
- replace_cancel_only = 'replace_cancel_only',
233
- extend = 'extend',
234
- extend_create_only = 'extend_create_only',
235
- extend_cancel_only = 'extend_cancel_only'
236
- }
1
+ /**
2
+ * Generic flags for input
3
+ */
4
+ export interface ITxGeneralOptionsWithoutTx {
5
+ /**
6
+ * User provided id added to logs for debugging
7
+ */
8
+ tracking_id?: string;
9
+ }
10
+ /**
11
+ * Generic flags for input
12
+ */
13
+ export interface ITxGeneralOptions {
14
+ /**
15
+ * Id of the transaction context to run the query in
16
+ */
17
+ transaction_id?: string;
18
+ /**
19
+ * User provided id added to logs for debugging
20
+ */
21
+ tracking_id?: string;
22
+ }
23
+ /**
24
+ * Metadata flags for input
25
+ */
26
+ export interface ITxMetadataOptions {
27
+ /**
28
+ * Return the total rows count in metadata
29
+ */
30
+ return_metadata_total?: boolean;
31
+ }
32
+ /**
33
+ * Optional flags for input limiting
34
+ */
35
+ export interface ITxLimitingOptions {
36
+ /**
37
+ * Number of records to return
38
+ */
39
+ limit?: number;
40
+ /**
41
+ * Number of records to omit from the beginning
42
+ */
43
+ offset?: number;
44
+ }
45
+ /**
46
+ * Optional flags for input ordering
47
+ */
48
+ export interface ITxOrderingOptions {
49
+ /**
50
+ * Ordering options
51
+ */
52
+ order?: ITxOrderingInput[];
53
+ }
54
+ /**
55
+ * Optional flags to limit search result
56
+ */
57
+ export interface ITxSelectOptions {
58
+ /**
59
+ * Select options
60
+ */
61
+ select?: string[];
62
+ }
63
+ /**
64
+ * Optional flag to remove field from select
65
+ */
66
+ export interface ITxDeselectOptions {
67
+ /**
68
+ * Deselect options
69
+ */
70
+ deselect?: string[];
71
+ }
72
+ /**
73
+ * Optional flags to aggregate data
74
+ */
75
+ export interface ITxAggregatingOptions {
76
+ aggregator?: ITxAggregator;
77
+ aggregators?: ITxAggregator[];
78
+ groups?: ITxGroups;
79
+ }
80
+ /**
81
+ * Metadata about the search
82
+ */
83
+ export interface ITxFindMetadata {
84
+ /**
85
+ * Total number of records matching the query
86
+ */
87
+ total?: number;
88
+ /**
89
+ * Current query offset
90
+ */
91
+ offset: number;
92
+ /**
93
+ * Current query limit
94
+ */
95
+ limit: number;
96
+ /**
97
+ * Boolean showing if there would be more rows to return with a higher offset/limit
98
+ */
99
+ more_rows: boolean;
100
+ /**
101
+ * Ordering options
102
+ */
103
+ order?: ITxOrderingInput[];
104
+ }
105
+ /**
106
+ * Metadata about the aggregation
107
+ */
108
+ export interface ITxAggregatingMetadata {
109
+ aggregators: ITxAggregator[];
110
+ groups?: ITxGroups;
111
+ }
112
+ /**
113
+ * Input for orderBy
114
+ */
115
+ export interface ITxOrderingInput {
116
+ /**
117
+ * Field to order by
118
+ */
119
+ field: string;
120
+ /**
121
+ * Direction to order
122
+ */
123
+ direction?: 'asc' | 'desc';
124
+ /**
125
+ * Should nulls be first or last
126
+ */
127
+ nulls?: 'first' | 'last';
128
+ }
129
+ export declare type ITxGroup = ITxGroupPeriod | ITxGroupField | ITxGroupMetadataField;
130
+ export declare type ITxGroups = ITxGroup[];
131
+ export interface ITxGroupPeriod {
132
+ type: 'period';
133
+ field: ITxPeriod;
134
+ alias?: string;
135
+ }
136
+ export interface ITxGroupField {
137
+ type: 'field';
138
+ field: string;
139
+ alias?: string;
140
+ }
141
+ export interface ITxGroupMetadataField {
142
+ type: 'metadata_field';
143
+ field: string;
144
+ alias?: string;
145
+ }
146
+ export declare type ITxPeriod = ITxPeriodSimple | ITxPeriodTimezone;
147
+ /**
148
+ * Time period rows should be grouped by
149
+ */
150
+ export declare type ITxPeriodSimple = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
151
+ /**
152
+ * Time period rows should be grouped by
153
+ */
154
+ export interface ITxPeriodTimezone {
155
+ period: ITxPeriodSimple;
156
+ timezone: string;
157
+ }
158
+ export interface ITxTimeFilter {
159
+ start_time?: string;
160
+ end_time?: string;
161
+ }
162
+ /**
163
+ * Aggregator description
164
+ */
165
+ export declare type ITxAggregator = ITxAggregatorSimple | ITxAggregatorComplex;
166
+ /**
167
+ * Function to use for grouping
168
+ */
169
+ export declare type ITxAggregatorSimple = 'count' | 'countDistinct' | 'sum' | 'average' | 'min' | 'max';
170
+ /**
171
+ * Function to use for grouping
172
+ */
173
+ /**
174
+ * Function and field to group
175
+ */
176
+ export interface ITxAggregatorComplex {
177
+ function?: ITxAggregatorSimple;
178
+ /**
179
+ * Field to group by
180
+ */
181
+ field?: string;
182
+ /**
183
+ * Alias to group under
184
+ */
185
+ alias?: string;
186
+ }
187
+ export declare type ITxAggregateResults = ITxAggregateResult[];
188
+ export interface ITxAggregateResult {
189
+ [k: string]: string | number;
190
+ }
191
+ /**
192
+ * Rule for distribution grouping
193
+ */
194
+ export declare type ITxDistributorLeftoverRule = 'keep' | 'random' | 'largest' | 'target';
195
+ /**
196
+ * Whether to replace or extend current metadata with new value
197
+ */
198
+ export declare type ITxMetadataAction = 'replace' | 'extend';
199
+ /**
200
+ * Whether to replace or extend current metadata with new value
201
+ */
202
+ export declare type ITxMetadataActionForReverse = 'replace' | 'replace_create_only' | 'replace_cancel_only' | 'extend' | 'extend_create_only' | 'extend_cancel_only';
203
+ export declare enum ITxPeriodSimpleEnum {
204
+ year = 'year',
205
+ month = 'month',
206
+ week = 'week',
207
+ day = 'day',
208
+ hour = 'hour',
209
+ minute = 'minute'
210
+ }
211
+ export declare enum ITxAggregatorSimpleEnum {
212
+ count = 'count',
213
+ countDistinct = 'countDistinct',
214
+ sum = 'sum',
215
+ average = 'average',
216
+ min = 'min',
217
+ max = 'max'
218
+ }
219
+ export declare enum ITxDistributorLeftoverRuleEnum {
220
+ keep = 'keep',
221
+ random = 'random',
222
+ largest = 'largest',
223
+ target = 'target'
224
+ }
225
+ export declare enum ITxMetadataActionEnum {
226
+ replace = 'replace',
227
+ extend = 'extend'
228
+ }
229
+ export declare enum ITxMetadataActionForReverseEnum {
230
+ replace = 'replace',
231
+ replace_create_only = 'replace_create_only',
232
+ replace_cancel_only = 'replace_cancel_only',
233
+ extend = 'extend',
234
+ extend_create_only = 'extend_create_only',
235
+ extend_cancel_only = 'extend_cancel_only'
236
+ }
@@ -1,51 +1,51 @@
1
- import { UniqueTokenFilter } from '../get-token/get-token.enums';
2
- import { ITxGeneralOptions } from '../tx-consts.enums';
3
- import { TokenTable } from '../../db';
4
- export declare type UpdateTokenTxOptions = ITxGeneralOptions & UpdateTokenAdditionalOptions;
5
- /**
6
- * Optional flags for input
7
- */
8
- export interface UpdateTokenAdditionalOptions {
9
- /**
10
- * Whether the request should return the token object even if it was not updated
11
- */
12
- return_when_not_updated?: boolean;
13
- }
14
- export interface UpdateTokenFields {
15
- /**
16
- * Key/value object describing the token
17
- */
18
- metadata?: {
19
- [k: string]: any;
20
- } | null;
21
- /**
22
- * Boolean indicating if token can be traded with outside seed wallet
23
- */
24
- public?: boolean;
25
- /**
26
- * Current status for the token
27
- */
28
- status?: 'active' | 'dw-only' | 'disabled';
29
- }
30
- /**
31
- * Input for updateToken
32
- *
33
- * @category Input
34
- */
35
- export interface UpdateTokenTxInput {
36
- token: UniqueTokenFilter;
37
- update?: UpdateTokenFields;
38
- options?: UpdateTokenTxOptions;
39
- }
40
- /**
41
- * Output of updateToken
42
- *
43
- * @category Output
44
- */
45
- export interface UpdateTokenTxOutput {
46
- token?: TokenTable;
47
- /**
48
- * Boolean showing if the token was updated
49
- */
50
- updated?: boolean;
51
- }
1
+ import { UniqueTokenFilter } from '../get-token/get-token.enums';
2
+ import { ITxGeneralOptions } from '../tx-consts.enums';
3
+ import { TokenTable } from '../../db';
4
+ /**
5
+ * Optional flags for input
6
+ */
7
+ export interface UpdateTokenAdditionalOptions {
8
+ /**
9
+ * Whether the request should return the token object even if it was not updated
10
+ */
11
+ return_when_not_updated?: boolean;
12
+ }
13
+ export interface UpdateTokenFields {
14
+ /**
15
+ * Key/value object describing the token
16
+ */
17
+ metadata?: {
18
+ [k: string]: unknown;
19
+ } | null;
20
+ /**
21
+ * Boolean indicating if token can be traded with outside seed wallet
22
+ */
23
+ public?: boolean;
24
+ /**
25
+ * Current status for the token
26
+ */
27
+ status?: 'active' | 'dw-only' | 'disabled';
28
+ }
29
+ export declare type UpdateTokenTxOptions = ITxGeneralOptions & UpdateTokenAdditionalOptions;
30
+ /**
31
+ * Input for updateToken
32
+ *
33
+ * @category Input
34
+ */
35
+ export interface UpdateTokenTxInput {
36
+ token: UniqueTokenFilter;
37
+ update?: UpdateTokenFields;
38
+ options?: UpdateTokenTxOptions;
39
+ }
40
+ /**
41
+ * Output of updateToken
42
+ *
43
+ * @category Output
44
+ */
45
+ export interface UpdateTokenTxOutput {
46
+ /**
47
+ * Boolean showing if the token was updated
48
+ */
49
+ updated?: boolean;
50
+ token?: TokenTable;
51
+ }
@@ -1,4 +1,4 @@
1
- import { UpdateTokenTxInput } from './update-token.enums';
2
- export declare function isUpdateTokenTxInput(input: unknown): input is UpdateTokenTxInput;
3
- import { UpdateTokenTxOutput } from './update-token.enums';
4
- export declare function isUpdateTokenTxOutput(input: unknown): input is UpdateTokenTxOutput;
1
+ import { UpdateTokenTxInput } from './update-token.enums';
2
+ export declare function isUpdateTokenTxInput(input: unknown): input is UpdateTokenTxInput;
3
+ import { UpdateTokenTxOutput } from './update-token.enums';
4
+ export declare function isUpdateTokenTxOutput(input: unknown): input is UpdateTokenTxOutput;