@t-0/provider-sdk 1.0.19 → 1.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,719 @@
1
+ import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
2
+ import type { PaymentMethod } from "../common/payment_method_pb";
3
+ import type { Decimal } from "../common/common_pb";
4
+ import type { Timestamp } from "@bufbuild/protobuf/wkt";
5
+ import type { Message } from "@bufbuild/protobuf";
6
+ /**
7
+ * Describes the file network/provider.proto.
8
+ */
9
+ export declare const file_network_provider: GenFile;
10
+ /**
11
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest
12
+ */
13
+ export type AppendLedgerEntriesRequest = Message<"network.v1.provider.AppendLedgerEntriesRequest"> & {
14
+ /**
15
+ * *
16
+ * This is a list of transactions that were appended to the ledger of the provider.
17
+ * The transaction_id should be used to identify the transaction and ensure that it is processed only once.
18
+ *
19
+ * @generated from field: repeated network.v1.provider.AppendLedgerEntriesRequest.Transaction transactions = 20;
20
+ */
21
+ transactions: AppendLedgerEntriesRequest_Transaction[];
22
+ };
23
+ /**
24
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.
25
+ * Use `create(AppendLedgerEntriesRequestSchema)` to create a new message.
26
+ */
27
+ export declare const AppendLedgerEntriesRequestSchema: GenMessage<AppendLedgerEntriesRequest>;
28
+ /**
29
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.Transaction
30
+ */
31
+ export type AppendLedgerEntriesRequest_Transaction = Message<"network.v1.provider.AppendLedgerEntriesRequest.Transaction"> & {
32
+ /**
33
+ * *
34
+ * transaction_id is an incrementally growing identifier for the transaction.
35
+ * It could have gaps and could be out of order, but it is unique for each transaction.
36
+ *
37
+ * @generated from field: uint64 transaction_id = 10;
38
+ */
39
+ transactionId: bigint;
40
+ /**
41
+ * *
42
+ * entries is a list of ledger entries that were appended to the ledger of the provider.
43
+ * Each entry represents a financial event that occurred in the provider's accounts.
44
+ *
45
+ * @generated from field: repeated network.v1.provider.AppendLedgerEntriesRequest.LedgerEntry entries = 30;
46
+ */
47
+ entries: AppendLedgerEntriesRequest_LedgerEntry[];
48
+ /**
49
+ * *
50
+ * transaction_details is a oneof field that contains details about the transaction.
51
+ * It can be one of the following: PayIn, PayoutReservation, Payout, ProviderSettlement, FeeSettlement, PayoutReservationRelease.
52
+ *
53
+ * @generated from oneof network.v1.provider.AppendLedgerEntriesRequest.Transaction.transaction_details
54
+ */
55
+ transactionDetails: {
56
+ /**
57
+ * @generated from field: network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayIn pay_in = 110;
58
+ */
59
+ value: AppendLedgerEntriesRequest_Transaction_PayIn;
60
+ case: "payIn";
61
+ } | {
62
+ /**
63
+ * @generated from field: network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservation payout_reservation = 120;
64
+ */
65
+ value: AppendLedgerEntriesRequest_Transaction_PayoutReservation;
66
+ case: "payoutReservation";
67
+ } | {
68
+ /**
69
+ * @generated from field: network.v1.provider.AppendLedgerEntriesRequest.Transaction.Payout payout = 130;
70
+ */
71
+ value: AppendLedgerEntriesRequest_Transaction_Payout;
72
+ case: "payout";
73
+ } | {
74
+ /**
75
+ * @generated from field: network.v1.provider.AppendLedgerEntriesRequest.Transaction.ProviderSettlement provider_settlement = 140;
76
+ */
77
+ value: AppendLedgerEntriesRequest_Transaction_ProviderSettlement;
78
+ case: "providerSettlement";
79
+ } | {
80
+ /**
81
+ * @generated from field: network.v1.provider.AppendLedgerEntriesRequest.Transaction.FeeSettlement fee_settlement = 150;
82
+ */
83
+ value: AppendLedgerEntriesRequest_Transaction_FeeSettlement;
84
+ case: "feeSettlement";
85
+ } | {
86
+ /**
87
+ * @generated from field: network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservationRelease payout_reservation_release = 160;
88
+ */
89
+ value: AppendLedgerEntriesRequest_Transaction_PayoutReservationRelease;
90
+ case: "payoutReservationRelease";
91
+ } | {
92
+ case: undefined;
93
+ value?: undefined;
94
+ };
95
+ };
96
+ /**
97
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.Transaction.
98
+ * Use `create(AppendLedgerEntriesRequest_TransactionSchema)` to create a new message.
99
+ */
100
+ export declare const AppendLedgerEntriesRequest_TransactionSchema: GenMessage<AppendLedgerEntriesRequest_Transaction>;
101
+ /**
102
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayIn
103
+ */
104
+ export type AppendLedgerEntriesRequest_Transaction_PayIn = Message<"network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayIn"> & {
105
+ /**
106
+ * TODO: should we include details in the transaction?
107
+ *
108
+ * @generated from field: uint64 payment_id = 10;
109
+ */
110
+ paymentId: bigint;
111
+ };
112
+ /**
113
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayIn.
114
+ * Use `create(AppendLedgerEntriesRequest_Transaction_PayInSchema)` to create a new message.
115
+ */
116
+ export declare const AppendLedgerEntriesRequest_Transaction_PayInSchema: GenMessage<AppendLedgerEntriesRequest_Transaction_PayIn>;
117
+ /**
118
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservation
119
+ */
120
+ export type AppendLedgerEntriesRequest_Transaction_PayoutReservation = Message<"network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservation"> & {
121
+ /**
122
+ * @generated from field: uint64 payment_id = 10;
123
+ */
124
+ paymentId: bigint;
125
+ };
126
+ /**
127
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservation.
128
+ * Use `create(AppendLedgerEntriesRequest_Transaction_PayoutReservationSchema)` to create a new message.
129
+ */
130
+ export declare const AppendLedgerEntriesRequest_Transaction_PayoutReservationSchema: GenMessage<AppendLedgerEntriesRequest_Transaction_PayoutReservation>;
131
+ /**
132
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.Transaction.Payout
133
+ */
134
+ export type AppendLedgerEntriesRequest_Transaction_Payout = Message<"network.v1.provider.AppendLedgerEntriesRequest.Transaction.Payout"> & {
135
+ /**
136
+ * @generated from field: uint64 payment_id = 10;
137
+ */
138
+ paymentId: bigint;
139
+ };
140
+ /**
141
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.Transaction.Payout.
142
+ * Use `create(AppendLedgerEntriesRequest_Transaction_PayoutSchema)` to create a new message.
143
+ */
144
+ export declare const AppendLedgerEntriesRequest_Transaction_PayoutSchema: GenMessage<AppendLedgerEntriesRequest_Transaction_Payout>;
145
+ /**
146
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.Transaction.ProviderSettlement
147
+ */
148
+ export type AppendLedgerEntriesRequest_Transaction_ProviderSettlement = Message<"network.v1.provider.AppendLedgerEntriesRequest.Transaction.ProviderSettlement"> & {
149
+ /**
150
+ * @generated from field: uint64 settlement_id = 10;
151
+ */
152
+ settlementId: bigint;
153
+ };
154
+ /**
155
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.Transaction.ProviderSettlement.
156
+ * Use `create(AppendLedgerEntriesRequest_Transaction_ProviderSettlementSchema)` to create a new message.
157
+ */
158
+ export declare const AppendLedgerEntriesRequest_Transaction_ProviderSettlementSchema: GenMessage<AppendLedgerEntriesRequest_Transaction_ProviderSettlement>;
159
+ /**
160
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.Transaction.FeeSettlement
161
+ */
162
+ export type AppendLedgerEntriesRequest_Transaction_FeeSettlement = Message<"network.v1.provider.AppendLedgerEntriesRequest.Transaction.FeeSettlement"> & {
163
+ /**
164
+ * @generated from field: uint64 fee_settlement_id = 10;
165
+ */
166
+ feeSettlementId: bigint;
167
+ };
168
+ /**
169
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.Transaction.FeeSettlement.
170
+ * Use `create(AppendLedgerEntriesRequest_Transaction_FeeSettlementSchema)` to create a new message.
171
+ */
172
+ export declare const AppendLedgerEntriesRequest_Transaction_FeeSettlementSchema: GenMessage<AppendLedgerEntriesRequest_Transaction_FeeSettlement>;
173
+ /**
174
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservationRelease
175
+ */
176
+ export type AppendLedgerEntriesRequest_Transaction_PayoutReservationRelease = Message<"network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservationRelease"> & {
177
+ /**
178
+ * @generated from field: uint64 payment_id = 10;
179
+ */
180
+ paymentId: bigint;
181
+ };
182
+ /**
183
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.Transaction.PayoutReservationRelease.
184
+ * Use `create(AppendLedgerEntriesRequest_Transaction_PayoutReservationReleaseSchema)` to create a new message.
185
+ */
186
+ export declare const AppendLedgerEntriesRequest_Transaction_PayoutReservationReleaseSchema: GenMessage<AppendLedgerEntriesRequest_Transaction_PayoutReservationRelease>;
187
+ /**
188
+ * @generated from message network.v1.provider.AppendLedgerEntriesRequest.LedgerEntry
189
+ */
190
+ export type AppendLedgerEntriesRequest_LedgerEntry = Message<"network.v1.provider.AppendLedgerEntriesRequest.LedgerEntry"> & {
191
+ /**
192
+ * 1 is network account, others are ids of participants
193
+ *
194
+ * @generated from field: uint32 account_owner_id = 10;
195
+ */
196
+ accountOwnerId: number;
197
+ /**
198
+ * *
199
+ * account_type is the type of the account that the entry belongs to.
200
+ * It is used to categorize the entries and understand the nature of the financial event.
201
+ *
202
+ * @generated from field: network.v1.provider.AppendLedgerEntriesRequest.AccountType account_type = 20;
203
+ */
204
+ accountType: AppendLedgerEntriesRequest_AccountType;
205
+ /**
206
+ * *
207
+ * It is the currency of the entry. If the transaction contains entries with multiple currencies, the exchange_rate
208
+ * field should be provided to be used to convert the amounts to USD.
209
+ *
210
+ * @generated from field: string currency = 30;
211
+ */
212
+ currency: string;
213
+ /**
214
+ * *
215
+ * debit is the amount that was debited from the account.
216
+ * If the entry is a credit, this field should be 0.
217
+ *
218
+ * @generated from field: tzero.v1.common.Decimal debit = 40;
219
+ */
220
+ debit?: Decimal;
221
+ /**
222
+ * *
223
+ * credit is the amount that was credited to the account.
224
+ * If the entry is a debit, this field should be 0.
225
+ *
226
+ * @generated from field: tzero.v1.common.Decimal credit = 50;
227
+ */
228
+ credit?: Decimal;
229
+ /**
230
+ * *
231
+ * exchange_rate is the exchange rate of the currency to USD if the currency is not USD and the transaction contains
232
+ * entries with multiple currencies. Exchange rate for the base currency USD and the quote currency provided in the entry.
233
+ *
234
+ * @generated from field: tzero.v1.common.Decimal exchange_rate = 60;
235
+ */
236
+ exchangeRate?: Decimal;
237
+ };
238
+ /**
239
+ * Describes the message network.v1.provider.AppendLedgerEntriesRequest.LedgerEntry.
240
+ * Use `create(AppendLedgerEntriesRequest_LedgerEntrySchema)` to create a new message.
241
+ */
242
+ export declare const AppendLedgerEntriesRequest_LedgerEntrySchema: GenMessage<AppendLedgerEntriesRequest_LedgerEntry>;
243
+ /**
244
+ * @generated from enum network.v1.provider.AppendLedgerEntriesRequest.AccountType
245
+ */
246
+ export declare enum AppendLedgerEntriesRequest_AccountType {
247
+ /**
248
+ * @generated from enum value: ACCOUNT_TYPE_UNSPECIFIED = 0;
249
+ */
250
+ UNSPECIFIED = 0,
251
+ /**
252
+ * Reflects the user's payable balance, the amount that the provider owes to the user.
253
+ *
254
+ * @generated from enum value: ACCOUNT_TYPE_USER_PAYABLE = 1;
255
+ */
256
+ USER_PAYABLE = 1,
257
+ /**
258
+ * Reflects the cash balance of the provider.
259
+ *
260
+ * @generated from enum value: ACCOUNT_TYPE_CASH = 2;
261
+ */
262
+ CASH = 2,
263
+ /**
264
+ * This is the reserve account of the provider, which reflects the reserve of balance to reduce the limit available from one provider to another.
265
+ *
266
+ * @generated from enum value: ACCOUNT_TYPE_RESERVE = 3;
267
+ */
268
+ RESERVE = 3,
269
+ /**
270
+ * This is the mirror account for the reserve. To keep the double entry accounting principle.
271
+ *
272
+ * @generated from enum value: ACCOUNT_TYPE_RESERVE_USAGE = 4;
273
+ */
274
+ RESERVE_USAGE = 4,
275
+ /**
276
+ * Reflects how much the provider owes to the network or other participants.
277
+ *
278
+ * @generated from enum value: ACCOUNT_TYPE_PROVIDER_PAYABLE = 5;
279
+ */
280
+ PROVIDER_PAYABLE = 5,
281
+ /**
282
+ * Reflects how much the provider is owed by the network or other participants.
283
+ *
284
+ * @generated from enum value: ACCOUNT_TYPE_PROVIDER_RECEIVABLE = 6;
285
+ */
286
+ PROVIDER_RECEIVABLE = 6,
287
+ /**
288
+ * Reflects the fees that the provider owes to the network.
289
+ *
290
+ * @generated from enum value: ACCOUNT_TYPE_FEE_PAYABLE = 7;
291
+ */
292
+ FEE_PAYABLE = 7,
293
+ /**
294
+ * Reflects the fees that the network is owed by the provider.
295
+ *
296
+ * @generated from enum value: ACCOUNT_TYPE_FEE_RECEIVABLE = 8;
297
+ */
298
+ FEE_RECEIVABLE = 8,
299
+ /**
300
+ * Reflects the fees that the provider has to pay for the services provided by the network.
301
+ *
302
+ * @generated from enum value: ACCOUNT_TYPE_FEE_EXPENSE = 9;
303
+ */
304
+ FEE_EXPENSE = 9,
305
+ /**
306
+ * Reflects the settlement balance of the provider with the network or other participants.
307
+ *
308
+ * @generated from enum value: ACCOUNT_TYPE_PROVIDER_SETTLEMENT = 10;
309
+ */
310
+ PROVIDER_SETTLEMENT = 10
311
+ }
312
+ /**
313
+ * Describes the enum network.v1.provider.AppendLedgerEntriesRequest.AccountType.
314
+ */
315
+ export declare const AppendLedgerEntriesRequest_AccountTypeSchema: GenEnum<AppendLedgerEntriesRequest_AccountType>;
316
+ /**
317
+ * @generated from message network.v1.provider.AppendLedgerEntriesResponse
318
+ */
319
+ export type AppendLedgerEntriesResponse = Message<"network.v1.provider.AppendLedgerEntriesResponse"> & {};
320
+ /**
321
+ * Describes the message network.v1.provider.AppendLedgerEntriesResponse.
322
+ * Use `create(AppendLedgerEntriesResponseSchema)` to create a new message.
323
+ */
324
+ export declare const AppendLedgerEntriesResponseSchema: GenMessage<AppendLedgerEntriesResponse>;
325
+ /**
326
+ * @generated from message network.v1.provider.PayoutRequest
327
+ */
328
+ export type PayoutRequest = Message<"network.v1.provider.PayoutRequest"> & {
329
+ /**
330
+ * *
331
+ * payment id assigned by the network (provider should store this id to provide details in UpdatePayout later)
332
+ *
333
+ * @generated from field: int64 payment_id = 10;
334
+ */
335
+ paymentId: bigint;
336
+ /**
337
+ * *
338
+ * payout id assigned by the network (provider should store this id to provide details in UpdatePayout later)
339
+ *
340
+ * @generated from field: int64 payout_id = 20;
341
+ */
342
+ payoutId: bigint;
343
+ /**
344
+ * *
345
+ * currency of the payout (participant could support multiple currencies)
346
+ * This is the currency in which the payout should be made.
347
+ *
348
+ * @generated from field: string currency = 30;
349
+ */
350
+ currency: string;
351
+ /**
352
+ * *
353
+ * client quote id of the quote used for this payout (the provider provides the quote IDs in the UpdateQuote rpc)
354
+ * This is the identifier of the quote that was used to calculate the payout amount.
355
+ *
356
+ * @generated from field: string client_quote_id = 40;
357
+ */
358
+ clientQuoteId: string;
359
+ /**
360
+ * *
361
+ * amount in currency of the payout
362
+ * This is the amount that should be paid out to the recipient.
363
+ *
364
+ * @generated from field: tzero.v1.common.Decimal amount = 50;
365
+ */
366
+ amount?: Decimal;
367
+ /**
368
+ * *
369
+ * payout_method is the payment method for the payout, e.g. bank transfer, crypto transfer, etc.
370
+ * This is used to specify how the payout should be made.
371
+ *
372
+ * @generated from field: tzero.v1.common.PaymentMethod payout_method = 60;
373
+ */
374
+ payoutMethod?: PaymentMethod;
375
+ };
376
+ /**
377
+ * Describes the message network.v1.provider.PayoutRequest.
378
+ * Use `create(PayoutRequestSchema)` to create a new message.
379
+ */
380
+ export declare const PayoutRequestSchema: GenMessage<PayoutRequest>;
381
+ /**
382
+ * @generated from message network.v1.provider.PayoutResponse
383
+ */
384
+ export type PayoutResponse = Message<"network.v1.provider.PayoutResponse"> & {};
385
+ /**
386
+ * Describes the message network.v1.provider.PayoutResponse.
387
+ * Use `create(PayoutResponseSchema)` to create a new message.
388
+ */
389
+ export declare const PayoutResponseSchema: GenMessage<PayoutResponse>;
390
+ /**
391
+ * @generated from message network.v1.provider.UpdatePaymentRequest
392
+ */
393
+ export type UpdatePaymentRequest = Message<"network.v1.provider.UpdatePaymentRequest"> & {
394
+ /**
395
+ * *
396
+ * payment_id is a payment id in the T-0 network.
397
+ *
398
+ * @generated from field: uint64 payment_id = 5;
399
+ */
400
+ paymentId: bigint;
401
+ /**
402
+ * *
403
+ * payment_client_id is a payment id assigned by the client, this is the same id that was provided in the CreatePaymentRequest.
404
+ *
405
+ * @generated from field: string payment_client_id = 10;
406
+ */
407
+ paymentClientId: string;
408
+ /**
409
+ * @generated from oneof network.v1.provider.UpdatePaymentRequest.result
410
+ */
411
+ result: {
412
+ /**
413
+ * *
414
+ * Success response - means the payout was executed successfully and the payment is now complete. This happens when
415
+ * the payout is successfully processed by the payout provider, and the payment was made to the recipient.
416
+ *
417
+ * @generated from field: network.v1.provider.UpdatePaymentRequest.Success success = 20;
418
+ */
419
+ value: UpdatePaymentRequest_Success;
420
+ case: "success";
421
+ } | {
422
+ /**
423
+ * *
424
+ * Failure response - means the payout was not executed successfully, e.g. the payout provider could not process the payout.
425
+ *
426
+ * @generated from field: network.v1.provider.UpdatePaymentRequest.Failure failure = 30;
427
+ */
428
+ value: UpdatePaymentRequest_Failure;
429
+ case: "failure";
430
+ } | {
431
+ case: undefined;
432
+ value?: undefined;
433
+ };
434
+ };
435
+ /**
436
+ * Describes the message network.v1.provider.UpdatePaymentRequest.
437
+ * Use `create(UpdatePaymentRequestSchema)` to create a new message.
438
+ */
439
+ export declare const UpdatePaymentRequestSchema: GenMessage<UpdatePaymentRequest>;
440
+ /**
441
+ * @generated from message network.v1.provider.UpdatePaymentRequest.Success
442
+ */
443
+ export type UpdatePaymentRequest_Success = Message<"network.v1.provider.UpdatePaymentRequest.Success"> & {
444
+ /**
445
+ * amount in currency of the payout
446
+ *
447
+ * @generated from field: tzero.v1.common.Decimal payout_amount = 10;
448
+ */
449
+ payoutAmount?: Decimal;
450
+ /**
451
+ * time of the payout
452
+ *
453
+ * @generated from field: google.protobuf.Timestamp paid_out_at = 50;
454
+ */
455
+ paidOutAt?: Timestamp;
456
+ };
457
+ /**
458
+ * Describes the message network.v1.provider.UpdatePaymentRequest.Success.
459
+ * Use `create(UpdatePaymentRequest_SuccessSchema)` to create a new message.
460
+ */
461
+ export declare const UpdatePaymentRequest_SuccessSchema: GenMessage<UpdatePaymentRequest_Success>;
462
+ /**
463
+ * @generated from message network.v1.provider.UpdatePaymentRequest.Failure
464
+ */
465
+ export type UpdatePaymentRequest_Failure = Message<"network.v1.provider.UpdatePaymentRequest.Failure"> & {};
466
+ /**
467
+ * Describes the message network.v1.provider.UpdatePaymentRequest.Failure.
468
+ * Use `create(UpdatePaymentRequest_FailureSchema)` to create a new message.
469
+ */
470
+ export declare const UpdatePaymentRequest_FailureSchema: GenMessage<UpdatePaymentRequest_Failure>;
471
+ /**
472
+ * @generated from enum network.v1.provider.UpdatePaymentRequest.Failure.Reason
473
+ */
474
+ export declare enum UpdatePaymentRequest_Failure_Reason {
475
+ /**
476
+ * @generated from enum value: REASON_UNSPECIFIED = 0;
477
+ */
478
+ UNSPECIFIED = 0
479
+ }
480
+ /**
481
+ * Describes the enum network.v1.provider.UpdatePaymentRequest.Failure.Reason.
482
+ */
483
+ export declare const UpdatePaymentRequest_Failure_ReasonSchema: GenEnum<UpdatePaymentRequest_Failure_Reason>;
484
+ /**
485
+ * @generated from message network.v1.provider.UpdatePaymentResponse
486
+ */
487
+ export type UpdatePaymentResponse = Message<"network.v1.provider.UpdatePaymentResponse"> & {};
488
+ /**
489
+ * Describes the message network.v1.provider.UpdatePaymentResponse.
490
+ * Use `create(UpdatePaymentResponseSchema)` to create a new message.
491
+ */
492
+ export declare const UpdatePaymentResponseSchema: GenMessage<UpdatePaymentResponse>;
493
+ /**
494
+ * All the amounts are in USD
495
+ *
496
+ * @generated from message network.v1.provider.UpdateLimitRequest
497
+ */
498
+ export type UpdateLimitRequest = Message<"network.v1.provider.UpdateLimitRequest"> & {
499
+ /**
500
+ * *
501
+ * can contain one or more Limit messages, each representing a credit limit for a specific counterparty provider.
502
+ *
503
+ * @generated from field: repeated network.v1.provider.UpdateLimitRequest.Limit limits = 10;
504
+ */
505
+ limits: UpdateLimitRequest_Limit[];
506
+ };
507
+ /**
508
+ * Describes the message network.v1.provider.UpdateLimitRequest.
509
+ * Use `create(UpdateLimitRequestSchema)` to create a new message.
510
+ */
511
+ export declare const UpdateLimitRequestSchema: GenMessage<UpdateLimitRequest>;
512
+ /**
513
+ * @generated from message network.v1.provider.UpdateLimitRequest.Limit
514
+ */
515
+ export type UpdateLimitRequest_Limit = Message<"network.v1.provider.UpdateLimitRequest.Limit"> & {
516
+ /**
517
+ * *
518
+ * Incrementally growing for the provider - same as in Ledger.
519
+ *
520
+ * @generated from field: int64 version = 10;
521
+ */
522
+ version: bigint;
523
+ /**
524
+ * *
525
+ * the Id of the counterparty (creditor) provider, e.g. the provider that is providing the credit limit.
526
+ * It's usually the payOut provider, which provides the credit line to the payIn provider.
527
+ *
528
+ * @generated from field: int32 creditor_id = 15;
529
+ */
530
+ creditorId: number;
531
+ /**
532
+ * *
533
+ * payout_limit = credit_limit - credit_usage, negative value means credit limit is exceeded,
534
+ * e.g. if counterparty decreased credit limit
535
+ *
536
+ * @generated from field: tzero.v1.common.Decimal payout_limit = 20;
537
+ */
538
+ payoutLimit?: Decimal;
539
+ /**
540
+ * *
541
+ * This is the credit limit that the counterparty is willing to extend to the provider.
542
+ *
543
+ * @generated from field: tzero.v1.common.Decimal credit_limit = 30;
544
+ */
545
+ creditLimit?: Decimal;
546
+ /**
547
+ * *
548
+ * This is the credit usage that the provider has used so far. It is the sum of all payouts made by the provider
549
+ * minus the settlement net (settlement balance). It could be negative if the provider has received more
550
+ * in settlements than maid payouts (pre-settlement).
551
+ *
552
+ * @generated from field: tzero.v1.common.Decimal credit_usage = 40;
553
+ */
554
+ creditUsage?: Decimal;
555
+ };
556
+ /**
557
+ * Describes the message network.v1.provider.UpdateLimitRequest.Limit.
558
+ * Use `create(UpdateLimitRequest_LimitSchema)` to create a new message.
559
+ */
560
+ export declare const UpdateLimitRequest_LimitSchema: GenMessage<UpdateLimitRequest_Limit>;
561
+ /**
562
+ * *
563
+ * Empty message - means no response is needed.
564
+ *
565
+ * @generated from message network.v1.provider.UpdateLimitResponse
566
+ */
567
+ export type UpdateLimitResponse = Message<"network.v1.provider.UpdateLimitResponse"> & {};
568
+ /**
569
+ * Describes the message network.v1.provider.UpdateLimitResponse.
570
+ * Use `create(UpdateLimitResponseSchema)` to create a new message.
571
+ */
572
+ export declare const UpdateLimitResponseSchema: GenMessage<UpdateLimitResponse>;
573
+ /**
574
+ * @generated from message network.v1.provider.CreatePayInDetailsRequest
575
+ */
576
+ export type CreatePayInDetailsRequest = Message<"network.v1.provider.CreatePayInDetailsRequest"> & {
577
+ /**
578
+ * *
579
+ * payment_intent_id is a unique identifier for the payment intent, which is used to create a payment later.
580
+ *
581
+ * @generated from field: string payment_intent_id = 10;
582
+ */
583
+ paymentIntentId: string;
584
+ /**
585
+ * *
586
+ * Sender details for the pay-in process.
587
+ *
588
+ * @generated from field: network.v1.provider.CreatePayInDetailsRequest.Sender sender = 40;
589
+ */
590
+ sender?: CreatePayInDetailsRequest_Sender;
591
+ };
592
+ /**
593
+ * Describes the message network.v1.provider.CreatePayInDetailsRequest.
594
+ * Use `create(CreatePayInDetailsRequestSchema)` to create a new message.
595
+ */
596
+ export declare const CreatePayInDetailsRequestSchema: GenMessage<CreatePayInDetailsRequest>;
597
+ /**
598
+ * @generated from message network.v1.provider.CreatePayInDetailsRequest.Sender
599
+ */
600
+ export type CreatePayInDetailsRequest_Sender = Message<"network.v1.provider.CreatePayInDetailsRequest.Sender"> & {
601
+ /**
602
+ * @generated from oneof network.v1.provider.CreatePayInDetailsRequest.Sender.sender
603
+ */
604
+ sender: {
605
+ /**
606
+ * @generated from field: network.v1.provider.CreatePayInDetailsRequest.Sender.PrivatePerson private_person = 10;
607
+ */
608
+ value: CreatePayInDetailsRequest_Sender_PrivatePerson;
609
+ case: "privatePerson";
610
+ } | {
611
+ case: undefined;
612
+ value?: undefined;
613
+ };
614
+ };
615
+ /**
616
+ * Describes the message network.v1.provider.CreatePayInDetailsRequest.Sender.
617
+ * Use `create(CreatePayInDetailsRequest_SenderSchema)` to create a new message.
618
+ */
619
+ export declare const CreatePayInDetailsRequest_SenderSchema: GenMessage<CreatePayInDetailsRequest_Sender>;
620
+ /**
621
+ * @generated from message network.v1.provider.CreatePayInDetailsRequest.Sender.PrivatePerson
622
+ */
623
+ export type CreatePayInDetailsRequest_Sender_PrivatePerson = Message<"network.v1.provider.CreatePayInDetailsRequest.Sender.PrivatePerson"> & {
624
+ /**
625
+ * can be used to get KYC data
626
+ *
627
+ * @generated from field: string private_person_id = 10;
628
+ */
629
+ privatePersonId: string;
630
+ };
631
+ /**
632
+ * Describes the message network.v1.provider.CreatePayInDetailsRequest.Sender.PrivatePerson.
633
+ * Use `create(CreatePayInDetailsRequest_Sender_PrivatePersonSchema)` to create a new message.
634
+ */
635
+ export declare const CreatePayInDetailsRequest_Sender_PrivatePersonSchema: GenMessage<CreatePayInDetailsRequest_Sender_PrivatePerson>;
636
+ /**
637
+ * @generated from message network.v1.provider.CreatePayInDetailsResponse
638
+ */
639
+ export type CreatePayInDetailsResponse = Message<"network.v1.provider.CreatePayInDetailsResponse"> & {
640
+ /**
641
+ * *
642
+ * List of available pay-in methods for the sender. This is used to present the user with options for how they can pay in.
643
+ *
644
+ * @generated from field: repeated tzero.v1.common.PaymentMethod pay_in_method = 10;
645
+ */
646
+ payInMethod: PaymentMethod[];
647
+ };
648
+ /**
649
+ * Describes the message network.v1.provider.CreatePayInDetailsResponse.
650
+ * Use `create(CreatePayInDetailsResponseSchema)` to create a new message.
651
+ */
652
+ export declare const CreatePayInDetailsResponseSchema: GenMessage<CreatePayInDetailsResponse>;
653
+ /**
654
+ * *
655
+ * This service must be implemented by the provider.
656
+ *
657
+ * All methods of this service must be idempotent, meaning they are safe to retry and multiple calls with the same parameters must not have additional effect.
658
+ *
659
+ * @generated from service network.v1.provider.ProviderService
660
+ */
661
+ export declare const ProviderService: GenService<{
662
+ /**
663
+ * *
664
+ * Network instructs the provider to execute a payout to the recipient.
665
+ *
666
+ * @generated from rpc network.v1.provider.ProviderService.PayOut
667
+ */
668
+ payOut: {
669
+ methodKind: "unary";
670
+ input: typeof PayoutRequestSchema;
671
+ output: typeof PayoutResponseSchema;
672
+ };
673
+ /**
674
+ * *
675
+ * Network provides an update on the status of a payment. This can be either a success or a failure.
676
+ *
677
+ * @generated from rpc network.v1.provider.ProviderService.UpdatePayment
678
+ */
679
+ updatePayment: {
680
+ methodKind: "unary";
681
+ input: typeof UpdatePaymentRequestSchema;
682
+ output: typeof UpdatePaymentResponseSchema;
683
+ };
684
+ /**
685
+ * *
686
+ * Network asks the provider for possible pay-in options for a sender, in preparation for a pay-in process.
687
+ * This is optional, but if implemented, it should return a list of available pay-in methods.
688
+ *
689
+ * @generated from rpc network.v1.provider.ProviderService.CreatePayInDetails
690
+ */
691
+ createPayInDetails: {
692
+ methodKind: "unary";
693
+ input: typeof CreatePayInDetailsRequestSchema;
694
+ output: typeof CreatePayInDetailsResponseSchema;
695
+ };
696
+ /**
697
+ * *
698
+ * This rpc is used to notify the provider about the changes in credit limit and/or credit usage.
699
+ *
700
+ * @generated from rpc network.v1.provider.ProviderService.UpdateLimit
701
+ */
702
+ updateLimit: {
703
+ methodKind: "unary";
704
+ input: typeof UpdateLimitRequestSchema;
705
+ output: typeof UpdateLimitResponseSchema;
706
+ };
707
+ /**
708
+ * *
709
+ * Network can send all the updates about ledger entries of the provider's accounts. It can be used to
710
+ * keep track of the provider's exposure to other participants and other important financial events. (see the list in the message below)
711
+ *
712
+ * @generated from rpc network.v1.provider.ProviderService.AppendLedgerEntries
713
+ */
714
+ appendLedgerEntries: {
715
+ methodKind: "unary";
716
+ input: typeof AppendLedgerEntriesRequestSchema;
717
+ output: typeof AppendLedgerEntriesResponseSchema;
718
+ };
719
+ }>;