Merge pull request #133 from m7ez1n/master

feat: implement smart transfers preauthorization and payment endpoints

Author: cernadasjuan

.gitignore

@@ -4,4 +4,6 @@ dist
 # Dependencies
 node_modules
 
-.vscode
+.vscode
+
+.env.local

package-lock.json

@@ -200,11 +200,9 @@ export class PluggyClient extends BaseApi {
    * @param accountId The account id
    * @returns {PageResponse<AccountStatement[]>} object which contains the Account statements list and related paging data
    */
-    async fetchAccountStatements(
-      accountId: string
-    ): Promise<PageResponse<AccountStatement>> {
-      return await this.createGetRequest(`accounts/${accountId}/statements`)
-    }
+  async fetchAccountStatements(accountId: string): Promise<PageResponse<AccountStatement>> {
+    return await this.createGetRequest(`accounts/${accountId}/statements`)
+  }
 
   /**
    * Post transaction user category for transactin

src/client.ts

@@ -29,6 +29,11 @@ import {
   RetryAutomaticPixPaymentRequest,
   AutomaticPixPaymentListResponse,
   PaymentPixAutomaticFilters,
+  SmartTransferPreauthorization,
+  CreateSmartTransferPreauthorization,
+  SmartTransferPayment,
+  CreateSmartTransferPayment,
+  SmartTransferPreauthorizationsFilters,
 } from './types'
 
 /**
@@ -410,4 +415,55 @@ export class PluggyPaymentsClient extends BaseApi {
   async cancelAutomaticPixAuthorization(paymentRequestId: string): Promise<void> {
     await this.createPostRequest(`payments/requests/${paymentRequestId}/automatic-pix/cancel`)
   }
+
+  /**
+   * Fetch all smart transfer preauthorizations
+   * @param options SmartTransferPreauthorizationsFilters with page and pageSize
+   * @returns {PageResponse<SmartTransferPreauthorization>} paged response of smart transfer preauthorizations
+   */
+  async fetchSmartTransferPreauthorizations(
+    options: SmartTransferPreauthorizationsFilters = {}
+  ): Promise<PageResponse<SmartTransferPreauthorization>> {
+    return await this.createGetRequest('smart-transfers/preauthorizations', { ...options })
+  }
+
+  /**
+   * Creates a smart transfer preauthorization
+   * @param payload CreateSmartTransferPreauthorization
+   * @returns {SmartTransferPreauthorization} SmartTransferPreauthorization object
+   */
+  async createSmartTransferPreauthorization(
+    payload: CreateSmartTransferPreauthorization
+  ): Promise<SmartTransferPreauthorization> {
+    return await this.createPostRequest('smart-transfers/preauthorizations', null, payload)
+  }
+
+  /**
+   * Fetch a single smart transfer preauthorization
+   * @param id ID of the smart transfer preauthorization
+   * @returns {SmartTransferPreauthorization} SmartTransferPreauthorization object
+   */
+  async fetchSmartTransferPreauthorization(id: string): Promise<SmartTransferPreauthorization> {
+    return await this.createGetRequest(`smart-transfers/preauthorizations/${id}`)
+  }
+
+  /**
+   * Creates a smart transfer payment
+   * @param payload CreateSmartTransferPayment
+   * @returns {SmartTransferPayment} SmartTransferPayment object
+   */
+  async createSmartTransferPayment(
+    payload: CreateSmartTransferPayment
+  ): Promise<SmartTransferPayment> {
+    return await this.createPostRequest('smart-transfers/payments', null, payload)
+  }
+
+  /**
+   * Fetch a single smart transfer payment
+   * @param id ID of the smart transfer payment
+   * @returns {SmartTransferPayment} SmartTransferPayment object
+   */
+  async fetchSmartTransferPayment(id: string): Promise<SmartTransferPayment> {
+    return await this.createGetRequest(`smart-transfers/payments/${id}`)
+  }
 }

src/paymentsClient.ts

@@ -79,4 +79,3 @@ export type DeserializedItem = Omit<
 export type DeserializedTransaction = Omit<Transaction, 'date'> & {
   date: string
 }
-

src/types/deserialized.ts

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

src/types/payments/index.ts

@@ -1,4 +1,4 @@
-import { Connector } from "../connector"
+import { Connector } from '../connector'
 
 export const PAYMENT_CUSTOMER_TYPE = ['INDIVIDUAL', 'BUSINESS'] as const
 

src/types/payments/paymentCustomer.ts

@@ -9,3 +9,5 @@ export type PaymentRecipientsFilters = PageFilters
 export type PaymentCustomersFilters = PageFilters
 
 export type PaymentInstitutionsFilters = PageFilters & { name?: string }
+
+export type SmartTransferPreauthorizationsFilters = PageFilters

src/types/payments/paymentFilters.ts

@@ -1,4 +1,4 @@
-import type { PaymentCustomer } from './paymentCustomer'
+import { PaymentCustomer } from './paymentCustomer'
 import { PaymentRecipient } from './paymentRecipient'
 
 export declare const DAYS_OF_WEEK: readonly [
@@ -89,35 +89,41 @@ export type CustomSchedule = {
   additionalInformation?: string
 }
 
-export const AUTOMATIC_PIX_INTERVALS = ["WEEKLY", "MONTHLY", "QUARTERLY", "SEMESTER", "YEARLY"] as const;
-export type AutomaticPixInterval = typeof AUTOMATIC_PIX_INTERVALS[number];
+export const AUTOMATIC_PIX_INTERVALS = [
+  'WEEKLY',
+  'MONTHLY',
+  'QUARTERLY',
+  'SEMESTER',
+  'YEARLY',
+] as const
+export type AutomaticPixInterval = typeof AUTOMATIC_PIX_INTERVALS[number]
 
 export type AutomaticPixFirstPayment = {
   /**! date of the first payment, default to instant */
-  date?: string;
+  date?: string
   /**! amount of the first payment */
-  amount: number;
+  amount: number
   /**! description of the first payment */
-  description?: string;
-};  
+  description?: string
+}
 
 export type PaymentRequestAutomaticPixDetails = {
   /**! interval of the authorization */
-  interval: AutomaticPixInterval;
+  interval: AutomaticPixInterval
   /**! start date of the authorization */
-  startDate: string;
+  startDate: string
   /**! fixed amount of the payment, if provided can't be used with minimumVariableAmount or maximumVariableAmount */
-  fixedAmount?: number;
+  fixedAmount?: number
   /**! minimum variable amount of the payment, if provided can't be used with fixedAmount */
-  minimumVariableAmount?: number;
+  minimumVariableAmount?: number
   /**! maximum variable amount of the payment, if provided can't be used with fixedAmount */
-  maximumVariableAmount?: number;
+  maximumVariableAmount?: number
   /**! expiration date of the authorization */
-  expiresAt?: string;
+  expiresAt?: string
   /**! if the payments done for this authorization can be retried */
-  isRetryAccepted?: boolean;
+  isRetryAccepted?: boolean
   /**! if provided, will execute a first payment */
-  firstPayment?: AutomaticPixFirstPayment;
+  firstPayment?: AutomaticPixFirstPayment
 }
 
 export type PaymentRequest = {
@@ -162,4 +168,8 @@ export type CallbackUrls = {
   error?: string
 }
 
-export type CreatePaymentRequestAutomaticPix = Pick<CreatePaymentRequest, 'description' | 'recipientId' | 'customerId' | 'callbackUrls' | 'clientPaymentId'> & PaymentRequestAutomaticPixDetails & { isSandbox: boolean }
+export type CreatePaymentRequestAutomaticPix = Pick<
+  CreatePaymentRequest,
+  'description' | 'recipientId' | 'customerId' | 'callbackUrls' | 'clientPaymentId'
+> &
+  PaymentRequestAutomaticPixDetails & { isSandbox: boolean }

src/types/payments/paymentRequest.ts

@@ -0,0 +1,85 @@
+import { Connector } from '../connector'
+import { PaymentInstitution } from './paymentInstitution'
+import {
+  PaymentRecipient,
+  PaymentRecipientAccount,
+  PaymentRecipientBankAccountType,
+} from './paymentRecipient'
+import { Parameters } from '../item'
+
+export const SMART_TRANSFER_PREAUTHORIZATION_STATUS = [
+  'CREATED',
+  'COMPLETED',
+  'REVOKED',
+  'REJECTED',
+  'ERROR',
+] as const
+
+export type SmartTransferPreauthorizationStatus = typeof SMART_TRANSFER_PREAUTHORIZATION_STATUS[number]
+
+export const SMART_TRANSFER_PAYMENT_STATUS = [
+  'PAYMENT_REJECTED',
+  'ERROR',
+  'CANCELED',
+  'CONSENT_REJECTED',
+  'CONSENT_AUTHORIZED',
+  'PAYMENT_PENDING',
+  'PAYMENT_PARTIALLY_ACCEPTED',
+  'PAYMENT_SETTLEMENT_PROCESSING',
+  'PAYMENT_SETTLEMENT_DEBTOR_ACCOUNT',
+  'PAYMENT_COMPLETED',
+] as const
+
+export type SmartTransferPaymentStatus = typeof SMART_TRANSFER_PAYMENT_STATUS[number]
+
+export type SmartTransferRecipient = Pick<
+  PaymentRecipient,
+  'id' | 'name' | 'taxNumber' | 'isDefault' | 'paymentInstitution' | 'account'
+> & {
+  pixKey: string | null
+}
+
+export type SmartTransferPreauthorization = {
+  id: string
+  status: SmartTransferPreauthorizationStatus
+  consentUrl: string | null
+  clientPreauthorizationId: string | null
+  callbackUrls: {
+    success?: string
+    error?: string
+  } | null
+  recipients: SmartTransferRecipient[]
+  connector: Connector
+  createdAt: Date
+  updatedAt: Date
+}
+
+export type CreateSmartTransferPreauthorization = {
+  connectorId: number
+  parameters: Parameters
+  recipientIds: string[]
+  callbackUrls?: {
+    success?: string
+    error?: string
+  }
+}
+
+export type CreateSmartTransferPayment = {
+  preauthorizationId: string
+  recipientId: string
+  amount: number
+  description?: string
+  clientPaymentId?: string
+}
+
+export type SmartTransferPayment = {
+  id: string
+  preauthorizationId: string
+  status: SmartTransferPaymentStatus
+  amount: number
+  description: string | null
+  recipient: SmartTransferRecipient
+  createdAt: Date
+  updatedAt: Date
+  clientPaymentId: string | null
+}