@dailydotdev/schema 0.2.8 → 0.2.10

package/dist/njord/transactions_pb.d.cts

@@ -20,7 +20,11 @@ declare enum TransferType {
      *
      * @generated from enum value: TRANSFER = 0;
      */
-    TRANSFER = 0
+    TRANSFER = 0,
+    /**
+     * @generated from enum value: FEE = 1;
+     */
+    FEE = 1
 }
 /**
  * @generated from enum njord.transactions.EntityType
@@ -37,6 +41,27 @@ declare enum EntityType {
      */
     USER = 1
 }
+/**
+ * @generated from enum njord.transactions.TransferStatus
+ */
+declare enum TransferStatus {
+    /**
+     * @generated from enum value: SUCCESS = 0;
+     */
+    SUCCESS = 0,
+    /**
+     * Business logic failures
+     *
+     * @generated from enum value: INSUFFICIENT_FUNDS = 1;
+     */
+    INSUFFICIENT_FUNDS = 1,
+    /**
+     * Technical failures
+     *
+     * @generated from enum value: INTERNAL_ERROR = 100;
+     */
+    INTERNAL_ERROR = 100
+}
 /**
  * @generated from message njord.transactions.TransferParticipant
  */
@@ -61,109 +86,124 @@ declare class TransferParticipant extends Message<TransferParticipant> {
     static equals(a: TransferParticipant | PlainMessage<TransferParticipant> | undefined, b: TransferParticipant | PlainMessage<TransferParticipant> | undefined): boolean;
 }
 /**
- * @generated from message njord.transactions.TransferRequest
+ * @generated from message njord.transactions.TransferFee
  */
-declare class TransferRequest extends Message<TransferRequest> {
+declare class TransferFee extends Message<TransferFee> {
     /**
-     * id to insure operation idempotency (UUID)
+     * e.g., 25 for 25% or 0.25 multiplier
      *
-     * @generated from field: string idempotency_key = 1;
+     * @generated from field: int32 percentage = 1;
      */
-    idempotencyKey: string;
+    percentage: number;
+    constructor(data?: PartialMessage<TransferFee>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "njord.transactions.TransferFee";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransferFee;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransferFee;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransferFee;
+    static equals(a: TransferFee | PlainMessage<TransferFee> | undefined, b: TransferFee | PlainMessage<TransferFee> | undefined): boolean;
+}
+/**
+ * @generated from message njord.transactions.Transfer
+ */
+declare class Transfer extends Message<Transfer> {
     /**
      * user sending currency
      *
-     * @generated from field: njord.transactions.TransferParticipant sender = 2;
+     * @generated from field: njord.transactions.TransferParticipant sender = 1;
      */
     sender?: TransferParticipant;
     /**
      * user receiving currency
      *
-     * @generated from field: njord.transactions.TransferParticipant receiver = 3;
+     * @generated from field: njord.transactions.TransferParticipant receiver = 2;
      */
     receiver?: TransferParticipant;
     /**
-     * @generated from field: njord.transactions.Currency currency = 4;
+     * @generated from field: njord.transactions.Currency currency = 3;
      */
     currency: Currency;
     /**
-     * Amount of change in the balance (could be positive or negative)
+     * Amount transferred from sendr to receiver, always positive
      *
-     * @generated from field: int64 amount = 5;
+     * @generated from field: int64 amount = 4;
      */
     amount: any;
     /**
      * Type of change (e.g., "deposit", "withdrawal"). It is not limited to above values and can be any kind of label, like "promotion_reward" or "admin_action".
      *
-     * @generated from field: njord.transactions.TransferType transfer_type = 6;
+     * @generated from field: njord.transactions.TransferType transfer_type = 5;
      */
     transferType: TransferType;
     /**
      * Free form description
      *
-     * @generated from field: string description = 7;
+     * @generated from field: string description = 6;
      */
     description: string;
     /**
      * flag to allow credited account to become negative. Default false
      *
-     * @generated from field: bool allow_negative = 9;
+     * @generated from field: bool allow_negative = 7;
      */
     allowNegative: boolean;
-    constructor(data?: PartialMessage<TransferRequest>);
+    /**
+     * @generated from field: njord.transactions.TransferFee fee = 8;
+     */
+    fee?: TransferFee;
+    constructor(data?: PartialMessage<Transfer>);
     static readonly runtime: typeof proto3;
-    static readonly typeName = "njord.transactions.TransferRequest";
+    static readonly typeName = "njord.transactions.Transfer";
     static readonly fields: FieldList;
-    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransferRequest;
-    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransferRequest;
-    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransferRequest;
-    static equals(a: TransferRequest | PlainMessage<TransferRequest> | undefined, b: TransferRequest | PlainMessage<TransferRequest> | undefined): boolean;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Transfer;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Transfer;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Transfer;
+    static equals(a: Transfer | PlainMessage<Transfer> | undefined, b: Transfer | PlainMessage<Transfer> | undefined): boolean;
 }
 /**
- * @generated from message njord.transactions.UserAccount
+ * @generated from message njord.transactions.TransferRequest
  */
-declare class UserAccount extends Message<UserAccount> {
+declare class TransferRequest extends Message<TransferRequest> {
     /**
-     * @generated from field: string user_id = 1;
+     * id to insure operation idempotency (UUID)
+     *
+     * @generated from field: string idempotency_key = 1;
      */
-    userId: string;
+    idempotencyKey: string;
     /**
-     * @generated from field: njord.transactions.Currency currency = 2;
+     * @generated from field: repeated njord.transactions.Transfer transfers = 2;
      */
-    currency: Currency;
-    constructor(data?: PartialMessage<UserAccount>);
+    transfers: Transfer[];
+    constructor(data?: PartialMessage<TransferRequest>);
     static readonly runtime: typeof proto3;
-    static readonly typeName = "njord.transactions.UserAccount";
+    static readonly typeName = "njord.transactions.TransferRequest";
     static readonly fields: FieldList;
-    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UserAccount;
-    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UserAccount;
-    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UserAccount;
-    static equals(a: UserAccount | PlainMessage<UserAccount> | undefined, b: UserAccount | PlainMessage<UserAccount> | undefined): boolean;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransferRequest;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransferRequest;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransferRequest;
+    static equals(a: TransferRequest | PlainMessage<TransferRequest> | undefined, b: TransferRequest | PlainMessage<TransferRequest> | undefined): boolean;
 }
 /**
  * @generated from message njord.transactions.BalanceChange
  */
 declare class BalanceChange extends Message<BalanceChange> {
-    /**
-     * @generated from field: njord.transactions.UserAccount account = 1;
-     */
-    account?: UserAccount;
     /**
      * Balance before the update
      *
-     * @generated from field: int64 previous_balance = 2;
+     * @generated from field: int64 previous_balance = 1;
      */
     previousBalance: any;
     /**
      * Balance after the update
      *
-     * @generated from field: int64 new_balance = 3;
+     * @generated from field: int64 new_balance = 2;
      */
     newBalance: any;
     /**
      * Amount of change in the balance (could be positive or negative)
      *
-     * @generated from field: int64 change_amount = 4;
+     * @generated from field: int64 change_amount = 3;
      */
     changeAmount: any;
     constructor(data?: PartialMessage<BalanceChange>);
@@ -176,6 +216,92 @@ declare class BalanceChange extends Message<BalanceChange> {
     static equals(a: BalanceChange | PlainMessage<BalanceChange> | undefined, b: BalanceChange | PlainMessage<BalanceChange> | undefined): boolean;
 }
 /**
+ * @generated from message njord.transactions.FeeResult
+ */
+declare class FeeResult extends Message<FeeResult> {
+    /**
+     * calculated amount of fee in Currency units
+     *
+     * @generated from field: int64 calculated_fee = 1;
+     */
+    calculatedFee: any;
+    /**
+     * @generated from field: njord.transactions.TransferFee origin_fee = 2;
+     */
+    originFee?: TransferFee;
+    constructor(data?: PartialMessage<FeeResult>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "njord.transactions.FeeResult";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): FeeResult;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): FeeResult;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): FeeResult;
+    static equals(a: FeeResult | PlainMessage<FeeResult> | undefined, b: FeeResult | PlainMessage<FeeResult> | undefined): boolean;
+}
+/**
+ * Result of a single transfer operation, fee is treated as a separate transfer operation
+ *
+ * @generated from message njord.transactions.TransferResult
+ */
+declare class TransferResult extends Message<TransferResult> {
+    /**
+     * Operation unique ID
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * user sending currency
+     *
+     * @generated from field: string sender_id = 2;
+     */
+    senderId: string;
+    /**
+     * user receiving currency
+     *
+     * @generated from field: string receiver_id = 3;
+     */
+    receiverId: string;
+    /**
+     * @generated from field: njord.transactions.Currency currency = 4;
+     */
+    currency: Currency;
+    /**
+     * Sender's balance after deducting amount
+     *
+     * @generated from field: njord.transactions.BalanceChange sender_balance = 5;
+     */
+    senderBalance?: BalanceChange;
+    /**
+     * Receiver's balance after receiving amount
+     *
+     * @generated from field: njord.transactions.BalanceChange receiver_balance = 6;
+     */
+    receiverBalance?: BalanceChange;
+    /**
+     * @generated from field: njord.transactions.TransferType transfer_type = 7;
+     */
+    transferType: TransferType;
+    /**
+     * @generated from field: string description = 8;
+     */
+    description: string;
+    /**
+     * @generated from field: njord.transactions.FeeResult fee = 9;
+     */
+    fee?: FeeResult;
+    constructor(data?: PartialMessage<TransferResult>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "njord.transactions.TransferResult";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransferResult;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransferResult;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransferResult;
+    static equals(a: TransferResult | PlainMessage<TransferResult> | undefined, b: TransferResult | PlainMessage<TransferResult> | undefined): boolean;
+}
+/**
+ * Same message is posted to transfer log stream
+ *
  * @generated from message njord.transactions.TransferResponse
  */
 declare class TransferResponse extends Message<TransferResponse> {
@@ -184,15 +310,27 @@ declare class TransferResponse extends Message<TransferResponse> {
      */
     idempotencyKey: string;
     /**
-     * @generated from field: njord.transactions.BalanceChange sender_balance = 2;
+     * Whole transfer status (only SUCCESS or failure statuses)
+     *
+     * @generated from field: njord.transactions.TransferStatus status = 2;
      */
-    senderBalance?: BalanceChange;
+    status: TransferStatus;
     /**
-     * @generated from field: njord.transactions.BalanceChange receiver_balance = 3;
+     * Descriptive error message, present only when status is not SUCCESS
+     *
+     * @generated from field: string error_message = 3;
      */
-    receiverBalance?: BalanceChange;
+    errorMessage: string;
+    /**
+     * Individual transfer results, present only if status is SUCCESS
+     *
+     * @generated from field: repeated njord.transactions.TransferResult results = 4;
+     */
+    results: TransferResult[];
     /**
-     * @generated from field: int64 timestamp = 4;
+     * Unix epoch timestamp milliseconds
+     *
+     * @generated from field: int64 timestamp = 5;
      */
     timestamp: any;
     constructor(data?: PartialMessage<TransferResponse>);
@@ -204,6 +342,27 @@ declare class TransferResponse extends Message<TransferResponse> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransferResponse;
     static equals(a: TransferResponse | PlainMessage<TransferResponse> | undefined, b: TransferResponse | PlainMessage<TransferResponse> | undefined): boolean;
 }
+/**
+ * @generated from message njord.transactions.UserAccount
+ */
+declare class UserAccount extends Message<UserAccount> {
+    /**
+     * @generated from field: string user_id = 1;
+     */
+    userId: string;
+    /**
+     * @generated from field: njord.transactions.Currency currency = 2;
+     */
+    currency: Currency;
+    constructor(data?: PartialMessage<UserAccount>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "njord.transactions.UserAccount";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UserAccount;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UserAccount;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UserAccount;
+    static equals(a: UserAccount | PlainMessage<UserAccount> | undefined, b: UserAccount | PlainMessage<UserAccount> | undefined): boolean;
+}
 /**
  * @generated from message njord.transactions.GetBalanceRequest
  */
@@ -240,64 +399,5 @@ declare class GetBalanceResponse extends Message<GetBalanceResponse> {
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetBalanceResponse;
     static equals(a: GetBalanceResponse | PlainMessage<GetBalanceResponse> | undefined, b: GetBalanceResponse | PlainMessage<GetBalanceResponse> | undefined): boolean;
 }
-/**
- * @generated from message njord.transactions.TransactionLogEntry
- */
-declare class TransactionLogEntry extends Message<TransactionLogEntry> {
-    /**
-     * unique identifier based on transfer id and user
-     *
-     * @generated from field: string transaction_id = 1;
-     */
-    transactionId: string;
-    /**
-     * @generated from field: string user_id = 2;
-     */
-    userId: string;
-    /**
-     * @generated from field: njord.transactions.Currency currency = 3;
-     */
-    currency: Currency;
-    /**
-     * @generated from field: int64 amount = 4;
-     */
-    amount: any;
-    /**
-     * @generated from field: int64 previous_balance = 5;
-     */
-    previousBalance: any;
-    /**
-     * @generated from field: int64 current_balance = 6;
-     */
-    currentBalance: any;
-    /**
-     * Type of change (e.g., "deposit", "withdrawal"). It is not limited to above values and can be any kind of label, like "promotion_reward" or "admin_action".
-     *
-     * @generated from field: njord.transactions.TransferType transfer_type = 7;
-     */
-    transferType: TransferType;
-    /**
-     * @generated from field: string description = 8;
-     */
-    description: string;
-    /**
-     * @generated from field: int64 timestamp = 9;
-     */
-    timestamp: any;
-    /**
-     * parent operation idempotency key
-     *
-     * @generated from field: string transfer_id = 10;
-     */
-    transferId: string;
-    constructor(data?: PartialMessage<TransactionLogEntry>);
-    static readonly runtime: typeof proto3;
-    static readonly typeName = "njord.transactions.TransactionLogEntry";
-    static readonly fields: FieldList;
-    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionLogEntry;
-    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionLogEntry;
-    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionLogEntry;
-    static equals(a: TransactionLogEntry | PlainMessage<TransactionLogEntry> | undefined, b: TransactionLogEntry | PlainMessage<TransactionLogEntry> | undefined): boolean;
-}
 
-export { BalanceChange, Currency, EntityType, GetBalanceRequest, GetBalanceResponse, TransactionLogEntry, TransferParticipant, TransferRequest, TransferResponse, TransferType, UserAccount };
+export { BalanceChange, Currency, EntityType, FeeResult, GetBalanceRequest, GetBalanceResponse, Transfer, TransferFee, TransferParticipant, TransferRequest, TransferResponse, TransferResult, TransferStatus, TransferType, UserAccount };