@pague-dev/sdk-node 0.2.3 → 0.3.0

package/README.md

@@ -35,6 +35,10 @@ await pdev.customers.list({ page, limit, search });
 await pdev.projects.create({ name, color });
 await pdev.projects.list({ page, limit });
 
+// Withdrawals (Saques PIX)
+await pdev.withdrawals.create({ amount, pixKey, pixKeyType, holderName, holderDocument });
+await pdev.withdrawals.create({ amount, bankAccountId });
+
 // Transactions
 await pdev.transactions.get(id);
 
@@ -49,6 +53,7 @@ const event = parseWebhook(req.body);
 - **Charges** - Links de pagamento
 - **Customers** - Gestão de clientes
 - **Projects** - Organização por projetos
+- **Withdrawals** - Saques via PIX (avulso ou conta salva)
 - **Transactions** - Consulta de transações
 - **Webhooks** - Notificações em tempo real
 

package/dist/index.cjs

@@ -94,6 +94,12 @@ var Transactions = class extends GetOnlyResource {
 	endpoint = "/transactions";
 };
 
+//#endregion
+//#region src/withdrawals/withdrawals.ts
+var Withdrawals = class extends CreateOnlyResource {
+	endpoint = "/withdrawals";
+};
+
 //#endregion
 //#region src/pdev.ts
 var Pdev = class {
@@ -105,6 +111,7 @@ var Pdev = class {
 	projects;
 	charges;
 	transactions;
+	withdrawals;
 	constructor(key) {
 		if (!key) {
 			if (typeof process !== "undefined" && process.env) this.key = process.env.PDEV_API_KEY || "";
@@ -121,6 +128,7 @@ var Pdev = class {
 		this.projects = new Projects(this);
 		this.charges = new Charges(this);
 		this.transactions = new Transactions(this);
+		this.withdrawals = new Withdrawals(this);
 	}
 	async post(path, body, options = {}) {
 		const url = this.buildUrl(path, options.query);

package/dist/index.d.cts

@@ -261,6 +261,43 @@ declare class Transactions extends GetOnlyResource<Transaction> {
   protected readonly endpoint = "/transactions";
 }
 //#endregion
+//#region src/withdrawals/interfaces/withdrawal.interface.d.ts
+type WithdrawalStatus = 'pending' | 'processing' | 'completed' | 'failed';
+type PixKeyType = 'cpf' | 'cnpj' | 'email' | 'phone' | 'random';
+interface Withdrawal {
+  id: string;
+  bankAccountId: string | null;
+  amount: number;
+  feeAmount: number;
+  netAmount: number;
+  status: WithdrawalStatus;
+  snapshotPixKey: string | null;
+  snapshotPixKeyType: PixKeyType | null;
+  snapshotHolderName: string;
+  snapshotHolderDocument: string;
+  failureReason: string | null;
+  pspReference: string | null;
+  createdAt: string;
+  processedAt: string | null;
+}
+//#endregion
+//#region src/withdrawals/interfaces/create-withdrawal.interface.d.ts
+interface CreateWithdrawalOptions {
+  amount: number;
+  bankAccountId?: string;
+  pixKey?: string;
+  pixKeyType?: PixKeyType;
+  holderName?: string;
+  holderDocument?: string;
+  holderDocumentType?: 'cpf' | 'cnpj';
+}
+type CreateWithdrawalResponse = Response<Withdrawal>;
+//#endregion
+//#region src/withdrawals/withdrawals.d.ts
+declare class Withdrawals extends CreateOnlyResource<Withdrawal, CreateWithdrawalOptions> {
+  protected readonly endpoint = "/withdrawals";
+}
+//#endregion
 //#region src/pdev.d.ts
 declare class Pdev {
   readonly key: string;
@@ -271,6 +308,7 @@ declare class Pdev {
   readonly projects: Projects;
   readonly charges: Charges;
   readonly transactions: Transactions;
+  readonly withdrawals: Withdrawals;
   constructor(key?: string);
   post<T>(path: string, body?: unknown, options?: PostOptions): Promise<Response<T>>;
   get<T>(path: string, options?: GetOptions): Promise<Response<T>>;
@@ -479,4 +517,4 @@ interface WebhookHeaders {
  */
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, parseWebhook };
+export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, CreateWithdrawalOptions, CreateWithdrawalResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixKeyType, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, Withdrawal, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, WithdrawalStatus, parseWebhook };

package/dist/index.d.mts

@@ -261,6 +261,43 @@ declare class Transactions extends GetOnlyResource<Transaction> {
   protected readonly endpoint = "/transactions";
 }
 //#endregion
+//#region src/withdrawals/interfaces/withdrawal.interface.d.ts
+type WithdrawalStatus = 'pending' | 'processing' | 'completed' | 'failed';
+type PixKeyType = 'cpf' | 'cnpj' | 'email' | 'phone' | 'random';
+interface Withdrawal {
+  id: string;
+  bankAccountId: string | null;
+  amount: number;
+  feeAmount: number;
+  netAmount: number;
+  status: WithdrawalStatus;
+  snapshotPixKey: string | null;
+  snapshotPixKeyType: PixKeyType | null;
+  snapshotHolderName: string;
+  snapshotHolderDocument: string;
+  failureReason: string | null;
+  pspReference: string | null;
+  createdAt: string;
+  processedAt: string | null;
+}
+//#endregion
+//#region src/withdrawals/interfaces/create-withdrawal.interface.d.ts
+interface CreateWithdrawalOptions {
+  amount: number;
+  bankAccountId?: string;
+  pixKey?: string;
+  pixKeyType?: PixKeyType;
+  holderName?: string;
+  holderDocument?: string;
+  holderDocumentType?: 'cpf' | 'cnpj';
+}
+type CreateWithdrawalResponse = Response<Withdrawal>;
+//#endregion
+//#region src/withdrawals/withdrawals.d.ts
+declare class Withdrawals extends CreateOnlyResource<Withdrawal, CreateWithdrawalOptions> {
+  protected readonly endpoint = "/withdrawals";
+}
+//#endregion
 //#region src/pdev.d.ts
 declare class Pdev {
   readonly key: string;
@@ -271,6 +308,7 @@ declare class Pdev {
   readonly projects: Projects;
   readonly charges: Charges;
   readonly transactions: Transactions;
+  readonly withdrawals: Withdrawals;
   constructor(key?: string);
   post<T>(path: string, body?: unknown, options?: PostOptions): Promise<Response<T>>;
   get<T>(path: string, options?: GetOptions): Promise<Response<T>>;
@@ -479,4 +517,4 @@ interface WebhookHeaders {
  */
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, parseWebhook };
+export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, CreateWithdrawalOptions, CreateWithdrawalResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixKeyType, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, Withdrawal, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, WithdrawalStatus, parseWebhook };

package/dist/index.mjs

@@ -93,6 +93,12 @@ var Transactions = class extends GetOnlyResource {
 	endpoint = "/transactions";
 };
 
+//#endregion
+//#region src/withdrawals/withdrawals.ts
+var Withdrawals = class extends CreateOnlyResource {
+	endpoint = "/withdrawals";
+};
+
 //#endregion
 //#region src/pdev.ts
 var Pdev = class {
@@ -104,6 +110,7 @@ var Pdev = class {
 	projects;
 	charges;
 	transactions;
+	withdrawals;
 	constructor(key) {
 		if (!key) {
 			if (typeof process !== "undefined" && process.env) this.key = process.env.PDEV_API_KEY || "";
@@ -120,6 +127,7 @@ var Pdev = class {
 		this.projects = new Projects(this);
 		this.charges = new Charges(this);
 		this.transactions = new Transactions(this);
+		this.withdrawals = new Withdrawals(this);
 	}
 	async post(path, body, options = {}) {
 		const url = this.buildUrl(path, options.query);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pague-dev/sdk-node",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "Node.js SDK for the pague.dev API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",