@lorenstuff/paypal-api - npm Package Compare versions

Comparing version 0.2.1 to 1.0.0

CHANGELOG.md

@@ -0,1 +1,7 @@
+## 1.0.0
+Completely rewrote the library with full type coverage for the Orders and Webhooks Management APIs, as well as a fully implemented PayPalOrdersClient class.
+
+## 0.2.2
+Removed eslint and related packages.
+
 ## 0.2.1
@@ -2,0 +8,0 @@ Forgot to export those types, woops.

lib/index.d.ts

@@ -1,6 +0,164 @@
-export * from "./classes/PayPal.js";
-export * from "./types/AddTracking.js";
-export * from "./types/Orders.js";
-export * from "./types/Payments.js";
-export * from "./types/Shared.js";
-export * from "./types/WebhooksManagement.js";
+export * from "./classes/PayPalClient.js";
+export * from "./classes/PayPalOrdersClient.js";
+export * from "./classes/PayPalWebhooksManagementClient.js";
+export * from "./types/oauth/PayPalOAuthToken.js";
+export * from "./types/oauth/PayPalOAuthTokenError.js";
+export * from "./types/orders/PayPalActivityTimestamps.js";
+export * from "./types/orders/PayPalAmountBreakdown.js";
+export * from "./types/orders/PayPalAmountWithBreakdown.js";
+export * from "./types/orders/PayPalApplePayDecryptedTokenData.js";
+export * from "./types/orders/PayPalApplePayPaymentData.js";
+export * from "./types/orders/PayPalApplePayRequest.js";
+export * from "./types/orders/PayPalApplicationContext.js";
+export * from "./types/orders/PayPalAuthenticationResponse.js";
+export * from "./types/orders/PayPalAuthorization.js";
+export * from "./types/orders/PayPalAuthorizationStatus.js";
+export * from "./types/orders/PayPalAuthorizationStatusDetails.js";
+export * from "./types/orders/PayPalAuthorizationWithAdditionalData.js";
+export * from "./types/orders/PayPalAuthorizeRequest.js";
+export * from "./types/orders/PayPalBancontact.js";
+export * from "./types/orders/PayPalBancontactRequest.js";
+export * from "./types/orders/PayPalBINDetails.js";
+export * from "./types/orders/PayPalBLIK.js";
+export * from "./types/orders/PayPalBLIKExperienceContext.js";
+export * from "./types/orders/PayPalBLIKLevel0.js";
+export * from "./types/orders/PayPalBLIKOneClick.js";
+export * from "./types/orders/PayPalBLIKOneClickResponse.js";
+export * from "./types/orders/PayPalBLIKRequest.js";
+export * from "./types/orders/PayPalCapture.js";
+export * from "./types/orders/PayPalCaptureStatus.js";
+export * from "./types/orders/PayPalCaptureStatusDetails.js";
+export * from "./types/orders/PayPalCard.js";
+export * from "./types/orders/PayPalCardAttributes.js";
+export * from "./types/orders/PayPalCardAttributesResponse.js";
+export * from "./types/orders/PayPalCardBrand.js";
+export * from "./types/orders/PayPalCardExperienceContext.js";
+export * from "./types/orders/PayPalCardFromRequest.js";
+export * from "./types/orders/PayPalCardRequest.js";
+export * from "./types/orders/PayPalCardResponse.js";
+export * from "./types/orders/PayPalCardStoredCredential.js";
+export * from "./types/orders/PayPalCardSupplementaryData.js";
+export * from "./types/orders/PayPalCardType.js";
+export * from "./types/orders/PayPalCarrier.js";
+export * from "./types/orders/PayPalCheckoutPaymentIntent.js";
+export * from "./types/orders/PayPalCobrandedCard.js";
+export * from "./types/orders/PayPalConfirmApplicationContext.js";
+export * from "./types/orders/PayPalConfirmOrderRequest.js";
+export * from "./types/orders/PayPalCustomer.js";
+export * from "./types/orders/PayPalDisbursementMode.js";
+export * from "./types/orders/PayPalECIFlag.js";
+export * from "./types/orders/PayPalEnrolled.js";
+export * from "./types/orders/PayPalEPS.js";
+export * from "./types/orders/PayPalEPSRequest.js";
+export * from "./types/orders/PayPalExchangeRate.js";
+export * from "./types/orders/PayPalExperienceContextBase.js";
+export * from "./types/orders/PayPalGiropay.js";
+export * from "./types/orders/PayPalGiropayRequest.js";
+export * from "./types/orders/PayPalIdeal.js";
+export * from "./types/orders/PayPalIdealRequest.js";
+export * from "./types/orders/PayPalItem.js";
+export * from "./types/orders/PayPalLevel2.js";
+export * from "./types/orders/PayPalLevel3.js";
+export * from "./types/orders/PayPalLiabilityShift.js";
+export * from "./types/orders/PayPalLineItem.js";
+export * from "./types/orders/PayPalMoney.js";
+export * from "./types/orders/PayPalMyBank.js";
+export * from "./types/orders/PayPalMyBankRequest.js";
+export * from "./types/orders/PayPalName.js";
+export * from "./types/orders/PayPalNetAmountBreakdown.js";
+export * from "./types/orders/PayPalNetworkToken.js";
+export * from "./types/orders/PayPalNetworkTransactionReference.js";
+export * from "./types/orders/PayPalOrder.js";
+export * from "./types/orders/PayPalOrderCaptureRequest.js";
+export * from "./types/orders/PayPalOrderRequest.js";
+export * from "./types/orders/PayPalOrderStatus.js";
+export * from "./types/orders/PayPalP24.js";
+export * from "./types/orders/PayPalP24Request.js";
+export * from "./types/orders/PayPalParesStatus.js";
+export * from "./types/orders/PayPalPayee.js";
+export * from "./types/orders/PayPalPayeePaymentMethodPreference.js";
+export * from "./types/orders/PayPalPayer.js";
+export * from "./types/orders/PayPalPayerBase.js";
+export * from "./types/orders/PayPalPaymentCollection.js";
+export * from "./types/orders/PayPalPaymentInitiator.js";
+export * from "./types/orders/PayPalPaymentInstruction.js";
+export * from "./types/orders/PayPalPaymentMethod.js";
+export * from "./types/orders/PayPalPaymentSource.js";
+export * from "./types/orders/PayPalPaymentSourceResponse.js";
+export * from "./types/orders/PayPalPhone.js";
+export * from "./types/orders/PayPalPhoneType.js";
+export * from "./types/orders/PayPalPhoneWithType.js";
+export * from "./types/orders/PayPalPlatformFee.js";
+export * from "./types/orders/PayPalPortablePostalAddressMediumGrained.js";
+export * from "./types/orders/PayPalProcessingInstruction.js";
+export * from "./types/orders/PayPalProcessorResponse.js";
+export * from "./types/orders/PayPalPurchaseUnit.js";
+export * from "./types/orders/PayPalPurchaseUnitRequest.js";
+export * from "./types/orders/PayPalRefund.js";
+export * from "./types/orders/PayPalRefundStatus.js";
+export * from "./types/orders/PayPalRefundStatusDetails.js";
+export * from "./types/orders/PayPalSellerPayableBreakdown.js";
+export * from "./types/orders/PayPalSellerProtection.js";
+export * from "./types/orders/PayPalSellerReceivableBreakdown.js";
+export * from "./types/orders/PayPalShippingDetail.js";
+export * from "./types/orders/PayPalShippingOption.js";
+export * from "./types/orders/PayPalShippingType.js";
+export * from "./types/orders/PayPalShippingWithTrackingDetails.js";
+export * from "./types/orders/PayPalSofort.js";
+export * from "./types/orders/PayPalSofortRequest.js";
+export * from "./types/orders/PayPalStoredPaymentSource.js";
+export * from "./types/orders/PayPalStoredPaymentSourcePaymentType.js";
+export * from "./types/orders/PayPalStoredPaymentSourceUsageType.js";
+export * from "./types/orders/PayPalStoreInVaultInstruction.js";
+export * from "./types/orders/PayPalSupplementaryData.js";
+export * from "./types/orders/PayPalTaxInfo.js";
+export * from "./types/orders/PayPalThreeDSecureAuthenticationResponse.js";
+export * from "./types/orders/PayPalToken.js";
+export * from "./types/orders/PayPalTracker.js";
+export * from "./types/orders/PayPalTrackerItem.js";
+export * from "./types/orders/PayPalTrackerRequest.js";
+export * from "./types/orders/PayPalTrackerResponse.js";
+export * from "./types/orders/PayPalTrackerStatus.js";
+export * from "./types/orders/PayPalTrackingNumberType.js";
+export * from "./types/orders/PayPalTrackingStatus.js";
+export * from "./types/orders/PayPalTrustly.js";
+export * from "./types/orders/PayPalTrustlyRequest.js";
+export * from "./types/orders/PayPalVaultInstructionBase.js";
+export * from "./types/orders/PayPalVaultPayPalWalletBase.js";
+export * from "./types/orders/PayPalVaultResponse.js";
+export * from "./types/orders/PayPalVaultVenmoWalletBase.js";
+export * from "./types/orders/PayPalVenmoWalletAttributes.js";
+export * from "./types/orders/PayPalVenmoWalletAttributesResponse.js";
+export * from "./types/orders/PayPalVenmoWalletExperienceContext.js";
+export * from "./types/orders/PayPalVenmoWalletRequest.js";
+export * from "./types/orders/PayPalVenmoWalletResponse.js";
+export * from "./types/orders/PayPalWallet.js";
+export * from "./types/orders/PayPalWalletAttributes.js";
+export * from "./types/orders/PayPalWalletAttributesResponse.js";
+export * from "./types/orders/PayPalWalletCustomer.js";
+export * from "./types/orders/PayPalWalletExperienceContext.js";
+export * from "./types/orders/PayPalWalletResponse.js";
+export * from "./types/orders/PayPalWalletVaultResponse.js";
+export * from "./types/webhooks-management/PayPalBaseStatusReport.js";
+export * from "./types/webhooks-management/PayPalClassifiers.js";
+export * from "./types/webhooks-management/PayPalDeliveryStatus.js";
+export * from "./types/webhooks-management/PayPalDestination.js";
+export * from "./types/webhooks-management/PayPalErrorType.js";
+export * from "./types/webhooks-management/PayPalEvent.js";
+export * from "./types/webhooks-management/PayPalEventList.js";
+export * from "./types/webhooks-management/PayPalEventResend.js";
+export * from "./types/webhooks-management/PayPalEventType.js";
+export * from "./types/webhooks-management/PayPalEventTypeList.js";
+export * from "./types/webhooks-management/PayPalSimulateEvent.js";
+export * from "./types/webhooks-management/PayPalVerifyWebhookSignature.js";
+export * from "./types/webhooks-management/PayPalVerifyWebhookSignatureResponse.js";
+export * from "./types/webhooks-management/PayPalWebhook.js";
+export * from "./types/webhooks-management/PayPalWebhookList.js";
+export * from "./types/webhooks-management/PayPalWebhookLookup.js";
+export * from "./types/webhooks-management/PayPalWebhookLookupList.js";
+export * from "./types/PayPalError.js";
+export * from "./types/PayPalErrorDetails.js";
+export * from "./types/PayPalLinkDescription.js";
+export * from "./types/PayPalPatch.js";
+export * from "./types/PayPalPatchRequest.js";
+//# sourceMappingURL=index.d.ts.map

lib/index.js

 //
 // Exports
 //
-export * from "./classes/PayPal.js";
-export * from "./types/AddTracking.js";
-export * from "./types/Orders.js";
-export * from "./types/Payments.js";
-export * from "./types/Shared.js";
-export * from "./types/WebhooksManagement.js";
+export * from "./classes/PayPalClient.js";
+export * from "./classes/PayPalOrdersClient.js";
+export * from "./classes/PayPalWebhooksManagementClient.js";
+export * from "./types/oauth/PayPalOAuthToken.js";
+export * from "./types/oauth/PayPalOAuthTokenError.js";
+export * from "./types/orders/PayPalActivityTimestamps.js";
+export * from "./types/orders/PayPalAmountBreakdown.js";
+export * from "./types/orders/PayPalAmountWithBreakdown.js";
+export * from "./types/orders/PayPalApplePayDecryptedTokenData.js";
+export * from "./types/orders/PayPalApplePayPaymentData.js";
+export * from "./types/orders/PayPalApplePayRequest.js";
+export * from "./types/orders/PayPalApplicationContext.js";
+export * from "./types/orders/PayPalAuthenticationResponse.js";
+export * from "./types/orders/PayPalAuthorization.js";
+export * from "./types/orders/PayPalAuthorizationStatus.js";
+export * from "./types/orders/PayPalAuthorizationStatusDetails.js";
+export * from "./types/orders/PayPalAuthorizationWithAdditionalData.js";
+export * from "./types/orders/PayPalAuthorizeRequest.js";
+export * from "./types/orders/PayPalBancontact.js";
+export * from "./types/orders/PayPalBancontactRequest.js";
+export * from "./types/orders/PayPalBINDetails.js";
+export * from "./types/orders/PayPalBLIK.js";
+export * from "./types/orders/PayPalBLIKExperienceContext.js";
+export * from "./types/orders/PayPalBLIKLevel0.js";
+export * from "./types/orders/PayPalBLIKOneClick.js";
+export * from "./types/orders/PayPalBLIKOneClickResponse.js";
+export * from "./types/orders/PayPalBLIKRequest.js";
+export * from "./types/orders/PayPalCapture.js";
+export * from "./types/orders/PayPalCaptureStatus.js";
+export * from "./types/orders/PayPalCaptureStatusDetails.js";
+export * from "./types/orders/PayPalCard.js";
+export * from "./types/orders/PayPalCardAttributes.js";
+export * from "./types/orders/PayPalCardAttributesResponse.js";
+export * from "./types/orders/PayPalCardBrand.js";
+export * from "./types/orders/PayPalCardExperienceContext.js";
+export * from "./types/orders/PayPalCardFromRequest.js";
+export * from "./types/orders/PayPalCardRequest.js";
+export * from "./types/orders/PayPalCardResponse.js";
+export * from "./types/orders/PayPalCardStoredCredential.js";
+export * from "./types/orders/PayPalCardSupplementaryData.js";
+export * from "./types/orders/PayPalCardType.js";
+export * from "./types/orders/PayPalCarrier.js";
+export * from "./types/orders/PayPalCheckoutPaymentIntent.js";
+export * from "./types/orders/PayPalCobrandedCard.js";
+export * from "./types/orders/PayPalConfirmApplicationContext.js";
+export * from "./types/orders/PayPalConfirmOrderRequest.js";
+export * from "./types/orders/PayPalCustomer.js";
+export * from "./types/orders/PayPalDisbursementMode.js";
+export * from "./types/orders/PayPalECIFlag.js";
+export * from "./types/orders/PayPalEnrolled.js";
+export * from "./types/orders/PayPalEPS.js";
+export * from "./types/orders/PayPalEPSRequest.js";
+export * from "./types/orders/PayPalExchangeRate.js";
+export * from "./types/orders/PayPalExperienceContextBase.js";
+export * from "./types/orders/PayPalGiropay.js";
+export * from "./types/orders/PayPalGiropayRequest.js";
+export * from "./types/orders/PayPalIdeal.js";
+export * from "./types/orders/PayPalIdealRequest.js";
+export * from "./types/orders/PayPalItem.js";
+export * from "./types/orders/PayPalLevel2.js";
+export * from "./types/orders/PayPalLevel3.js";
+export * from "./types/orders/PayPalLiabilityShift.js";
+export * from "./types/orders/PayPalLineItem.js";
+export * from "./types/orders/PayPalMoney.js";
+export * from "./types/orders/PayPalMyBank.js";
+export * from "./types/orders/PayPalMyBankRequest.js";
+export * from "./types/orders/PayPalName.js";
+export * from "./types/orders/PayPalNetAmountBreakdown.js";
+export * from "./types/orders/PayPalNetworkToken.js";
+export * from "./types/orders/PayPalNetworkTransactionReference.js";
+export * from "./types/orders/PayPalOrder.js";
+export * from "./types/orders/PayPalOrderCaptureRequest.js";
+export * from "./types/orders/PayPalOrderRequest.js";
+export * from "./types/orders/PayPalOrderStatus.js";
+export * from "./types/orders/PayPalP24.js";
+export * from "./types/orders/PayPalP24Request.js";
+export * from "./types/orders/PayPalParesStatus.js";
+export * from "./types/orders/PayPalPayee.js";
+export * from "./types/orders/PayPalPayeePaymentMethodPreference.js";
+export * from "./types/orders/PayPalPayer.js";
+export * from "./types/orders/PayPalPayerBase.js";
+export * from "./types/orders/PayPalPaymentCollection.js";
+export * from "./types/orders/PayPalPaymentInitiator.js";
+export * from "./types/orders/PayPalPaymentInstruction.js";
+export * from "./types/orders/PayPalPaymentMethod.js";
+export * from "./types/orders/PayPalPaymentSource.js";
+export * from "./types/orders/PayPalPaymentSourceResponse.js";
+export * from "./types/orders/PayPalPhone.js";
+export * from "./types/orders/PayPalPhoneType.js";
+export * from "./types/orders/PayPalPhoneWithType.js";
+export * from "./types/orders/PayPalPlatformFee.js";
+export * from "./types/orders/PayPalPortablePostalAddressMediumGrained.js";
+export * from "./types/orders/PayPalProcessingInstruction.js";
+export * from "./types/orders/PayPalProcessorResponse.js";
+export * from "./types/orders/PayPalPurchaseUnit.js";
+export * from "./types/orders/PayPalPurchaseUnitRequest.js";
+export * from "./types/orders/PayPalRefund.js";
+export * from "./types/orders/PayPalRefundStatus.js";
+export * from "./types/orders/PayPalRefundStatusDetails.js";
+export * from "./types/orders/PayPalSellerPayableBreakdown.js";
+export * from "./types/orders/PayPalSellerProtection.js";
+export * from "./types/orders/PayPalSellerReceivableBreakdown.js";
+export * from "./types/orders/PayPalShippingDetail.js";
+export * from "./types/orders/PayPalShippingOption.js";
+export * from "./types/orders/PayPalShippingType.js";
+export * from "./types/orders/PayPalShippingWithTrackingDetails.js";
+export * from "./types/orders/PayPalSofort.js";
+export * from "./types/orders/PayPalSofortRequest.js";
+export * from "./types/orders/PayPalStoredPaymentSource.js";
+export * from "./types/orders/PayPalStoredPaymentSourcePaymentType.js";
+export * from "./types/orders/PayPalStoredPaymentSourceUsageType.js";
+export * from "./types/orders/PayPalStoreInVaultInstruction.js";
+export * from "./types/orders/PayPalSupplementaryData.js";
+export * from "./types/orders/PayPalTaxInfo.js";
+export * from "./types/orders/PayPalThreeDSecureAuthenticationResponse.js";
+export * from "./types/orders/PayPalToken.js";
+export * from "./types/orders/PayPalTracker.js";
+export * from "./types/orders/PayPalTrackerItem.js";
+export * from "./types/orders/PayPalTrackerRequest.js";
+export * from "./types/orders/PayPalTrackerResponse.js";
+export * from "./types/orders/PayPalTrackerStatus.js";
+export * from "./types/orders/PayPalTrackingNumberType.js";
+export * from "./types/orders/PayPalTrackingStatus.js";
+export * from "./types/orders/PayPalTrustly.js";
+export * from "./types/orders/PayPalTrustlyRequest.js";
+export * from "./types/orders/PayPalVaultInstructionBase.js";
+export * from "./types/orders/PayPalVaultPayPalWalletBase.js";
+export * from "./types/orders/PayPalVaultResponse.js";
+export * from "./types/orders/PayPalVaultVenmoWalletBase.js";
+export * from "./types/orders/PayPalVenmoWalletAttributes.js";
+export * from "./types/orders/PayPalVenmoWalletAttributesResponse.js";
+export * from "./types/orders/PayPalVenmoWalletExperienceContext.js";
+export * from "./types/orders/PayPalVenmoWalletRequest.js";
+export * from "./types/orders/PayPalVenmoWalletResponse.js";
+export * from "./types/orders/PayPalWallet.js";
+export * from "./types/orders/PayPalWalletAttributes.js";
+export * from "./types/orders/PayPalWalletAttributesResponse.js";
+export * from "./types/orders/PayPalWalletCustomer.js";
+export * from "./types/orders/PayPalWalletExperienceContext.js";
+export * from "./types/orders/PayPalWalletResponse.js";
+export * from "./types/orders/PayPalWalletVaultResponse.js";
+export * from "./types/webhooks-management/PayPalBaseStatusReport.js";
+export * from "./types/webhooks-management/PayPalClassifiers.js";
+export * from "./types/webhooks-management/PayPalDeliveryStatus.js";
+export * from "./types/webhooks-management/PayPalDestination.js";
+export * from "./types/webhooks-management/PayPalErrorType.js";
+export * from "./types/webhooks-management/PayPalEvent.js";
+export * from "./types/webhooks-management/PayPalEventList.js";
+export * from "./types/webhooks-management/PayPalEventResend.js";
+export * from "./types/webhooks-management/PayPalEventType.js";
+export * from "./types/webhooks-management/PayPalEventTypeList.js";
+export * from "./types/webhooks-management/PayPalSimulateEvent.js";
+export * from "./types/webhooks-management/PayPalVerifyWebhookSignature.js";
+export * from "./types/webhooks-management/PayPalVerifyWebhookSignatureResponse.js";
+export * from "./types/webhooks-management/PayPalWebhook.js";
+export * from "./types/webhooks-management/PayPalWebhookList.js";
+export * from "./types/webhooks-management/PayPalWebhookLookup.js";
+export * from "./types/webhooks-management/PayPalWebhookLookupList.js";
+export * from "./types/PayPalError.js";
+export * from "./types/PayPalErrorDetails.js";
+export * from "./types/PayPalLinkDescription.js";
+export * from "./types/PayPalPatch.js";
+export * from "./types/PayPalPatchRequest.js";
+//# sourceMappingURL=index.js.map

package.json

 {
-  "name": "@lorenstuff/paypal-api",
-  "version": "0.2.1",
-  "description": "A library for interacting with PayPal's API.",
-  "main": "./lib/index.js",
-  "scripts": {
-    "build": "npx rimraf lib && npx tsc",
-    "lint": "eslint . -c ./.eslintrc.cjs",
-    "lint-fix": "eslint . -c ./.eslintrc.cjs --fix",
-    "prepublishOnly": "npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/duckdotapk/npm-paypal-api.git"
-  },
-  "keywords": [
-    "paypal",
-    "api"
-  ],
-  "author": "Loren Goodwin",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/duckdotapk/npm-paypal-api/issues"
-  },
-  "homepage": "https://github.com/duckdotapk/npm-paypal-api#readme",
-  "type": "module",
-  "dependencies": {
-    "luxon": "^3.2.1"
-  },
-  "devDependencies": {
-    "@donutteam/eslint-config": "^2.0.0",
-    "@types/node": "^18.11.18",
-    "eslint": "^8.33.0",
-    "rimraf": "^4.1.2",
-    "typescript": "^4.9.5"
-  }
+	"name": "@lorenstuff/paypal-api",
+	"version": "1.0.0",
+	"description": "A library for interacting with PayPal's API.",
+	"main": "./lib/index.js",
+	"scripts": {
+		"build": "npx rimraf lib && npx tsc",
+		"build:watch": "npx rimraf lib && npx tsc --watch",
+		"prepublishOnly": "npm run build"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/duckdotapk/npm-paypal-api.git"
+	},
+	"keywords": [
+		"paypal",
+		"api"
+	],
+	"author": "Loren Goodwin",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/duckdotapk/npm-paypal-api/issues"
+	},
+	"homepage": "https://github.com/duckdotapk/npm-paypal-api#readme",
+	"type": "module",
+	"dependencies": {
+		"@types/luxon": "^3.4.2",
+		"luxon": "^3.4.4"
+	},
+	"devDependencies": {
+		"@types/node": "^20.11.10",
+		"rimraf": "^5.0.5",
+		"typescript": "^5.3.3"
+	}
 }

README.md

@@ -1,2 +0,2 @@
-# PayPal API
+# PayPalClient API
 A class for interacting with the PayPal API.
@@ -16,8 +16,8 @@
 ## Documentation
-To use the package, simply import the `PayPal` class and create an instance of it with your PayPal Client ID and Secret. You will also need to specify whether the credentials are for sandbox mode or live mode:
+To use the package, simply import the `PayPalClient` class and create an instance of it with your PayPal Client ID and Secret. You will also need to specify whether the credentials are for sandbox mode or live mode:
 
 ```ts
-import { PayPal } from "@lorenstuff/paypal-api";
+import { PayPalClient } from "@lorenstuff/paypal-api";
 
-const paypal = new PayPal(
+const payPalClient = new PayPalClient(
 	{
@@ -30,8 +30,39 @@ sandbox: true,
 
-Once you have an instance of the class, you can call various methods on it such as `createOrder` to interact with the API. There are exhaustive types included as part of this module to help you know what to put.
+Once you have an instance of the class, you can use it to instantiate clients for various PayPal APIs such as the Orders API or the Webhooks Management API:
+```ts
+import { PayPalOrdersClient } from "@lorenstuff/paypal-api";
 
-Also, this is by no means a complete library at the moment and it may be quite some time before it is. That said, I still hope it helps.
+const payPalOrdersClient = new PayPalOrdersClient(
+	{
+		payPalClient,
+	});
 
-More detailed documentation will be coming at a later date.
+// call stuff on payPalOrdersClient such as createOrder or showOrderDetails
+```
 
+Each client implements at least part of its respective API. API coverage information can be found in the next section.
+
+## API Coverage
+Currently, this library only covers portions of PayPal's API.
+
+| API                   | Coverage | Class                          |
+|-----------------------|----------|--------------------------------|
+| Add Tracking          | None     | -                              |
+| Catalog Products      | None     | -                              |
+| Disputes              | None     | -                              |
+| Identity              | None     | -                              | 
+| Invoicing             | None     | -                              |
+| Orders                | Full     | PayPalOrdersClient             |
+| Partner Referrals     | None     | -                              |
+| Payment Experience    | None     | -                              |
+| Payment Method Tokens | None     | -                              |
+| Payments              | None     | -                              |
+| Payouts               | None     | -                              |
+| Referenced Payouts    | None     | -                              |
+| Subscriptions         | None     | -                              |
+| Transaction Search    | None     | -                              |
+| Webhooks Management   | Partial  | PayPalWebhooksManagementClient |
+
+Portions not covered by the classes and types provided in this package can be manually accessed using the `request` method of a `PayPalClient` instance.
+
 ## Changelog
@@ -38,0 +69,0 @@ See [CHANGELOG.md](https://github.com/duckdotapk/npm-paypal-api/blob/main/CHANGELOG.md)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

261493

199.65%

Dev dependency count

3

-40%

Number of package files

665

3594.44%

Lines of code

2566

53.29%

Number of low quality alerts

0

-100%

Number of lines in readme file

70

79.49%

Worsened metrics

Dependency count

2

100%

Number of medium supply chain risk alerts

2

100%

Dependency changes

• + Added

  @types/luxon@^3.4.2

• + Added

  @types/luxon@3.6.2
  (transitive)

• Updated

  luxon@^3.4.4