fix: add missing payments methods

Author: Gabrielpanga

src/paymentsClient.ts

@@ -24,6 +24,11 @@ import {
   SchedulePayment,
   PaymentRequestAutomaticPix,
   CreatePaymentRequestAutomaticPix,
+  AutomaticPixPayment,
+  ScheduleAutomaticPixPaymentRequest,
+  RetryAutomaticPixPaymentRequest,
+  AutomaticPixPaymentListResponse,
+  PaymentPixAutomaticFilters,
 } from './types'
 
 /**
@@ -316,4 +321,93 @@ export class PluggyPaymentsClient extends BaseApi {
   async cancelScheduledPayments(paymentRequest: string): Promise<void> {
     await this.createPostRequest(`payments/requests/${paymentRequest}/schedules/cancel`)
   }
+
+  /**
+   * Schedule a new payment for an existing Pix Automático authorization
+   * @param authorizationId ID of the Pix Automático authorization
+   * @param payload ScheduleAutomaticPixPaymentRequest
+   * @returns {AutomaticPixPayment} AutomaticPixPayment object
+   */
+  async scheduleAutomaticPixPayment(
+    authorizationId: string,
+    payload: ScheduleAutomaticPixPaymentRequest
+  ): Promise<AutomaticPixPayment> {
+    return await this.createPostRequest(
+      `payments/requests/${authorizationId}/automatic-pix/schedule`,
+      null,
+      payload
+    )
+  }
+
+  /**
+   * Retry a failed scheduled Pix Automático payment
+   * @param paymentRequestId ID of the payment request
+   * @param automaticPixPaymentId ID of the Pix Automático authorization
+   * @param payload RetryAutomaticPixPaymentRequest
+   * @returns {AutomaticPixPayment} AutomaticPixPayment object
+   */
+  async retryAutomaticPixPayment(
+    paymentRequestId: string,
+    automaticPixPaymentId: string,
+    payload: RetryAutomaticPixPaymentRequest
+  ): Promise<AutomaticPixPayment> {
+    return await this.createPostRequest(
+      `payments/requests/${paymentRequestId}/automatic-pix/schedules/${automaticPixPaymentId}/retry`,
+      null,
+      payload
+    )
+  }
+
+  /**
+   * List scheduled Pix Automático payments for an authorization
+   * @param automaticPixPaymentId ID of the Pix Automático authorization
+   * @param options PaymentPixAutomaticFilters
+   * @returns {AutomaticPixPaymentListResponse} List of scheduled payments
+   */
+  async fetchAutomaticPixPayments(
+    automaticPixPaymentId: string,
+    options: PaymentPixAutomaticFilters
+  ): Promise<AutomaticPixPaymentListResponse> {
+    return await this.createGetRequest(
+      `payments/requests/${automaticPixPaymentId}/automatic-pix/schedules`,
+      options
+    )
+  }
+
+  /**
+   * Fetch a single scheduled Pix Automático payment
+   * @param paymentRequestId ID of the payment request
+   * @param automaticPixPaymentId ID of the Pix Automático authorization
+   * @returns {AutomaticPixPayment} AutomaticPixPayment object
+   */
+  async fetchAutomaticPixPayment(
+    paymentRequestId: string,
+    automaticPixPaymentId: string
+  ): Promise<AutomaticPixPayment> {
+    return await this.createGetRequest(
+      `payments/requests/${paymentRequestId}/automatic-pix/schedules/${automaticPixPaymentId}`
+    )
+  }
+
+  /**
+   * Cancel a scheduled Pix Automático payment
+   * @param paymentRequestId ID of the payment request
+   * @param automaticPixPaymentId ID of the Pix Automático authorization
+   */
+  async cancelAutomaticPixPayment(
+    paymentRequestId: string,
+    automaticPixPaymentId: string
+  ): Promise<void> {
+    await this.createPostRequest(
+      `payments/requests/${paymentRequestId}/automatic-pix/schedules/${automaticPixPaymentId}/cancel`
+    )
+  }
+
+  /**
+   * Cancel all scheduled Pix Automático payments for a payment request authorization
+   * @param paymentRequestId ID of the payment request
+   */
+  async cancelAutomaticPixAuthorization(paymentRequestId: string): Promise<void> {
+    await this.createPostRequest(`payments/requests/${paymentRequestId}/automatic-pix/cancel`)
+  }
 }

src/types/payments/index.ts

@@ -8,3 +8,4 @@ export * from './smartAccount'
 export * from './bulkPayment'
 export * from './paymentReceipt'
 export * from './schedulePayment'
+export * from './pixAutomatic'

src/types/payments/pixAutomatic.ts

@@ -0,0 +1,40 @@
+import { PageFilters, PageResponse } from '../common'
+
+export const AUTOMATIC_PIX_PAYMENT_STATUSES = [
+  'SCHEDULED',
+  'CREATED',
+  'COMPLETED',
+  'CANCELED',
+  'ERROR',
+] as const
+export type AutomaticPixPaymentStatus = typeof AUTOMATIC_PIX_PAYMENT_STATUSES[number]
+
+export type AutomaticPixPaymentErrorDetail = {
+  code: string
+  description: string
+  detail?: string
+}
+
+export type AutomaticPixPayment = {
+  id: string
+  status: AutomaticPixPaymentStatus
+  amount: number
+  description?: string
+  date: string // YYYY-MM-DD
+  endToEndId?: string
+  errorDetail?: AutomaticPixPaymentErrorDetail | null
+}
+
+export type ScheduleAutomaticPixPaymentRequest = {
+  amount: number
+  description?: string
+  date: string // YYYY-MM-DD
+}
+
+export type RetryAutomaticPixPaymentRequest = {
+  date: string // YYYY-MM-DD
+}
+
+export type AutomaticPixPaymentListResponse = PageResponse<AutomaticPixPayment>
+
+export type PaymentPixAutomaticFilters = PageFilters