@postpaybr/protos 1.1.2 → 1.1.7

package/dist/typescript/charge.d.ts

@@ -0,0 +1,538 @@
+import { brandType, ChargeMetadata, ChargeStatus, ChargeSummaryStatus, ChargeType, FailureReason, GatewayIdentification, taxMeta, OrderType, PayableStatus, PaymentMethods, TaxPayload, TaxTypes } from '@postpaybr/contracts/types';
+import { Observable } from 'rxjs';
+export declare const protobufPackage = "charge";
+export interface DateFilter {
+    startDate?: Date | undefined;
+    endDate?: Date | undefined;
+}
+export interface PaginationFilter {
+    limit?: number | undefined;
+    offset?: number | undefined;
+}
+export interface Charge {
+    id: string;
+    amount: number;
+    paymentMethod: PaymentMethods;
+    status: ChargeStatus;
+    dueAt: string;
+    txid: string;
+    brcode: string;
+    pushToken: string;
+    installmentNumber: number;
+    installmentValue: number;
+    fee: number;
+    baseFee: number;
+    feePercentage: number;
+    isScheduled: boolean;
+    discountPercentage: number;
+    discountAmount: number;
+    createdAt: Date;
+    gatewayId: GatewayIdentification;
+    cardId: string;
+    orderId: string;
+    orderScheduleId: string;
+    payableIds: string[];
+    taxId?: string;
+    recipientId?: string;
+    chargeSchedule?: ChargeSchedule | undefined;
+    endToEndId: string;
+    type: ChargeType;
+    metadata: ChargeMetadata | undefined;
+}
+export interface ChargeSchedule {
+    id: string;
+    executionDate: Date;
+    isExecuted: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    charge: Charge | undefined;
+}
+export interface CreateChargeRequest {
+    amount: number;
+    paymentMethod: PaymentMethods;
+    gatewayId: GatewayIdentification;
+    dueAt: string;
+    orderId: string;
+    orderType: OrderType;
+    baseFee: number;
+    feePercentage: number;
+    fee: number;
+    taxId?: string;
+    discountPercentage: number;
+    discountAmount: number;
+    cardId: string;
+    txid?: string | undefined;
+    pushToken: string;
+    installmentNumber: number;
+    installmentValue: number;
+    recipientId: string;
+}
+export interface UpdateChargeRequest {
+    id: string;
+    amount?: number;
+    paymentMethod?: PaymentMethods;
+    status?: ChargeStatus;
+    pushToken?: string;
+    txid?: string;
+    brcode?: string;
+    endToEndId?: string;
+    metadata?: Record<string, any> | undefined;
+    orderId?: string;
+    gatewayId?: string;
+    installmentNumber?: number;
+    installmentValue?: number;
+    cardId?: string;
+    fee?: number;
+    baseFee?: number;
+    feePercentage?: number;
+    discountPercentage?: number;
+    discountAmount?: number;
+    taxId?: string;
+    dueAt?: string;
+    orderType?: string;
+    isRetry?: boolean;
+}
+export interface GetChargeByIdRequest {
+    id: string;
+}
+export interface GetAllChargesRequest {
+    pageIndex?: number | undefined;
+    pageSize?: number | undefined;
+    statuses?: ChargeStatus[];
+    globalFilter?: string | undefined;
+    startDate?: Date | undefined;
+    endDate?: Date | undefined;
+    recipientId?: string | undefined;
+    gatewayIds?: GatewayIdentification[] | undefined;
+    isScheduled?: boolean | undefined;
+}
+export interface GetAllChargesResponse {
+    charges: Charge[];
+}
+export interface GetChargesByOrderIdRequest {
+    id: string;
+}
+export interface GetChargesByOrderIdResponse {
+    charges: Charge[];
+}
+export interface GetChargeByTxidRequest {
+    txid: string;
+}
+export interface ChargeResponse {
+    charge: Charge | undefined;
+}
+export interface GetScheduledChargeDetailRequest {
+    id: string;
+}
+export interface ScheduledChargeDetailResponse {
+    scheduledChargeDetail: ScheduledChargeDetail | undefined;
+}
+export interface ScheduledChargeDetail {
+    id: string;
+    amount: number;
+    method: string;
+    status: ChargeStatus;
+    dueAt: string;
+    createdAt: Date;
+    executionDate: string;
+    fee: number;
+    card?: CardDetails | undefined;
+}
+export interface CardDetails {
+    id: string;
+    brand: brandType;
+    shadowNumber: string;
+    nickname: string;
+}
+export interface getLiquidatedChargesForTransferRequest {
+}
+export interface getLiquidatedChargesForTransferResponse {
+    charges: Charge[];
+}
+export interface ChargeDetailResponse {
+    id: string;
+    customer: string;
+    status: ChargeStatus;
+    createdAt: Date;
+    amount: number;
+    dueAt: string;
+    paymentMethod: PaymentMethods;
+}
+export interface ChargeScheduleDetail {
+    executionDate: Date;
+    isExecuted: boolean;
+}
+export interface ChargeSplit {
+    id: string;
+    recipientAccount: string;
+    amount: number;
+    status: PayableStatus;
+    installment: number;
+    dueAt: string;
+    isAnticipated: boolean;
+    processedAt: Date;
+}
+export interface Tax {
+    id: string;
+    type: string;
+    status: ChargeStatus;
+    description: string;
+    amount: number;
+    year: number;
+    dueAt?: string | undefined;
+    documentId: string;
+    code: string;
+    isSingleQuota: boolean;
+    quota: number;
+    fee: number;
+    fine: number;
+    discountPercentage: number;
+    discountAmount: number;
+    state: number;
+    city: number;
+    recipientId: string;
+    metaType: string;
+    meta: taxMeta | undefined;
+    payer: Payer | undefined;
+    orderItem: OrderItemEntity | undefined;
+    receipt?: Receipt | undefined;
+}
+export interface Payer {
+    id: string;
+    name: string;
+    document: string;
+    phone: string;
+    taxes: Tax[];
+}
+export interface Order {
+    id: string;
+    totalAmount: number;
+    status: ChargeStatus;
+    createdAt: Date;
+    items: OrderItemEntity[];
+    charges: Charge[];
+    customer: Customer | undefined;
+}
+export interface OrderItemEntity {
+    id: string;
+    recipient: Recipient | undefined;
+    tax: Tax | undefined;
+    order: Order | undefined;
+}
+export interface Receipt {
+    id: string;
+    amount: number;
+    protocol: string;
+    transactionId?: string | undefined;
+    createdAt: Date;
+}
+export interface Customer {
+    id: string;
+    username: string;
+    otherName: string;
+    document: string;
+    email: string;
+    emailVerified: boolean;
+    phone: string;
+}
+export interface Recipient {
+    id: string;
+    code: string;
+    commercialName: string;
+    socialReason: string;
+    holderType: string;
+    document: string;
+    cnaeId: string;
+    legalType: string;
+    contactName: string;
+    contactEmail: string;
+    contactPhone: string;
+    isAutomaticAnticipationEnabled: boolean;
+    foundation: string;
+    avatarUrl?: string | undefined;
+}
+export interface ForceConfirmRequest {
+    chargeId: string;
+}
+export interface ForceDueDateRequest {
+    chargeId: string;
+}
+export interface GetChargeCustomerNameRequest {
+    id: string;
+}
+export interface GetChargeCustomerNameResponse {
+    customerName: string;
+}
+export interface GetConfirmedChargesByIdsRequest {
+    ids: string[];
+}
+export interface GetConfirmedChargesByIdsResponse {
+    charges: Charge[];
+}
+export interface cancelScheduledChargeRequest {
+    customerId: string;
+    id: string;
+}
+export interface CreateVerificationCardChargeRequest {
+    amount: number;
+    cardId: string;
+    gatewayId: GatewayIdentification;
+}
+export interface cancelChargeByTxidRequest {
+    txid: string;
+}
+export interface CancelPaymentResponse {
+    success: boolean;
+}
+export interface ForceLiquidationRequest {
+    chargeId: string;
+}
+export interface ForceLiquidationResponse {
+    success: boolean;
+}
+export interface AddPayableToChargeRequest {
+    chargeId: string;
+    payableId: string;
+}
+export interface ChargeClientDetailsResponse {
+    id: string;
+    status: ChargeStatus;
+    createdAt: Date;
+    amount: number;
+    dueAt: string;
+    paymentMethod: PaymentMethods;
+    txid: string;
+    gatewayId: GatewayIdentification;
+    failureReason?: FailureReason | undefined;
+    failureDetails?: string | undefined;
+    fee: number;
+    baseFee: number;
+    feePercentage: number;
+    installmentNumber?: number | undefined;
+    installmentValue?: number | undefined;
+    card?: CardDetails | undefined;
+    discountPercentage: number;
+    discountAmount: number;
+    tax?: TaxPayload | undefined;
+    schedule?: ChargeScheduleDetail | undefined;
+    orderId?: string | undefined;
+}
+export interface GetChargesHistoryRequest {
+    data: ChargeHistoryFilter | undefined;
+    pagination: PaginationFilter | undefined;
+    date: DateFilter | undefined;
+}
+export interface ChargeHistoryFilter {
+    customerId: string;
+    status: ChargeSummaryStatus;
+}
+export interface GetChargesHistoryResponse {
+    charges: ChargeCardItem[];
+    count: number;
+}
+export interface ChargeCardItem {
+    id: string;
+    createdAt: Date;
+    paymentMethod: PaymentMethods;
+    propertyDocument: string;
+    propertyDetail: string;
+    installmentNumber: number;
+    installmentValue: number;
+    schedule?: ChargeScheduleDetail | undefined;
+    taxType: TaxTypes;
+    status: ChargeStatus;
+}
+export interface getChargeAdministratorDetailsResponse {
+    id: string;
+    customer: string;
+    status: ChargeStatus;
+    createdAt: Date;
+    amount: number;
+    dueAt: string;
+    paymentMethod: PaymentMethods;
+    fee: number;
+    baseFee: number;
+    feePercentage: number;
+    installmentNumber: number;
+    installmentValue: number;
+    discountPercentage: number;
+    discountAmount: number;
+    txid: string;
+    gatewayId: GatewayIdentification;
+    cardId?: string | undefined;
+    orderId?: string | undefined;
+    orderScheduleId?: string | undefined;
+    metadata: ChargeMetadata;
+    failureReason?: FailureReason | undefined;
+    failureDetails?: string | undefined;
+    splits: ChargeSplit[];
+    tax?: TaxPayload | undefined;
+    schedule?: ChargeScheduleDetail | undefined;
+}
+export interface GetLastChargesRequest {
+    customerId: string;
+}
+export interface GetLastChargesResponse {
+    charges: ChargeCardItem[];
+}
+export interface cancelChargeByIdRequest {
+    id: string;
+}
+export interface GetChargeRecipientIdResponse {
+    recipientId: string;
+}
+export interface GetChargesTimelineRequest {
+    recipientId?: string | undefined;
+    startDate?: Date | undefined;
+    endDate?: Date | undefined;
+}
+export interface TimelineDataPoint {
+    date: string;
+    liquidated: number;
+    processing: number;
+    scheduled: number;
+    pending: number;
+    cancelled: number;
+}
+export interface ComparisonDataPoint {
+    date: string;
+    liquidated: number;
+}
+export interface GetChargesTimelineResponse {
+    timeline: TimelineDataPoint[];
+}
+export interface GetChargesComparisonTimelineRequest {
+    recipientId?: string | undefined;
+    primaryPeriodStart?: Date | undefined;
+    primaryPeriodEnd?: Date | undefined;
+    secondaryPeriodStart?: Date | undefined;
+    secondaryPeriodEnd?: Date | undefined;
+}
+export interface ChargeComparisonTimeline {
+    primary: ComparisonDataPoint[];
+    secondary: ComparisonDataPoint[];
+}
+export interface GetChargesComparisonTimelineResponse {
+    comparisonTimeline: ChargeComparisonTimeline | undefined;
+}
+export interface getLiquidTotalAmountRequest {
+    recipientId: string;
+    startDate?: Date | undefined;
+    endDate?: Date | undefined;
+}
+export interface getLiquidTotalAmountResponse {
+    total: number;
+}
+export interface ConfirmChargesRequest {
+    chargeIds: string[];
+}
+export interface ForceChargesDueDateRequest {
+    chargeIds: string[];
+}
+export interface ForceChargesLiquidationRequest {
+    chargeIds: string[];
+}
+export interface CancelChargesRequest {
+    chargeIds: string[];
+}
+export interface ChargesBatchResponse {
+    successful: number;
+    failed: number;
+}
+export interface GetOrderPaymentSummaryRequest {
+    orderId: string;
+    orderType: OrderType;
+    customerId: string;
+}
+export interface GetOrderPaymentSummaryResponse {
+    totalPaid: number;
+    totalPending: number;
+    paymentsMade: IndividualPayment[];
+    scheduledPayments: IndividualPayment[];
+    nextPayment: IndividualPayment | undefined;
+}
+export interface IndividualPayment {
+    id: string;
+    createdAt: Date;
+    paymentMethod: string;
+    propertyDocument: string;
+    propertyDetail: string;
+    installmentNumber: number;
+    installmentValue: number;
+    status: string;
+    schedule?: PaymentSchedule | undefined;
+    taxType: string;
+}
+export interface PaymentSchedule {
+    executionDate: Date;
+    isExecuted: boolean;
+}
+export declare const CHARGE_PACKAGE_NAME = "charge";
+export interface ChargeServiceClient {
+    createCharge(request: CreateChargeRequest): Observable<ChargeResponse>;
+    updateCharge(request: UpdateChargeRequest): Observable<ChargeResponse>;
+    getChargeById(request: GetChargeByIdRequest): Observable<ChargeResponse>;
+    getChargeAdministratorDetails(request: GetChargeByIdRequest): Observable<getChargeAdministratorDetailsResponse>;
+    getAllCharges(request: GetAllChargesRequest): Observable<GetAllChargesResponse>;
+    getChargesByOrderId(request: GetChargesByOrderIdRequest): Observable<GetChargesByOrderIdResponse>;
+    getChargeByTxid(request: GetChargeByTxidRequest): Observable<ChargeResponse>;
+    getScheduledChargeDetail(request: GetScheduledChargeDetailRequest): Observable<ScheduledChargeDetailResponse>;
+    getLiquidatedChargesForTransfer(request: getLiquidatedChargesForTransferRequest): Observable<getLiquidatedChargesForTransferResponse>;
+    forceConfirm(request: ForceConfirmRequest): Observable<ChargeResponse>;
+    forceDueDate(request: ForceDueDateRequest): Observable<ChargeResponse>;
+    getChargeCustomerName(request: GetChargeCustomerNameRequest): Observable<GetChargeCustomerNameResponse>;
+    getConfirmedChargesByIds(request: GetConfirmedChargesByIdsRequest): Observable<GetConfirmedChargesByIdsResponse>;
+    cancelScheduledCharge(request: cancelScheduledChargeRequest): Observable<ChargeResponse>;
+    createVerificationCardCharge(request: CreateVerificationCardChargeRequest): Observable<ChargeResponse>;
+    cancelChargeByTxid(request: cancelChargeByTxidRequest): Observable<CancelPaymentResponse>;
+    forceLiquidation(request: ForceLiquidationRequest): Observable<ForceLiquidationResponse>;
+    addPayableToCharge(request: AddPayableToChargeRequest): Observable<ChargeResponse>;
+    getChargeClientDetails(request: GetChargeByIdRequest): Observable<ChargeClientDetailsResponse>;
+    getChargesHistory(request: GetChargesHistoryRequest): Observable<GetChargesHistoryResponse>;
+    getLastChargesByCustomerId(request: GetLastChargesRequest): Observable<GetLastChargesResponse>;
+    cancelChargeById(request: cancelChargeByIdRequest): Observable<CancelPaymentResponse>;
+    getChargeRecipientId(request: GetChargeByIdRequest): Observable<GetChargeRecipientIdResponse>;
+    getChargesTimeline(request: GetChargesTimelineRequest): Observable<GetChargesTimelineResponse>;
+    getChargesComparisonTimeline(request: GetChargesComparisonTimelineRequest): Observable<GetChargesComparisonTimelineResponse>;
+    getLiquidTotalAmount(request: getLiquidTotalAmountRequest): Observable<getLiquidTotalAmountResponse>;
+    confirmCharges(request: ConfirmChargesRequest): Observable<ChargesBatchResponse>;
+    forceChargesDueDate(request: ForceChargesDueDateRequest): Observable<ChargesBatchResponse>;
+    forceChargesLiquidation(request: ForceChargesLiquidationRequest): Observable<ChargesBatchResponse>;
+    cancelCharges(request: CancelChargesRequest): Observable<ChargesBatchResponse>;
+    getOrderPaymentSummary(request: GetOrderPaymentSummaryRequest): Observable<GetOrderPaymentSummaryResponse>;
+}
+export interface ChargeServiceController {
+    createCharge(request: CreateChargeRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    updateCharge(request: UpdateChargeRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    getChargeById(request: GetChargeByIdRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    getChargeAdministratorDetails(request: GetChargeByIdRequest): Promise<getChargeAdministratorDetailsResponse> | Observable<getChargeAdministratorDetailsResponse> | getChargeAdministratorDetailsResponse;
+    getAllCharges(request: GetAllChargesRequest): Promise<GetAllChargesResponse> | Observable<GetAllChargesResponse> | GetAllChargesResponse;
+    getChargesByOrderId(request: GetChargesByOrderIdRequest): Promise<GetChargesByOrderIdResponse> | Observable<GetChargesByOrderIdResponse> | GetChargesByOrderIdResponse;
+    getChargeByTxid(request: GetChargeByTxidRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    getScheduledChargeDetail(request: GetScheduledChargeDetailRequest): Promise<ScheduledChargeDetailResponse> | Observable<ScheduledChargeDetailResponse> | ScheduledChargeDetailResponse;
+    getLiquidatedChargesForTransfer(request: getLiquidatedChargesForTransferRequest): Promise<getLiquidatedChargesForTransferResponse> | Observable<getLiquidatedChargesForTransferResponse> | getLiquidatedChargesForTransferResponse;
+    forceConfirm(request: ForceConfirmRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    forceDueDate(request: ForceDueDateRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    getChargeCustomerName(request: GetChargeCustomerNameRequest): Promise<GetChargeCustomerNameResponse> | Observable<GetChargeCustomerNameResponse> | GetChargeCustomerNameResponse;
+    getConfirmedChargesByIds(request: GetConfirmedChargesByIdsRequest): Promise<GetConfirmedChargesByIdsResponse> | Observable<GetConfirmedChargesByIdsResponse> | GetConfirmedChargesByIdsResponse;
+    cancelScheduledCharge(request: cancelScheduledChargeRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    createVerificationCardCharge(request: CreateVerificationCardChargeRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    cancelChargeByTxid(request: cancelChargeByTxidRequest): Promise<CancelPaymentResponse> | Observable<CancelPaymentResponse> | CancelPaymentResponse;
+    forceLiquidation(request: ForceLiquidationRequest): Promise<ForceLiquidationResponse> | Observable<ForceLiquidationResponse> | ForceLiquidationResponse;
+    addPayableToCharge(request: AddPayableToChargeRequest): Promise<ChargeResponse> | Observable<ChargeResponse> | ChargeResponse;
+    getChargeClientDetails(request: GetChargeByIdRequest): Promise<ChargeClientDetailsResponse> | Observable<ChargeClientDetailsResponse> | ChargeClientDetailsResponse;
+    getChargesHistory(request: GetChargesHistoryRequest): Promise<GetChargesHistoryResponse> | Observable<GetChargesHistoryResponse> | GetChargesHistoryResponse;
+    getLastChargesByCustomerId(request: GetLastChargesRequest): Promise<GetLastChargesResponse> | Observable<GetLastChargesResponse> | GetLastChargesResponse;
+    cancelChargeById(request: cancelChargeByIdRequest): Promise<CancelPaymentResponse> | Observable<CancelPaymentResponse> | CancelPaymentResponse;
+    getChargeRecipientId(request: GetChargeByIdRequest): Promise<GetChargeRecipientIdResponse> | Observable<GetChargeRecipientIdResponse> | GetChargeRecipientIdResponse;
+    getChargesTimeline(request: GetChargesTimelineRequest): Promise<GetChargesTimelineResponse> | Observable<GetChargesTimelineResponse> | GetChargesTimelineResponse;
+    getChargesComparisonTimeline(request: GetChargesComparisonTimelineRequest): Promise<GetChargesComparisonTimelineResponse> | Observable<GetChargesComparisonTimelineResponse> | GetChargesComparisonTimelineResponse;
+    getLiquidTotalAmount(request: getLiquidTotalAmountRequest): Promise<getLiquidTotalAmountResponse> | Observable<getLiquidTotalAmountResponse> | getLiquidTotalAmountResponse;
+    confirmCharges(request: ConfirmChargesRequest): Promise<ChargesBatchResponse> | Observable<ChargesBatchResponse> | ChargesBatchResponse;
+    forceChargesDueDate(request: ForceChargesDueDateRequest): Promise<ChargesBatchResponse> | Observable<ChargesBatchResponse> | ChargesBatchResponse;
+    forceChargesLiquidation(request: ForceChargesLiquidationRequest): Promise<ChargesBatchResponse> | Observable<ChargesBatchResponse> | ChargesBatchResponse;
+    cancelCharges(request: CancelChargesRequest): Promise<ChargesBatchResponse> | Observable<ChargesBatchResponse> | ChargesBatchResponse;
+    getOrderPaymentSummary(request: GetOrderPaymentSummaryRequest): Promise<GetOrderPaymentSummaryResponse> | Observable<GetOrderPaymentSummaryResponse> | GetOrderPaymentSummaryResponse;
+}
+export declare function ChargeServiceControllerMethods(): (constructor: Function) => void;
+export declare const CHARGE_SERVICE_NAME = "ChargeService";

package/dist/typescript/charge.js

@@ -0,0 +1,55 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v6.33.1
+// source: charge.proto
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+export const protobufPackage = 'charge';
+export const CHARGE_PACKAGE_NAME = 'charge';
+export function ChargeServiceControllerMethods() {
+    return function (constructor) {
+        const grpcMethods = [
+            'createCharge',
+            'updateCharge',
+            'getChargeById',
+            'getChargeAdministratorDetails',
+            'getAllCharges',
+            'getChargesByOrderId',
+            'getChargeByTxid',
+            'getScheduledChargeDetail',
+            'getLiquidatedChargesForTransfer',
+            'forceConfirm',
+            'forceDueDate',
+            'getChargeCustomerName',
+            'getConfirmedChargesByIds',
+            'cancelScheduledCharge',
+            'createVerificationCardCharge',
+            'cancelChargeByTxid',
+            'forceLiquidation',
+            'addPayableToCharge',
+            'getChargeClientDetails',
+            'getChargesHistory',
+            'getLastChargesByCustomerId',
+            'cancelChargeById',
+            'getChargeRecipientId',
+            'getChargesTimeline',
+            'getChargesComparisonTimeline',
+            'getLiquidTotalAmount',
+            'confirmCharges',
+            'forceChargesDueDate',
+            'forceChargesLiquidation',
+            'cancelCharges',
+            'getOrderPaymentSummary',
+        ];
+        for (const method of grpcMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcMethod('ChargeService', method)(constructor.prototype[method], method, descriptor);
+        }
+        const grpcStreamMethods = [];
+        for (const method of grpcStreamMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcStreamMethod('ChargeService', method)(constructor.prototype[method], method, descriptor);
+        }
+    };
+}
+export const CHARGE_SERVICE_NAME = 'ChargeService';