@t-0/provider-sdk 1.0.23 → 1.0.24

package/lib/common/gen/tzero/v1/payment/network_pb.d.ts

@@ -0,0 +1,567 @@
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Decimal } from "../common/common_pb";
+import type { PaymentMethodType } from "../common/payment_method_pb";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file tzero/v1/payment/network.proto.
+ */
+export declare const file_tzero_v1_payment_network: GenFile;
+/**
+ *
+ * Base currency is always USD, so the quotes are always in USD/currency format.
+ *
+ * @generated from message tzero.v1.payment.UpdateQuoteRequest
+ */
+export type UpdateQuoteRequest = Message<"tzero.v1.payment.UpdateQuoteRequest"> & {
+    /**
+     * *
+     * Zero or more quotes for pay-out operations, each quote must have a unique currency, and one or more bands, with the
+     * unique client_quote_id for each band.
+     *
+     * @generated from field: repeated tzero.v1.payment.UpdateQuoteRequest.Quote pay_out = 10;
+     */
+    payOut: UpdateQuoteRequest_Quote[];
+    /**
+     * *
+     * Zero or more quotes for pay-in operations, each quote must have a unique currency, and one or more bands, with the
+     * unique client_quote_id for each band.
+     *
+     * @generated from field: repeated tzero.v1.payment.UpdateQuoteRequest.Quote pay_in = 20;
+     */
+    payIn: UpdateQuoteRequest_Quote[];
+};
+/**
+ * Describes the message tzero.v1.payment.UpdateQuoteRequest.
+ * Use `create(UpdateQuoteRequestSchema)` to create a new message.
+ */
+export declare const UpdateQuoteRequestSchema: GenMessage<UpdateQuoteRequest>;
+/**
+ * @generated from message tzero.v1.payment.UpdateQuoteRequest.Quote
+ */
+export type UpdateQuoteRequest_Quote = Message<"tzero.v1.payment.UpdateQuoteRequest.Quote"> & {
+    /**
+     * BRL, EUR, GBP, etc. (ISO 4217 currency code)
+     *
+     * @generated from field: string currency = 10;
+     */
+    currency: string;
+    /**
+     * type of the quote, e.g. real-time or guaranteed
+     *
+     * @generated from field: tzero.v1.payment.QuoteType quote_type = 20;
+     */
+    quoteType: QuoteType;
+    /**
+     * @generated from field: tzero.v1.common.PaymentMethodType payment_method = 25;
+     */
+    paymentMethod: PaymentMethodType;
+    /**
+     * list of bands for this quote
+     *
+     * @generated from field: repeated tzero.v1.payment.UpdateQuoteRequest.Quote.Band bands = 30;
+     */
+    bands: UpdateQuoteRequest_Quote_Band[];
+    /**
+     * expiration time of the quote
+     *
+     * @generated from field: google.protobuf.Timestamp expiration = 60;
+     */
+    expiration?: Timestamp;
+    /**
+     * timestamp quote was created
+     *
+     * @generated from field: google.protobuf.Timestamp timestamp = 70;
+     */
+    timestamp?: Timestamp;
+};
+/**
+ * Describes the message tzero.v1.payment.UpdateQuoteRequest.Quote.
+ * Use `create(UpdateQuoteRequest_QuoteSchema)` to create a new message.
+ */
+export declare const UpdateQuoteRequest_QuoteSchema: GenMessage<UpdateQuoteRequest_Quote>;
+/**
+ * @generated from message tzero.v1.payment.UpdateQuoteRequest.Quote.Band
+ */
+export type UpdateQuoteRequest_Quote_Band = Message<"tzero.v1.payment.UpdateQuoteRequest.Quote.Band"> & {
+    /**
+     * unique client generated id for this band
+     *
+     * @generated from field: string client_quote_id = 10;
+     */
+    clientQuoteId: string;
+    /**
+     * max amount of USD this quote is applicable for. Please look into documentation for valid amounts.
+     *
+     * @generated from field: tzero.v1.common.Decimal max_amount = 40;
+     */
+    maxAmount?: Decimal;
+    /**
+     * USD/currency rate
+     *
+     * @generated from field: tzero.v1.common.Decimal rate = 50;
+     */
+    rate?: Decimal;
+};
+/**
+ * Describes the message tzero.v1.payment.UpdateQuoteRequest.Quote.Band.
+ * Use `create(UpdateQuoteRequest_Quote_BandSchema)` to create a new message.
+ */
+export declare const UpdateQuoteRequest_Quote_BandSchema: GenMessage<UpdateQuoteRequest_Quote_Band>;
+/**
+ * @generated from message tzero.v1.payment.UpdateQuoteResponse
+ */
+export type UpdateQuoteResponse = Message<"tzero.v1.payment.UpdateQuoteResponse"> & {};
+/**
+ * Describes the message tzero.v1.payment.UpdateQuoteResponse.
+ * Use `create(UpdateQuoteResponseSchema)` to create a new message.
+ */
+export declare const UpdateQuoteResponseSchema: GenMessage<UpdateQuoteResponse>;
+/**
+ * @generated from message tzero.v1.payment.GetPayoutQuoteRequest
+ */
+export type GetPayoutQuoteRequest = Message<"tzero.v1.payment.GetPayoutQuoteRequest"> & {
+    /**
+     * ISO 4217 currency code, e.g. EUR, GBP, etc. in which the payout should be made
+     *
+     * @generated from field: string payout_currency = 10;
+     */
+    payoutCurrency: string;
+    /**
+     * amount in quote currency, only USD is supported
+     *
+     * @generated from field: tzero.v1.common.Decimal amount = 20;
+     */
+    amount?: Decimal;
+    /**
+     * type of the quote, e.g. real-time or guaranteed
+     *
+     * @generated from field: tzero.v1.payment.QuoteType quote_type = 30;
+     */
+    quoteType: QuoteType;
+};
+/**
+ * Describes the message tzero.v1.payment.GetPayoutQuoteRequest.
+ * Use `create(GetPayoutQuoteRequestSchema)` to create a new message.
+ */
+export declare const GetPayoutQuoteRequestSchema: GenMessage<GetPayoutQuoteRequest>;
+/**
+ * @generated from message tzero.v1.payment.GetPayoutQuoteResponse
+ */
+export type GetPayoutQuoteResponse = Message<"tzero.v1.payment.GetPayoutQuoteResponse"> & {
+    /**
+     * rate in USD/currency, e.g. 1.2345 for 1 USD = 1.2345 EUR
+     *
+     * @generated from field: tzero.v1.common.Decimal rate = 10;
+     */
+    rate?: Decimal;
+    /**
+     * expiration time of the quote
+     *
+     * @generated from field: google.protobuf.Timestamp expiration = 20;
+     */
+    expiration?: Timestamp;
+    /**
+     * @generated from field: tzero.v1.payment.QuoteId quote_id = 30;
+     */
+    quoteId?: QuoteId;
+};
+/**
+ * Describes the message tzero.v1.payment.GetPayoutQuoteResponse.
+ * Use `create(GetPayoutQuoteResponseSchema)` to create a new message.
+ */
+export declare const GetPayoutQuoteResponseSchema: GenMessage<GetPayoutQuoteResponse>;
+/**
+ * @generated from message tzero.v1.payment.CreatePaymentRequest
+ */
+export type CreatePaymentRequest = Message<"tzero.v1.payment.CreatePaymentRequest"> & {
+    /**
+     * unique client generated id for this payment
+     *
+     * @generated from field: string payment_client_id = 10;
+     */
+    paymentClientId: string;
+    /**
+     * ISO 4217 currency code, e.g. EUR, GBP, etc. in which the payout should be made
+     *
+     * @generated from field: string payout_currency = 20;
+     */
+    payoutCurrency: string;
+    /**
+     * amount in the payin currency, by default USD (if the payIn currency is not specified)
+     *
+     * @generated from field: tzero.v1.common.Decimal amount = 30;
+     */
+    amount?: Decimal;
+    /**
+     * if not specified, USD is used
+     *
+     * @generated from field: optional string payin_currency = 40;
+     */
+    payinCurrency?: string;
+    /**
+     * optional or option in the oneof?
+     *
+     * @generated from field: tzero.v1.payment.CreatePaymentRequest.Sender sender = 50;
+     */
+    sender?: CreatePaymentRequest_Sender;
+    /**
+     * optional or option in the oneof?
+     *
+     * @generated from field: tzero.v1.payment.CreatePaymentRequest.Recipient recipient = 60;
+     */
+    recipient?: CreatePaymentRequest_Recipient;
+    /**
+     * optional reference for the payment, up to 140 characters
+     *
+     * @generated from field: optional string reference = 70;
+     */
+    reference?: string;
+    /**
+     * if specified, must be a valid quoteId that was previously returned by the GetPayoutQuote method
+     *
+     * @generated from field: optional tzero.v1.payment.QuoteId quote_id = 100;
+     */
+    quoteId?: QuoteId;
+};
+/**
+ * Describes the message tzero.v1.payment.CreatePaymentRequest.
+ * Use `create(CreatePaymentRequestSchema)` to create a new message.
+ */
+export declare const CreatePaymentRequestSchema: GenMessage<CreatePaymentRequest>;
+/**
+ * Work in progress
+ *
+ * @generated from message tzero.v1.payment.CreatePaymentRequest.Sender
+ */
+export type CreatePaymentRequest_Sender = Message<"tzero.v1.payment.CreatePaymentRequest.Sender"> & {
+    /**
+     * @generated from oneof tzero.v1.payment.CreatePaymentRequest.Sender.sender
+     */
+    sender: {
+        /**
+         * @generated from field: tzero.v1.payment.CreatePaymentRequest.PrivatePerson private_person = 10;
+         */
+        value: CreatePaymentRequest_PrivatePerson;
+        case: "privatePerson";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message tzero.v1.payment.CreatePaymentRequest.Sender.
+ * Use `create(CreatePaymentRequest_SenderSchema)` to create a new message.
+ */
+export declare const CreatePaymentRequest_SenderSchema: GenMessage<CreatePaymentRequest_Sender>;
+/**
+ * Work in progress
+ *
+ * @generated from message tzero.v1.payment.CreatePaymentRequest.Recipient
+ */
+export type CreatePaymentRequest_Recipient = Message<"tzero.v1.payment.CreatePaymentRequest.Recipient"> & {
+    /**
+     * @generated from oneof tzero.v1.payment.CreatePaymentRequest.Recipient.recipient
+     */
+    recipient: {
+        /**
+         * @generated from field: tzero.v1.payment.CreatePaymentRequest.PrivatePerson private_person = 10;
+         */
+        value: CreatePaymentRequest_PrivatePerson;
+        case: "privatePerson";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message tzero.v1.payment.CreatePaymentRequest.Recipient.
+ * Use `create(CreatePaymentRequest_RecipientSchema)` to create a new message.
+ */
+export declare const CreatePaymentRequest_RecipientSchema: GenMessage<CreatePaymentRequest_Recipient>;
+/**
+ * Work in progress
+ *
+ * @generated from message tzero.v1.payment.CreatePaymentRequest.PrivatePerson
+ */
+export type CreatePaymentRequest_PrivatePerson = Message<"tzero.v1.payment.CreatePaymentRequest.PrivatePerson"> & {
+    /**
+     * @generated from field: string private_person_client_id = 10;
+     */
+    privatePersonClientId: string;
+    /**
+     * @generated from field: string first_name = 20;
+     */
+    firstName: string;
+    /**
+     * @generated from field: string last_name = 30;
+     */
+    lastName: string;
+};
+/**
+ * Describes the message tzero.v1.payment.CreatePaymentRequest.PrivatePerson.
+ * Use `create(CreatePaymentRequest_PrivatePersonSchema)` to create a new message.
+ */
+export declare const CreatePaymentRequest_PrivatePersonSchema: GenMessage<CreatePaymentRequest_PrivatePerson>;
+/**
+ * @generated from message tzero.v1.payment.QuoteId
+ */
+export type QuoteId = Message<"tzero.v1.payment.QuoteId"> & {
+    /**
+     * unique identifier of the quote within the specified provider
+     *
+     * @generated from field: int64 quote_id = 30;
+     */
+    quoteId: bigint;
+    /**
+     * provider id of the quote
+     *
+     * @generated from field: int32 provider_id = 40;
+     */
+    providerId: number;
+};
+/**
+ * Describes the message tzero.v1.payment.QuoteId.
+ * Use `create(QuoteIdSchema)` to create a new message.
+ */
+export declare const QuoteIdSchema: GenMessage<QuoteId>;
+/**
+ * @generated from message tzero.v1.payment.CreatePaymentResponse
+ */
+export type CreatePaymentResponse = Message<"tzero.v1.payment.CreatePaymentResponse"> & {
+    /**
+     * client generated id supplied in the request
+     *
+     * @generated from field: string payment_client_id = 10;
+     */
+    paymentClientId: string;
+    /**
+     * @generated from oneof tzero.v1.payment.CreatePaymentResponse.result
+     */
+    result: {
+        /**
+         * *
+         * Success response - means the payment was accepted, but the payout is not yet completed. This means, the network found
+         * a suitable quote for the payout currency and amount, and instructed the payout provider to process the payout.
+         *
+         * @generated from field: tzero.v1.payment.CreatePaymentResponse.Success success = 20;
+         */
+        value: CreatePaymentResponse_Success;
+        case: "success";
+    } | {
+        /**
+         * *
+         * Failure response - means the payment was not accepted, e.g. the network could not find a suitable quote for the
+         * payout currency and amount, or the credit limit is exceeded for the available quotes.
+         *
+         * @generated from field: tzero.v1.payment.CreatePaymentResponse.Failure failure = 30;
+         */
+        value: CreatePaymentResponse_Failure;
+        case: "failure";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message tzero.v1.payment.CreatePaymentResponse.
+ * Use `create(CreatePaymentResponseSchema)` to create a new message.
+ */
+export declare const CreatePaymentResponseSchema: GenMessage<CreatePaymentResponse>;
+/**
+ * @generated from message tzero.v1.payment.CreatePaymentResponse.Success
+ */
+export type CreatePaymentResponse_Success = Message<"tzero.v1.payment.CreatePaymentResponse.Success"> & {
+    /**
+     * payment id assigned by the network
+     *
+     * @generated from field: int64 payment_id = 10;
+     */
+    paymentId: bigint;
+};
+/**
+ * Describes the message tzero.v1.payment.CreatePaymentResponse.Success.
+ * Use `create(CreatePaymentResponse_SuccessSchema)` to create a new message.
+ */
+export declare const CreatePaymentResponse_SuccessSchema: GenMessage<CreatePaymentResponse_Success>;
+/**
+ * @generated from message tzero.v1.payment.CreatePaymentResponse.Failure
+ */
+export type CreatePaymentResponse_Failure = Message<"tzero.v1.payment.CreatePaymentResponse.Failure"> & {};
+/**
+ * Describes the message tzero.v1.payment.CreatePaymentResponse.Failure.
+ * Use `create(CreatePaymentResponse_FailureSchema)` to create a new message.
+ */
+export declare const CreatePaymentResponse_FailureSchema: GenMessage<CreatePaymentResponse_Failure>;
+/**
+ * @generated from enum tzero.v1.payment.CreatePaymentResponse.Failure.Reason
+ */
+export declare enum CreatePaymentResponse_Failure_Reason {
+    /**
+     * @generated from enum value: REASON_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0
+}
+/**
+ * Describes the enum tzero.v1.payment.CreatePaymentResponse.Failure.Reason.
+ */
+export declare const CreatePaymentResponse_Failure_ReasonSchema: GenEnum<CreatePaymentResponse_Failure_Reason>;
+/**
+ * @generated from message tzero.v1.payment.UpdatePayoutRequest
+ */
+export type UpdatePayoutRequest = Message<"tzero.v1.payment.UpdatePayoutRequest"> & {
+    /**
+     * payment id assigned by the network, this is the same payment id that was provided in the PayoutRequest
+     *
+     * @generated from field: int64 payment_id = 10;
+     */
+    paymentId: bigint;
+    /**
+     * payout id assigned by the payout provider, this is the same payout id that was provided in the PayoutRequest
+     *
+     * @generated from field: int64 payout_id = 20;
+     */
+    payoutId: bigint;
+    /**
+     * @generated from oneof tzero.v1.payment.UpdatePayoutRequest.result
+     */
+    result: {
+        /**
+         * success response with the details of the payout
+         *
+         * @generated from field: tzero.v1.payment.UpdatePayoutRequest.Success success = 30;
+         */
+        value: UpdatePayoutRequest_Success;
+        case: "success";
+    } | {
+        /**
+         * failure response with the reason of the failure
+         *
+         * @generated from field: tzero.v1.payment.UpdatePayoutRequest.Failure failure = 40;
+         */
+        value: UpdatePayoutRequest_Failure;
+        case: "failure";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message tzero.v1.payment.UpdatePayoutRequest.
+ * Use `create(UpdatePayoutRequestSchema)` to create a new message.
+ */
+export declare const UpdatePayoutRequestSchema: GenMessage<UpdatePayoutRequest>;
+/**
+ * @generated from message tzero.v1.payment.UpdatePayoutRequest.Success
+ */
+export type UpdatePayoutRequest_Success = Message<"tzero.v1.payment.UpdatePayoutRequest.Success"> & {};
+/**
+ * Describes the message tzero.v1.payment.UpdatePayoutRequest.Success.
+ * Use `create(UpdatePayoutRequest_SuccessSchema)` to create a new message.
+ */
+export declare const UpdatePayoutRequest_SuccessSchema: GenMessage<UpdatePayoutRequest_Success>;
+/**
+ * @generated from message tzero.v1.payment.UpdatePayoutRequest.Failure
+ */
+export type UpdatePayoutRequest_Failure = Message<"tzero.v1.payment.UpdatePayoutRequest.Failure"> & {};
+/**
+ * Describes the message tzero.v1.payment.UpdatePayoutRequest.Failure.
+ * Use `create(UpdatePayoutRequest_FailureSchema)` to create a new message.
+ */
+export declare const UpdatePayoutRequest_FailureSchema: GenMessage<UpdatePayoutRequest_Failure>;
+/**
+ * @generated from message tzero.v1.payment.UpdatePayoutResponse
+ */
+export type UpdatePayoutResponse = Message<"tzero.v1.payment.UpdatePayoutResponse"> & {};
+/**
+ * Describes the message tzero.v1.payment.UpdatePayoutResponse.
+ * Use `create(UpdatePayoutResponseSchema)` to create a new message.
+ */
+export declare const UpdatePayoutResponseSchema: GenMessage<UpdatePayoutResponse>;
+/**
+ * @generated from enum tzero.v1.payment.QuoteType
+ */
+export declare enum QuoteType {
+    /**
+     * @generated from enum value: QUOTE_TYPE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * real-time quote must be valid at least for 30 seconds (TBD)
+     *
+     * @generated from enum value: QUOTE_TYPE_REALTIME = 1;
+     */
+    REALTIME = 1
+}
+/**
+ * Describes the enum tzero.v1.payment.QuoteType.
+ */
+export declare const QuoteTypeSchema: GenEnum<QuoteType>;
+/**
+ * *
+ * This service is used by provider to interact with the Network, e.g. push quotes and initiate payments.
+ *
+ * All methods of this service are idempotent, meaning they are safe to retry and multiple calls with the same parameters will have no additional effect.
+ *
+ * @generated from service tzero.v1.payment.NetworkService
+ */
+export declare const NetworkService: GenService<{
+    /**
+     * *
+     * Used by the provider to publish pay-in and pay-out quotes (FX rates) into the network.
+     * These quotes include tiered pricing bands and an expiration timestamp.
+     * This method is idempotent, meaning that multiple calls with the same parameters will have no additional effect.
+     *
+     * @generated from rpc tzero.v1.payment.NetworkService.UpdateQuote
+     */
+    updateQuote: {
+        methodKind: "unary";
+        input: typeof UpdateQuoteRequestSchema;
+        output: typeof UpdateQuoteResponseSchema;
+    };
+    /**
+     * *
+     * Request the best available quote for a payout in a specific currency, for a given amount.
+     * If the payout quote exists, but the credit limit is exceeded, this quote will not be considered.
+     *
+     * @generated from rpc tzero.v1.payment.NetworkService.GetPayoutQuote
+     */
+    getPayoutQuote: {
+        methodKind: "unary";
+        input: typeof GetPayoutQuoteRequestSchema;
+        output: typeof GetPayoutQuoteResponseSchema;
+    };
+    /**
+     * *
+     * Submit a request to create a new payment. PayIn currency and QuoteId are the optional parameters.
+     * If the payIn currency is not specified, the network will use USD as the default payIn currency, and considering
+     * the amount in USD.
+     * If specified, it must be a valid currency code - in this case the network will try to find the payIn quote for the
+     * specified currency and considering the band from the provider initiated this request. So this is only possible, if
+     * this provider already submitted the payIn quote for the specified currency using UpdateQuote rpc.
+     * If the quoteID is specified, it must be a valid quoteId that was previously returned by the GetPayoutQuote method.
+     * If the quoteId is not specified, the network will try to find a suitable quote for the payout currency and amount,
+     * same way as GetPayoutQuote rpc.
+     * This method is idempotent, meaning that multiple calls with the same parameters will have no additional effect.
+     *
+     * @generated from rpc tzero.v1.payment.NetworkService.CreatePayment
+     */
+    createPayment: {
+        methodKind: "unary";
+        input: typeof CreatePaymentRequestSchema;
+        output: typeof CreatePaymentResponseSchema;
+    };
+    /**
+     * *
+     * Inform the network that a payout has been completed or failed. This endpoint is called by the payout
+     * provider, specifying the payment ID and payout ID, which was provided when the payout request was made to this provider.
+     * This method is idempotent, meaning that multiple calls with the same parameters will have no additional effect.
+     *
+     * @generated from rpc tzero.v1.payment.NetworkService.UpdatePayout
+     */
+    updatePayout: {
+        methodKind: "unary";
+        input: typeof UpdatePayoutRequestSchema;
+        output: typeof UpdatePayoutResponseSchema;
+    };
+}>;