@postpaybr/protos 1.1.2 → 1.1.7

package/dist/typescript/tax.d.ts

@@ -0,0 +1,293 @@
+import { ChargeStatus, MetaType, OrderStatus, PaymentMethods, taxMeta, TaxStatus, TaxTypes } from '@postpaybr/contracts/types';
+import { Observable } from 'rxjs';
+export declare const protobufPackage = "tax";
+export interface Payer {
+    id?: string | undefined;
+    name: string;
+    document: string;
+    phone?: string | undefined;
+}
+export interface LocationDetailsDto {
+    document: string;
+    city: number;
+    state: number;
+    year: number;
+}
+export interface completeTax {
+    id: string;
+    type: TaxTypes;
+    status: TaxStatus;
+    description: string;
+    amount: number;
+    year: number;
+    dueAt: string;
+    documentId: string;
+    code: string;
+    isSingleQuota: boolean;
+    quota?: number | undefined;
+    fee: number;
+    fine: number;
+    discountAmount: number;
+}
+export interface TaxPayload {
+    tax: completeTax | undefined;
+    payer: Payer | undefined;
+    location: Location | undefined;
+    metaType: MetaType;
+    meta: taxMeta | undefined;
+}
+export interface Tax {
+    id: string;
+    type: TaxTypes;
+    description: string;
+    year: number;
+    documentId: string;
+}
+export interface Location {
+    state: number;
+    city: number;
+    recipientId: string;
+}
+export interface Address {
+    street: string;
+    number: string;
+    complement: string;
+    neighborhood: string;
+    city: string;
+    state: string;
+    zipCode: string;
+}
+export interface Property {
+    documentId?: string | undefined;
+    address?: Address | undefined;
+}
+export interface TaxDetail {
+    tax: any | undefined;
+    payer: any | undefined;
+    location: Location | undefined;
+    metaType: MetaType;
+    meta: taxMeta | undefined;
+    items: TaxItem[];
+}
+export interface TaxItem {
+    id: string;
+    code: string;
+    quota: number;
+    dueAt: string;
+    amount: number;
+    isSingleQuota: boolean;
+    status: TaxStatus;
+    discountPercentage: number;
+    discountAmount: number;
+    fee: number;
+    fine: number;
+}
+export interface PropertyDetail {
+    property: Property | undefined;
+    payer: Payer | undefined;
+    taxTypes: any;
+    pendingTaxesAmount?: number | undefined;
+    paidTaxesAmount?: number | undefined;
+    overdueTaxesAmount?: number | undefined;
+    lastPaidTaxDate?: string | undefined;
+    nextDueDate?: string | undefined;
+    nearDueTaxesDates?: TaxDueDate[];
+    overdueTaxesDates?: TaxDueDate[];
+    receiptId?: string | undefined;
+}
+export interface TaxDueDate {
+    id: string;
+    dueDate: string;
+}
+export interface TaxPayloadRequest {
+    data: TaxPayload | undefined;
+    payer: Payer | undefined;
+}
+export interface TaxByDocumentIdRequest {
+    documentId: string;
+}
+export interface TaxByDocumentIdAndTypeRequest {
+    documentId: string;
+    type: TaxTypes;
+}
+export interface TaxByIdRequest {
+    id: string;
+}
+export interface GroupedPropertyDetails {
+    properties: PropertyDetail[];
+}
+export interface TaxDetails {
+    taxes: TaxDetail[];
+}
+export interface TaxEntity {
+    id: string;
+    type: TaxTypes;
+    status: TaxStatus;
+    description: string;
+    amount: number;
+    year: number;
+    dueAt: string;
+    documentId: string;
+    code: string;
+    isSingleQuota: boolean;
+    quota: number;
+    fee: number;
+    fine: number;
+    discountPercentage: number;
+    discountAmount: number;
+    state: number;
+    city: number;
+    recipientId: string;
+    metaType: MetaType;
+    meta?: taxMeta | undefined;
+    payer: PayerEntity | undefined;
+    orderItem?: OrderItemEntity | undefined;
+    receipt?: Receipt | undefined;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface Charge {
+    id: string;
+    amount: number;
+    paymentMethod: string;
+    status: ChargeStatus;
+    dueAt?: string | undefined;
+    txid?: string | undefined;
+    brcode?: string | undefined;
+    installmentNumber?: number | undefined;
+    installmentValue?: number | undefined;
+    createdAt: Date;
+}
+export interface PayerEntity {
+    id: string;
+    name: string;
+    document: string;
+    phone: string;
+    taxes: TaxEntity[];
+}
+export interface Receipt {
+    id: string;
+    amount: number;
+    protocol: string;
+    txid?: string | undefined;
+    createdAt: Date;
+}
+export interface OrderItemEntity {
+    id: string;
+    recipient: Recipient | undefined;
+    tax: Tax | undefined;
+    order: Order | undefined;
+}
+export interface Order {
+    id: string;
+    totalAmount: number;
+    status: OrderStatus;
+    createdAt: Date;
+    items: OrderItemEntity[];
+    charges: Charge[];
+    customer: Customer | undefined;
+}
+export interface Customer {
+    id: string;
+    firstName: string;
+    lastName: string;
+    document: string;
+    email: string;
+    isEmailVerified: boolean;
+    phone: string;
+}
+export interface Recipient {
+    id: string;
+    code: string;
+}
+export interface TaxesRequest {
+    taxes: TaxEntity[];
+}
+export interface TaxDescriptionResponse {
+    description: string;
+}
+export interface UpdateTaxReceiptIdRequest {
+    id: string;
+    receiptId: string;
+}
+export interface UpdateTaxStatusRequest {
+    id: string;
+    status: TaxStatus;
+}
+export interface GetAllTaxesRequest {
+    data?: GetAllTaxesDto | undefined;
+    pagination: PaginationFilterDto | undefined;
+    date: DateFilterDto | undefined;
+}
+export interface GetAllTaxesDto {
+    recipientId?: string | undefined;
+    types?: TaxTypes[] | undefined;
+    statuses?: TaxStatus[] | undefined;
+}
+export interface PaginationFilterDto {
+    limit?: number | undefined;
+    offset?: number | undefined;
+}
+export interface DateFilterDto {
+    startDate?: Date | undefined;
+    endDate?: Date | undefined;
+}
+export interface GetAllTaxesResponse {
+    taxes: TaxEntity[];
+    count: number;
+}
+export interface CompleteTaxDetailsResponse {
+    tax?: TaxEntity | undefined;
+    charge?: ChargeDetails | undefined;
+}
+export interface ChargeDetails {
+    id: string;
+    amount: number;
+    paymentMethod: PaymentMethods;
+    status: ChargeStatus;
+    dueAt: string;
+    txid?: string | undefined;
+    brcode?: string | undefined;
+    installmentNumber?: number | undefined;
+    installmentValue?: number | undefined;
+    fee: number;
+    baseFee: number;
+    feePercentage: number;
+    discountPercentage: number;
+    discountAmount: number;
+    createdAt: Date;
+    gatewayId: string;
+    failureReason?: string | undefined;
+    failureDetails?: string | undefined;
+}
+export declare const TAX_PACKAGE_NAME = "tax";
+export interface TaxServiceClient {
+    createTax(request: TaxPayloadRequest): Observable<TaxEntity>;
+    getTaxesGroupedByPayerLocation(request: LocationDetailsDto): Observable<GroupedPropertyDetails>;
+    getTaxesGroupedByDocumentId(request: TaxByDocumentIdRequest): Observable<GroupedPropertyDetails>;
+    getTaxesByDocumentId(request: TaxByDocumentIdRequest): Observable<TaxDetails>;
+    getTaxesByDocumentIdAndType(request: TaxByDocumentIdAndTypeRequest): Observable<TaxDetail>;
+    groupTaxesByDocumentId(request: TaxesRequest): Observable<TaxDetails>;
+    getTaxDetailsById(request: TaxByIdRequest): Observable<TaxEntity>;
+    getTaxDescription(request: TaxByIdRequest): Observable<TaxDescriptionResponse>;
+    updateTaxReceiptId(request: UpdateTaxReceiptIdRequest): Observable<TaxEntity>;
+    updateTaxStatus(request: UpdateTaxStatusRequest): Observable<TaxEntity>;
+    getAllTaxes(request: GetAllTaxesRequest): Observable<GetAllTaxesResponse>;
+    getCompleteTaxDetailsById(request: TaxByIdRequest): Observable<CompleteTaxDetailsResponse>;
+}
+export interface TaxServiceController {
+    createTax(request: TaxPayloadRequest): Promise<TaxEntity> | Observable<TaxEntity> | TaxEntity;
+    getTaxesGroupedByPayerLocation(request: LocationDetailsDto): Promise<GroupedPropertyDetails> | Observable<GroupedPropertyDetails> | GroupedPropertyDetails;
+    getTaxesGroupedByDocumentId(request: TaxByDocumentIdRequest): Promise<GroupedPropertyDetails> | Observable<GroupedPropertyDetails> | GroupedPropertyDetails;
+    getTaxesByDocumentId(request: TaxByDocumentIdRequest): Promise<TaxDetails> | Observable<TaxDetails> | TaxDetails;
+    getTaxesByDocumentIdAndType(request: TaxByDocumentIdAndTypeRequest): Promise<TaxDetail> | Observable<TaxDetail> | TaxDetail;
+    groupTaxesByDocumentId(request: TaxesRequest): Promise<TaxDetails> | Observable<TaxDetails> | TaxDetails;
+    getTaxDetailsById(request: TaxByIdRequest): Promise<TaxEntity> | Observable<TaxEntity> | TaxEntity;
+    getTaxDescription(request: TaxByIdRequest): Promise<TaxDescriptionResponse> | Observable<TaxDescriptionResponse> | TaxDescriptionResponse;
+    updateTaxReceiptId(request: UpdateTaxReceiptIdRequest): Promise<TaxEntity> | Observable<TaxEntity> | TaxEntity;
+    updateTaxStatus(request: UpdateTaxStatusRequest): Promise<TaxEntity> | Observable<TaxEntity> | TaxEntity;
+    getAllTaxes(request: GetAllTaxesRequest): Promise<GetAllTaxesResponse> | Observable<GetAllTaxesResponse> | GetAllTaxesResponse;
+    getCompleteTaxDetailsById(request: TaxByIdRequest): Promise<CompleteTaxDetailsResponse> | Observable<CompleteTaxDetailsResponse> | CompleteTaxDetailsResponse;
+}
+export declare function TaxServiceControllerMethods(): (constructor: Function) => void;
+export declare const TAX_SERVICE_NAME = "TaxService";

package/dist/typescript/tax.js

@@ -0,0 +1,36 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v6.33.0
+// source: tax.proto
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+export const protobufPackage = 'tax';
+export const TAX_PACKAGE_NAME = 'tax';
+export function TaxServiceControllerMethods() {
+    return function (constructor) {
+        const grpcMethods = [
+            'createTax',
+            'getTaxesGroupedByPayerLocation',
+            'getTaxesGroupedByDocumentId',
+            'getTaxesByDocumentId',
+            'getTaxesByDocumentIdAndType',
+            'groupTaxesByDocumentId',
+            'getTaxDetailsById',
+            'getTaxDescription',
+            'updateTaxReceiptId',
+            'updateTaxStatus',
+            'getAllTaxes',
+            'getCompleteTaxDetailsById',
+        ];
+        for (const method of grpcMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcMethod('TaxService', method)(constructor.prototype[method], method, descriptor);
+        }
+        const grpcStreamMethods = [];
+        for (const method of grpcStreamMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcStreamMethod('TaxService', method)(constructor.prototype[method], method, descriptor);
+        }
+    };
+}
+export const TAX_SERVICE_NAME = 'TaxService';

package/dist/typescript/transfer.d.ts

@@ -0,0 +1,185 @@
+import { ChargeStatus, GatewayIdentification } from '@postpaybr/contracts/types';
+import { Observable } from 'rxjs';
+export declare const protobufPackage = "transfer";
+export interface UpdateTransferStatusRequest {
+    transferId: string;
+    status: ChargeStatus;
+    responsePayload?: Record<string, any>;
+}
+export interface UpdateTransferStatusResponse {
+    success: boolean;
+}
+export interface Transfer {
+    id: string;
+    amount: number;
+    recipientId: string;
+    chargeId: string;
+    description: string;
+    status: ChargeStatus;
+    processedAt: string;
+    gatewayId: GatewayIdentification;
+    bankAccountId: string;
+    requestPayload: Record<string, any>;
+    responsePayload?: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface BankAccount {
+    id: string;
+    recipientId: string;
+    bankCode: string;
+    branch: string;
+    account: string;
+    accountType: string;
+    pixKey: string;
+    pixKeyType: string;
+    balance: number;
+    transfers: string[];
+    isMain: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface Recipient {
+    id: string;
+    code: string;
+    commercialName: string;
+    socialReason: string;
+    holderType: string;
+    document: string;
+    cnaeId: string;
+    legalType: string;
+    foundation: string;
+    contactName: string;
+    contactEmail: string;
+    contactPhone: string;
+    isAutomaticAnticipationEnabled: boolean;
+    avatarUrl: string;
+    isActive: boolean;
+    providerStatus: string;
+    payableIds: string[];
+    addressId: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface Charge {
+    id: string;
+    amount: number;
+    paymentMethod: string;
+    status: string;
+    type: string;
+    dueAt: string;
+    txid: string;
+    endToEndId: 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;
+    metadata: string;
+}
+export interface Payable {
+    id: string;
+    amount: number;
+    installment: number;
+    status: string;
+    dueAt: string;
+    isAnticipated: boolean;
+    processedAt: string;
+    createdAt: Date;
+    chargeId: string;
+    recipientId: string;
+}
+export interface BankTransferData {
+    pixKey: string;
+    amount: number;
+    chargeId: string;
+    recipient: Recipient | undefined;
+    routingKey: string;
+    gatewayId: GatewayIdentification;
+    payables: Payable[];
+    bankAccountId: string;
+}
+export interface UpdateBankAccountBalanceRequest {
+    bankAccountId: string;
+    amount: number;
+    operation: string;
+}
+export interface UpdateBankAccountBalanceResponse {
+    success: boolean;
+    newBalance: number;
+}
+export interface GetMainAccountRequest {
+}
+export interface GetMainAccountResponse {
+    bankAccount: BankAccount | undefined;
+}
+export interface GetBankAccountByRecipientIdRequest {
+    recipientId: string;
+}
+export interface GetBankAccountByRecipientIdResponse {
+    bankAccount: BankAccount[];
+}
+export interface GetRecipientByIdRequest {
+    id: string;
+}
+export interface GetRecipientByIdResponse {
+    recipient: Recipient | undefined;
+}
+export interface GetLiquidatedChargesForTransferRequest {
+}
+export interface GetLiquidatedChargesForTransferResponse {
+    charges: Charge[];
+}
+export interface UpdatePayablesStatusRequest {
+    payableIds: string[];
+    status: string;
+}
+export interface UpdatePayablesStatusResponse {
+    success: boolean;
+    affected: number;
+}
+export interface GetPayableByIdRequest {
+    payableId: string;
+}
+export interface GetPayableByIdResponse {
+    payable: Payable | undefined;
+}
+export interface RoutingInfoRequest {
+    method: string;
+    recipientId: string;
+    operationType: string;
+}
+export interface RoutingInfoResponse {
+    gatewayId: GatewayIdentification;
+    pixKey: string;
+    routingKey: string;
+}
+export interface CreatePaymentPixRequest {
+    data: BankTransferData | undefined;
+    routingKey: string;
+}
+export interface CreatePaymentPixResponse {
+    success: boolean;
+    paymentId: string;
+}
+export declare const TRANSFER_PACKAGE_NAME = "transfer";
+export interface TransferServiceClient {
+    updateTransferStatus(request: UpdateTransferStatusRequest): Observable<UpdateTransferStatusResponse>;
+}
+export interface TransferServiceController {
+    updateTransferStatus(request: UpdateTransferStatusRequest): Promise<UpdateTransferStatusResponse> | Observable<UpdateTransferStatusResponse> | UpdateTransferStatusResponse;
+}
+export declare function TransferServiceControllerMethods(): (constructor: Function) => void;
+export declare const TRANSFER_SERVICE_NAME = "TransferService";

package/dist/typescript/transfer.js

@@ -0,0 +1,23 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v6.32.0
+// source: transfer.proto
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+export const protobufPackage = 'transfer';
+export const TRANSFER_PACKAGE_NAME = 'transfer';
+export function TransferServiceControllerMethods() {
+    return function (constructor) {
+        const grpcMethods = ['updateTransferStatus'];
+        for (const method of grpcMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcMethod('TransferService', method)(constructor.prototype[method], method, descriptor);
+        }
+        const grpcStreamMethods = [];
+        for (const method of grpcStreamMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcStreamMethod('TransferService', method)(constructor.prototype[method], method, descriptor);
+        }
+    };
+}
+export const TRANSFER_SERVICE_NAME = 'TransferService';

package/dist/typescript/two-factor.d.ts

@@ -0,0 +1,66 @@
+import { AccountTypeEnum } from '@postpaybr/contracts/types';
+import { Observable } from 'rxjs';
+export declare const protobufPackage = "twoFactor";
+export interface EnableTwoFactorRequest {
+    accountId: string;
+    accountType: AccountTypeEnum;
+}
+export interface TwoFactorResponse {
+    qrCodeUrl: string;
+    backupCodes: string[];
+}
+export interface VerifyTwoFactorRequest {
+    accountId: string;
+    accountType: AccountTypeEnum;
+    token: string;
+}
+export interface VerifyTwoFactorResponse {
+    success: boolean;
+}
+export interface DisableTwoFactorRequest {
+    accountId: string;
+    accountType: AccountTypeEnum;
+    backupCode: string;
+}
+export interface DisableTwoFactorResponse {
+    success: boolean;
+}
+export interface VerifyTwoFactorTokenRequest {
+    accountId: string;
+    accountType: AccountTypeEnum;
+    token: string;
+}
+export interface GenerateBackupCodesRequest {
+    accountId: string;
+    accountType: AccountTypeEnum;
+}
+export interface GenerateBackupCodesResponse {
+    backupCodes: string[];
+}
+export interface GetTwoFactorStatusRequest {
+    accountId: string;
+    accountType: AccountTypeEnum;
+}
+export interface TwoFactorStatusResponse {
+    isEnabled: boolean;
+    hasBackupCodes: boolean;
+}
+export declare const TWO_FACTOR_PACKAGE_NAME = "twoFactor";
+export interface TwoFactorServiceClient {
+    enableTwoFactor(request: EnableTwoFactorRequest): Observable<TwoFactorResponse>;
+    verifyAndEnableTwoFactor(request: VerifyTwoFactorRequest): Observable<VerifyTwoFactorResponse>;
+    disableTwoFactor(request: DisableTwoFactorRequest): Observable<DisableTwoFactorResponse>;
+    verifyTwoFactorToken(request: VerifyTwoFactorTokenRequest): Observable<VerifyTwoFactorResponse>;
+    generateNewBackupCodes(request: GenerateBackupCodesRequest): Observable<GenerateBackupCodesResponse>;
+    getTwoFactorStatus(request: GetTwoFactorStatusRequest): Observable<TwoFactorStatusResponse>;
+}
+export interface TwoFactorServiceController {
+    enableTwoFactor(request: EnableTwoFactorRequest): Promise<TwoFactorResponse> | Observable<TwoFactorResponse> | TwoFactorResponse;
+    verifyAndEnableTwoFactor(request: VerifyTwoFactorRequest): Promise<VerifyTwoFactorResponse> | Observable<VerifyTwoFactorResponse> | VerifyTwoFactorResponse;
+    disableTwoFactor(request: DisableTwoFactorRequest): Promise<DisableTwoFactorResponse> | Observable<DisableTwoFactorResponse> | DisableTwoFactorResponse;
+    verifyTwoFactorToken(request: VerifyTwoFactorTokenRequest): Promise<VerifyTwoFactorResponse> | Observable<VerifyTwoFactorResponse> | VerifyTwoFactorResponse;
+    generateNewBackupCodes(request: GenerateBackupCodesRequest): Promise<GenerateBackupCodesResponse> | Observable<GenerateBackupCodesResponse> | GenerateBackupCodesResponse;
+    getTwoFactorStatus(request: GetTwoFactorStatusRequest): Promise<TwoFactorStatusResponse> | Observable<TwoFactorStatusResponse> | TwoFactorStatusResponse;
+}
+export declare function TwoFactorServiceControllerMethods(): (constructor: Function) => void;
+export declare const TWO_FACTOR_SERVICE_NAME = "TwoFactorService";

package/dist/typescript/two-factor.js

@@ -0,0 +1,30 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v6.32.1
+// source: two-factor.proto
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+export const protobufPackage = 'twoFactor';
+export const TWO_FACTOR_PACKAGE_NAME = 'twoFactor';
+export function TwoFactorServiceControllerMethods() {
+    return function (constructor) {
+        const grpcMethods = [
+            'enableTwoFactor',
+            'verifyAndEnableTwoFactor',
+            'disableTwoFactor',
+            'verifyTwoFactorToken',
+            'generateNewBackupCodes',
+            'getTwoFactorStatus',
+        ];
+        for (const method of grpcMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcMethod('TwoFactorService', method)(constructor.prototype[method], method, descriptor);
+        }
+        const grpcStreamMethods = [];
+        for (const method of grpcStreamMethods) {
+            const descriptor = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+            GrpcStreamMethod('TwoFactorService', method)(constructor.prototype[method], method, descriptor);
+        }
+    };
+}
+export const TWO_FACTOR_SERVICE_NAME = 'TwoFactorService';