@kentcdodds/paypal

@kentcdodds/paypal

Intent

Read-only PayPal helpers for invoice lookup, transaction reporting, and reimbursement matching in Kody workflows. Transport is a thin OpenAPI-scaffolded client; Kent-specific search, date-window chunking, and summary shaping stay in package domain helpers.

When To Use

• List or search PayPal invoices by recipient, amount, or invoice number
• Read one invoice by id or summarize invoice fields for review
• Search transaction reporting over a date range for reimbursements or incoming payments
• Run a safe smoke test that samples recent invoices without mutating PayPal state

Required setup

• paypalClientId and paypalClientSecret secrets (user scope) used for OAuth client-credentials access to PayPal REST APIs via oauthClientCredentials
• Defaults to the live PayPal API (api-m.paypal.com); pass environment: 'sandbox' per call to use sandbox instead
• Host approval for api-m.paypal.com (and sandbox if used) stays in the account security UI

OpenAPI surface

Scaffolded from official PayPal specs (auth kind none; package injects a fresh bearer token per call):

• invoicing_v2.json — invoices_list, invoices_get, invoices_search_invoices
• reporting_transactions_v1.json — search_get, balances_get

Exports

• kody:@kentcdodds/paypal — read-only action dispatcher (defaults to smoke-test)
• kody:@kentcdodds/paypal/invoices — invoice list/search helpers (read-only)
• kody:@kentcdodds/paypal/transactions — transaction reporting search (read-only)
• kody:@kentcdodds/paypal/smoke-test — credential and invoice-list smoke test (read-only)

All helpers are read-only. There are no payment, refund, or invoice-send mutations in this package.

Example

import paypal from 'kody:@kentcdodds/paypal'

export default async function main() {
  return await paypal({ action: 'search-invoices', recipientEmail: 'ada@example.com', pageSize: 10 })
}