@postpaybr/protos 1.1.0

package/src/typescript/order.ts

@@ -0,0 +1,311 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v6.33.0
+// source: order.proto
+
+/* eslint-disable */
+import {
+  OrderStatus,
+  OrderType,
+  PaymentMethods,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'order';
+
+export interface CreateOrderRequest {
+  customerId: string;
+  totalAmount: number;
+  orderType: OrderType;
+}
+
+export interface GetOrderByIdRequest {
+  id: string;
+  orderType?: OrderType;
+}
+
+export interface GetAllOrdersRequest {
+  recipientId?: string | undefined;
+  statuses?: OrderStatus[];
+  orderType?: OrderType | undefined;
+  pagination: PaginationFilter | undefined;
+  date: DateFilter | undefined;
+}
+
+export interface PaginationFilter {
+  limit?: number | undefined;
+  offset?: number | undefined;
+}
+
+export interface DateFilter {
+  startDate?: Date | undefined;
+  endDate?: Date | undefined;
+}
+
+export interface GetAllOrdersResponse {
+  orders: Order[];
+  count: number;
+}
+
+export interface CreateOrderItemsRequest {
+  order: Order | undefined;
+  taxIds: string[];
+  orderType: OrderType;
+}
+
+export interface GetReceiptsByOrderIdRequest {
+  orderId: string;
+  orderType: OrderType;
+}
+
+export interface GetReceiptsByOrderIdResponse {
+  receipts: ReceiptEntity[];
+}
+
+export interface updateOrderStatusRequest {
+  orderId: string;
+  orderStatus: OrderStatus;
+  orderType: OrderType;
+}
+
+export interface Void {}
+
+export interface Order {
+  id: string;
+  totalAmount: number;
+  status: OrderStatus;
+  createdAt: Date;
+  updatedAt: Date;
+  chargeIds: string[];
+  customerId: string;
+  items: OrderItem[];
+  orderSchedule: OrderSchedule | undefined;
+  type?: OrderType | undefined;
+}
+
+export interface OrderSchedule {
+  id: string;
+  totalAmount: number;
+  status: OrderStatus;
+  createdAt: Date;
+  updatedAt: Date;
+  chargeIds: string[];
+  customerId: string;
+  items: OrderItem[];
+  order: Order | undefined;
+}
+
+export interface OrderItem {
+  id: string;
+  order: Order | undefined;
+  orderSchedule: OrderSchedule | undefined;
+  recipientId: string;
+  taxId: string;
+}
+
+export interface ReceiptEntity {
+  id: string;
+  customerId: string;
+  amount: number;
+  protocol: string;
+  txid?: string | undefined;
+  createdAt: Date;
+}
+
+export interface GetOrderCustomerNameResponse {
+  customerName: string;
+}
+
+export interface updateOrderWithChargeIdRequest {
+  orderId: string;
+  chargeId: string;
+  orderType: OrderType;
+}
+export interface UpdateOrderAmountAndStatusRequest {
+  id: string;
+  orderType: OrderType;
+  totalAmount: number;
+  status?: OrderStatus;
+}
+
+export interface OrderDetail {
+  id: string;
+  totalAmount: number;
+  status: OrderStatus;
+  createdAt: Date;
+  updatedAt: Date;
+  chargeIds: string[];
+  customerId: string;
+  type: OrderType;
+}
+
+export interface OrderPayments {
+  totalPaid: number;
+  totalPending: number;
+  nextPaymentDate?: Date | undefined;
+  paymentMethod?: PaymentMethods | undefined;
+  customerName: string;
+}
+
+export interface DetailedTax {
+  id: string;
+  type: string;
+  description: string;
+  amount: number;
+  year: number;
+  documentId: string;
+}
+
+export interface DetailedRecipient {
+  id: string;
+  code: string;
+  commercialName: string;
+  socialReason: string;
+}
+
+export interface DetailedOrderItem {
+  id: string;
+  recipientId: string;
+  taxId: string;
+  taxDetails?: DetailedTax | undefined;
+  recipientDetails?: DetailedRecipient | undefined;
+  recipientName?: string | undefined;
+}
+
+export interface DetailedOrderResponse {
+  order: OrderDetail | undefined;
+  items: DetailedOrderItem[];
+  payments: OrderPayments | undefined;
+}
+
+export const ORDER_PACKAGE_NAME = 'order';
+
+export interface OrderServiceClient {
+  createOrder(request: CreateOrderRequest): Observable<Order>;
+
+  getOrderById(request: GetOrderByIdRequest): Observable<Order>;
+
+  getAllOrders(request: GetAllOrdersRequest): Observable<GetAllOrdersResponse>;
+
+  createOrderItems(request: CreateOrderItemsRequest): Observable<Void>;
+
+  getReceiptsByOrderId(
+    request: GetReceiptsByOrderIdRequest,
+  ): Observable<GetReceiptsByOrderIdResponse>;
+
+  updateOrderStatus(request: updateOrderStatusRequest): Observable<Order>;
+
+  getOrderCustomerName(
+    request: GetOrderByIdRequest,
+  ): Observable<GetOrderCustomerNameResponse>;
+
+  updateOrderWithChargeId(
+    request: updateOrderWithChargeIdRequest,
+  ): Observable<Void>;
+
+  updateOrderAmountAndStatus(
+    request: UpdateOrderAmountAndStatusRequest,
+  ): Observable<Order>;
+
+  getDetailedOrder(
+    request: GetOrderByIdRequest,
+  ): Observable<DetailedOrderResponse>;
+}
+
+export interface OrderServiceController {
+  createOrder(
+    request: CreateOrderRequest,
+  ): Promise<Order> | Observable<Order> | Order;
+
+  getOrderById(
+    request: GetOrderByIdRequest,
+  ): Promise<Order> | Observable<Order> | Order;
+
+  getAllOrders(
+    request: GetAllOrdersRequest,
+  ):
+    | Promise<GetAllOrdersResponse>
+    | Observable<GetAllOrdersResponse>
+    | GetAllOrdersResponse;
+
+  createOrderItems(
+    request: CreateOrderItemsRequest,
+  ): Promise<Void> | Observable<Void> | Void;
+
+  getReceiptsByOrderId(
+    request: GetReceiptsByOrderIdRequest,
+  ):
+    | Promise<GetReceiptsByOrderIdResponse>
+    | Observable<GetReceiptsByOrderIdResponse>
+    | GetReceiptsByOrderIdResponse;
+
+  updateOrderStatus(
+    request: updateOrderStatusRequest,
+  ): Promise<Order> | Observable<Order> | Order;
+
+  getOrderCustomerName(
+    request: GetOrderByIdRequest,
+  ):
+    | Promise<GetOrderCustomerNameResponse>
+    | Observable<GetOrderCustomerNameResponse>
+    | GetOrderCustomerNameResponse;
+
+  updateOrderWithChargeId(
+    request: updateOrderWithChargeIdRequest,
+  ): Promise<Void> | Observable<Void> | Void;
+
+  updateOrderAmountAndStatus(
+    request: UpdateOrderAmountAndStatusRequest,
+  ): Promise<Order> | Observable<Order> | Order;
+
+  getDetailedOrder(
+    request: GetOrderByIdRequest,
+  ):
+    | Promise<DetailedOrderResponse>
+    | Observable<DetailedOrderResponse>
+    | DetailedOrderResponse;
+}
+
+export function OrderServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createOrder',
+      'getOrderById',
+      'getAllOrders',
+      'createOrderItems',
+      'getReceiptsByOrderId',
+      'updateOrderStatus',
+      'getOrderCustomerName',
+      'updateOrderWithChargeId',
+      'updateOrderAmountAndStatus',
+      'getDetailedOrder',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('OrderService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('OrderService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const ORDER_SERVICE_NAME = 'OrderService';

package/src/typescript/payable.ts

@@ -0,0 +1,414 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v6.33.0
+// source: payable.proto
+
+/* eslint-disable */
+import {
+  AnticipationStatus,
+  ChargeStatus,
+  PayableStatus,
+  PaymentMethods,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'payable';
+
+export interface CreatePayableRequest {
+  amount: number;
+  chargeId: string;
+  recipientId: string;
+  installment: number;
+  dueAt: string;
+  status: PayableStatus;
+}
+
+export interface PayableResponse {
+  payable: Payable | undefined;
+}
+
+export interface GetPayablesByChargeIdRequest {
+  chargeId: string;
+}
+
+export interface GetPayablesByChargeIdResponse {
+  payables: Payable[];
+}
+
+export interface Payable {
+  id?: string;
+  amount?: number;
+  installment?: number;
+  status?: PayableStatus;
+  dueAt?: string;
+  createdAt?: Date;
+  isAnticipated?: boolean;
+  anticipation?: Anticipation | undefined;
+  chargeId?: string | undefined;
+  recipientId?: string | undefined;
+  processedAt?: Date | undefined;
+}
+
+export interface Anticipation {
+  id: string;
+  createdAt: Date;
+}
+
+export interface GetPayableByIdRequest {
+  payableId: string;
+}
+
+export interface GetPayablesByRecipientIdRequest {
+  recipientId: string;
+  startDate?: Date;
+  endDate?: Date;
+}
+
+export interface GetPayablesByRecipientIdResponse {
+  payables: RecipientPayable[];
+}
+
+export interface RecipientPayable {
+  customer: string;
+  installment: number;
+  installmentNumber: number;
+  dueAt: string;
+  paymentMethod: PaymentMethods;
+  amount: number;
+  fee: number;
+  netAmount: number;
+  chargeId: string;
+  payableId: string;
+}
+
+export interface UpdatePayablesStatusRequest {
+  payableIds: string[];
+  status: PayableStatus;
+}
+
+export interface UpdatePayablesStatusResponse {
+  affected: number;
+}
+
+export interface GetPayablesAvailableForAnticipationRequest {
+  recipientId: string;
+}
+
+export interface GetPayablesAvailableForAnticipationResponse {
+  payables: Payable[];
+}
+
+export interface MarkPayableAsAnticipatedRequest {
+  payableId: string;
+}
+
+export interface DeletePayableRequest {
+  id: string;
+}
+
+export interface DeletePayableResponse {
+  affected: number;
+}
+
+export interface GetAllPayablesRequest {
+  data?: GetAllPayablesData | undefined;
+  pagination: PaginationFilter | undefined;
+  date: DateFilter | undefined;
+}
+
+export interface GetAllPayablesData {
+  recipientId?: string | undefined;
+  statuses?: PayableStatus[];
+  isAnticipated?: boolean | undefined;
+}
+
+export interface PaginationFilter {
+  limit?: number;
+  offset?: number;
+}
+
+export interface DateFilter {
+  startDate?: Date | undefined;
+  endDate?: Date | undefined;
+}
+
+export interface GetAllPayablesResponse {
+  payables: PayableWithDetails[];
+  count: number;
+}
+
+export interface PayableWithDetails {
+  id: string;
+  customer?: string;
+  installment: number;
+  totalInstallments?: number;
+  dueDate: string;
+  paymentMethod?: PaymentMethods;
+  amount: number;
+  fee?: number;
+  status: PayableStatus;
+  isAnticipated: boolean;
+  createdAt: Date;
+  processedAt?: Date | undefined;
+  anticipation?: Anticipation | undefined;
+  transfer?: Transfer | undefined;
+  chargeId: string;
+  recipientId: string;
+}
+
+export interface Transfer {
+  id: string;
+  status: ChargeStatus;
+  createdAt: Date;
+}
+
+export interface GetPayablesSummaryRequest {
+  recipientId: string;
+  startDate?: Date | undefined;
+  endDate?: Date | undefined;
+}
+
+export interface GetPayablesSummaryResponse {
+  summary: PayablesSummary | undefined;
+}
+
+export interface PayablesSummary {
+  totalAmount: number;
+  pendingAmount: number;
+  transferredAmount: number;
+  anticipatedAmount: number;
+  payablesCount: number;
+  pendingCount: number;
+  transferredCount: number;
+  anticipatedCount: number;
+}
+
+export interface GetPayableDetailsRequest {
+  payableId: string;
+}
+
+export interface GetPayableDetailsResponse {
+  payableDetails: PayableDetails | undefined;
+}
+
+export interface PayableDetails {
+  payable: Payable | undefined;
+  anticipation?: AnticipationDetails | undefined;
+  transfer?: TransferDetails | undefined;
+  charge?: ChargeDetails | undefined;
+  customer?: string | undefined;
+}
+
+export interface AnticipationDetails {
+  id: string;
+  amount: number;
+  fee: number;
+  baseFee: number;
+  feePercentage: number;
+  anticipatedDays: number;
+  status: AnticipationStatus;
+  externalId: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface TransferDetails {
+  id: string;
+  amount: number;
+  status: ChargeStatus;
+  description: string;
+  createdAt: Date;
+  processedAt?: Date | undefined;
+}
+
+export interface ChargeDetails {
+  id: string;
+  amount: number;
+  fee: number;
+  installmentNumber: number;
+  paymentMethod: string;
+  status: string;
+  createdAt: Date;
+}
+export interface ForceTransferRequest {
+  payableId: string;
+}
+
+export interface ForceAnticipationRequest {
+  payableId: string;
+}
+
+export const PAYABLE_PACKAGE_NAME = 'payable';
+
+export interface PayableServiceClient {
+  createPayable(request: CreatePayableRequest): Observable<PayableResponse>;
+
+  getPayablesByChargeId(
+    request: GetPayablesByChargeIdRequest,
+  ): Observable<GetPayablesByChargeIdResponse>;
+
+  getPayableById(request: GetPayableByIdRequest): Observable<PayableResponse>;
+
+  getPayablesByRecipientId(
+    request: GetPayablesByRecipientIdRequest,
+  ): Observable<GetPayablesByRecipientIdResponse>;
+
+  updatePayablesStatus(
+    request: UpdatePayablesStatusRequest,
+  ): Observable<UpdatePayablesStatusResponse>;
+
+  getPayablesAvailableForAnticipation(
+    request: GetPayablesAvailableForAnticipationRequest,
+  ): Observable<GetPayablesAvailableForAnticipationResponse>;
+
+  markPayableAsAnticipated(
+    request: MarkPayableAsAnticipatedRequest,
+  ): Observable<PayableResponse>;
+
+  deletePayable(
+    request: DeletePayableRequest,
+  ): Observable<DeletePayableResponse>;
+
+  getAllPayables(
+    request: GetAllPayablesRequest,
+  ): Observable<GetAllPayablesResponse>;
+
+  getPayablesSummary(
+    request: GetPayablesSummaryRequest,
+  ): Observable<GetPayablesSummaryResponse>;
+
+  getPayableDetails(
+    request: GetPayableDetailsRequest,
+  ): Observable<GetPayableDetailsResponse>;
+
+  forceTransfer(request: ForceTransferRequest): Observable<PayableResponse>;
+
+  forceAnticipation(
+    request: ForceAnticipationRequest,
+  ): Observable<PayableResponse>;
+}
+
+export interface PayableServiceController {
+  createPayable(
+    request: CreatePayableRequest,
+  ): Promise<PayableResponse> | Observable<PayableResponse> | PayableResponse;
+
+  getPayablesByChargeId(
+    request: GetPayablesByChargeIdRequest,
+  ):
+    | Promise<GetPayablesByChargeIdResponse>
+    | Observable<GetPayablesByChargeIdResponse>
+    | GetPayablesByChargeIdResponse;
+
+  getPayableById(
+    request: GetPayableByIdRequest,
+  ): Promise<PayableResponse> | Observable<PayableResponse> | PayableResponse;
+
+  getPayablesByRecipientId(
+    request: GetPayablesByRecipientIdRequest,
+  ):
+    | Promise<GetPayablesByRecipientIdResponse>
+    | Observable<GetPayablesByRecipientIdResponse>
+    | GetPayablesByRecipientIdResponse;
+
+  updatePayablesStatus(
+    request: UpdatePayablesStatusRequest,
+  ):
+    | Promise<UpdatePayablesStatusResponse>
+    | Observable<UpdatePayablesStatusResponse>
+    | UpdatePayablesStatusResponse;
+
+  getPayablesAvailableForAnticipation(
+    request: GetPayablesAvailableForAnticipationRequest,
+  ):
+    | Promise<GetPayablesAvailableForAnticipationResponse>
+    | Observable<GetPayablesAvailableForAnticipationResponse>
+    | GetPayablesAvailableForAnticipationResponse;
+
+  markPayableAsAnticipated(
+    request: MarkPayableAsAnticipatedRequest,
+  ): Promise<PayableResponse> | Observable<PayableResponse> | PayableResponse;
+
+  deletePayable(
+    request: DeletePayableRequest,
+  ):
+    | Promise<DeletePayableResponse>
+    | Observable<DeletePayableResponse>
+    | DeletePayableResponse;
+
+  getAllPayables(
+    request: GetAllPayablesRequest,
+  ):
+    | Promise<GetAllPayablesResponse>
+    | Observable<GetAllPayablesResponse>
+    | GetAllPayablesResponse;
+
+  getPayablesSummary(
+    request: GetPayablesSummaryRequest,
+  ):
+    | Promise<GetPayablesSummaryResponse>
+    | Observable<GetPayablesSummaryResponse>
+    | GetPayablesSummaryResponse;
+
+  getPayableDetails(
+    request: GetPayableDetailsRequest,
+  ):
+    | Promise<GetPayableDetailsResponse>
+    | Observable<GetPayableDetailsResponse>
+    | GetPayableDetailsResponse;
+
+  forceTransfer(
+    request: ForceTransferRequest,
+  ): Promise<PayableResponse> | Observable<PayableResponse> | PayableResponse;
+
+  forceAnticipation(
+    request: ForceAnticipationRequest,
+  ): Promise<PayableResponse> | Observable<PayableResponse> | PayableResponse;
+}
+
+export function PayableServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createPayable',
+      'getPayablesByChargeId',
+      'getPayableById',
+      'getPayablesByRecipientId',
+      'updatePayablesStatus',
+      'getPayablesAvailableForAnticipation',
+      'markPayableAsAnticipated',
+      'deletePayable',
+      'getAllPayables',
+      'getPayablesSummary',
+      'getPayableDetails',
+      'forceTransfer',
+      'forceAnticipation',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('PayableService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('PayableService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const PAYABLE_SERVICE_NAME = 'PayableService';