@postpaybr/protos 1.1.0

package/src/typescript/role.ts

@@ -0,0 +1,144 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.6.0
+//   protoc               v3.20.3
+// source: role.proto
+
+/* eslint-disable */
+import { Permission } from '@postpaybr/contracts/enums';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'role';
+
+export interface CreateRoleRequest {
+  code: string;
+  description: string;
+  permissions: Permission[];
+}
+
+export interface DeleteRoleRequest {
+  id: string;
+}
+
+export interface DeleteRoleResponse {
+  success: boolean;
+}
+
+export interface GetRoleByIdRequest {
+  id: string;
+}
+
+export interface Role {
+  id: string;
+  code: string;
+  description: string;
+  permissions: Permission[];
+}
+
+export interface GetAllRolesRequest {}
+
+export interface GetAllRolesResponse {
+  roles: Role[];
+}
+
+export interface GetPermissionGroupsRequest {}
+
+export interface PermissionGroup {
+  group: string;
+  description: string;
+  permissions: string[];
+}
+
+export interface GetPermissionGroupsResponse {
+  permissionGroups: PermissionGroup[];
+}
+
+export const ROLE_PACKAGE_NAME = 'role';
+
+export interface RoleServiceClient {
+  createRole(request: CreateRoleRequest): Observable<Role>;
+
+  deleteRole(request: DeleteRoleRequest): Observable<DeleteRoleResponse>;
+
+  getRoleById(request: GetRoleByIdRequest): Observable<Role>;
+
+  getAllRoles(request: GetAllRolesRequest): Observable<GetAllRolesResponse>;
+
+  updateRole(request: Role): Observable<Role>;
+
+  getPermissionGroups(
+    request: GetPermissionGroupsRequest,
+  ): Observable<GetPermissionGroupsResponse>;
+}
+
+export interface RoleServiceController {
+  createRole(
+    request: CreateRoleRequest,
+  ): Promise<Role> | Observable<Role> | Role;
+
+  deleteRole(
+    request: DeleteRoleRequest,
+  ):
+    | Promise<DeleteRoleResponse>
+    | Observable<DeleteRoleResponse>
+    | DeleteRoleResponse;
+
+  getRoleById(
+    request: GetRoleByIdRequest,
+  ): Promise<Role> | Observable<Role> | Role;
+
+  getAllRoles(
+    request: GetAllRolesRequest,
+  ):
+    | Promise<GetAllRolesResponse>
+    | Observable<GetAllRolesResponse>
+    | GetAllRolesResponse;
+
+  updateRole(request: Role): Promise<Role> | Observable<Role> | Role;
+
+  getPermissionGroups(
+    request: GetPermissionGroupsRequest,
+  ):
+    | Promise<GetPermissionGroupsResponse>
+    | Observable<GetPermissionGroupsResponse>
+    | GetPermissionGroupsResponse;
+}
+
+export function RoleServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createRole',
+      'deleteRole',
+      'getRoleById',
+      'getAllRoles',
+      'updateRole',
+      'getPermissionGroups',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('RoleService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('RoleService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const ROLE_SERVICE_NAME = 'RoleService';

package/src/typescript/sms.ts

@@ -0,0 +1,96 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.6.0
+//   protoc               v3.20.3
+// source: sms.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export const protobufPackage = 'sms';
+
+export interface SendSmsToVerifyRequest {
+  phoneNumber: string;
+}
+
+export interface SendSmsToVerifyResponse {
+  id: string;
+}
+
+export interface VerifySmsCodeRequest {
+  id: string;
+  code: number;
+}
+
+export interface VerifySmsCodeResponse {
+  success: boolean;
+}
+
+export interface SmsVerifyEntity {
+  id: string;
+  phoneNumber: string;
+  errorCodeMessage: string;
+  verificationCode: number;
+  attempts: number;
+  verified: boolean;
+}
+
+export const SMS_PACKAGE_NAME = 'sms';
+
+export interface SmsServiceClient {
+  sendSmsToVerify(
+    request: SendSmsToVerifyRequest,
+  ): Observable<SendSmsToVerifyResponse>;
+
+  verifySmsCode(
+    request: VerifySmsCodeRequest,
+  ): Observable<VerifySmsCodeResponse>;
+}
+
+export interface SmsServiceController {
+  sendSmsToVerify(
+    request: SendSmsToVerifyRequest,
+  ):
+    | Promise<SendSmsToVerifyResponse>
+    | Observable<SendSmsToVerifyResponse>
+    | SendSmsToVerifyResponse;
+
+  verifySmsCode(
+    request: VerifySmsCodeRequest,
+  ):
+    | Promise<VerifySmsCodeResponse>
+    | Observable<VerifySmsCodeResponse>
+    | VerifySmsCodeResponse;
+}
+
+export function SmsServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = ['sendSmsToVerify', 'verifySmsCode'];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('SmsService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('SmsService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const SMS_SERVICE_NAME = 'SmsService';

package/src/typescript/tax.ts

@@ -0,0 +1,463 @@
+// 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
+
+/* eslint-disable */
+import {
+  ChargeStatus,
+  Meta,
+  MetaType,
+  OrderStatus,
+  PaymentMethods,
+  TaxStatus,
+  TaxTypes,
+} from '@postpaybr/contracts/types';
+import { GrpcMethod, GrpcStreamMethod } from '@nestjs/microservices';
+import { Observable } from 'rxjs';
+
+export 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: Meta | 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: Meta | 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?: Meta | 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 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 function TaxServiceControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      'createTax',
+      'getTaxesGroupedByPayerLocation',
+      'getTaxesGroupedByDocumentId',
+      'getTaxesByDocumentId',
+      'getTaxesByDocumentIdAndType',
+      'groupTaxesByDocumentId',
+      'getTaxDetailsById',
+      'getTaxDescription',
+      'updateTaxReceiptId',
+      'updateTaxStatus',
+      'getAllTaxes',
+      'getCompleteTaxDetailsById',
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcMethod('TaxService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(
+        constructor.prototype,
+        method,
+      );
+      GrpcStreamMethod('TaxService', method)(
+        constructor.prototype[method],
+        method,
+        descriptor,
+      );
+    }
+  };
+}
+
+export const TAX_SERVICE_NAME = 'TaxService';