@paykit-sdk/paypal 1.0.1 → 1.0.3

package/dist/paypal-provider.d.mts

@@ -0,0 +1,66 @@
+import { AbstractPayKitProvider, PayKitProvider, PaykitProviderOptions, CreateCheckoutSchema, Checkout, UpdateCheckoutSchema, CreateCustomerParams, Customer, UpdateCustomerParams, CreateSubscriptionSchema, Subscription, UpdateSubscriptionSchema, CreatePaymentSchema, Payment, UpdatePaymentSchema, CreateRefundSchema, Refund, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
+
+interface PayPalOptions extends PaykitProviderOptions {
+    /**
+     * The client ID for the PayPal API
+     */
+    clientId: string;
+    /**
+     * The client secret for the PayPal API
+     */
+    clientSecret: string;
+    /**
+     * Whether to use the sandbox environment
+     */
+    isSandbox: boolean;
+}
+declare class PayPalProvider extends AbstractPayKitProvider implements PayKitProvider {
+    readonly providerName = "paypal";
+    private client;
+    private ordersController;
+    private paymentsController;
+    private subscriptionsController;
+    private webhookController;
+    constructor(config: PayPalOptions);
+    /**
+     * Checkout management
+     * In PayPal, Order IS the checkout
+     */
+    createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
+    retrieveCheckout: (id: string) => Promise<Checkout>;
+    updateCheckout: (id: string, params: UpdateCheckoutSchema) => Promise<Checkout>;
+    deleteCheckout: (id: string) => Promise<null>;
+    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
+    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
+    deleteCustomer: (id: string) => Promise<null>;
+    retrieveCustomer: (id: string) => Promise<Customer | null>;
+    /**
+     * Subscription management
+     * Would need PayPal Subscriptions API - different from Orders
+     */
+    createSubscription: (params: CreateSubscriptionSchema) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<Subscription>;
+    updateSubscription: (id: string, params: UpdateSubscriptionSchema) => Promise<Subscription>;
+    retrieveSubscription: (id: string) => Promise<Subscription>;
+    deleteSubscription: (id: string) => Promise<null>;
+    /**
+     * Payment management
+     * In PayPal, Order IS the payment
+     */
+    createPayment: (params: CreatePaymentSchema) => Promise<Payment>;
+    updatePayment: (id: string, params: UpdatePaymentSchema) => Promise<Payment>;
+    retrievePayment: (id: string) => Promise<Payment | null>;
+    deletePayment: (id: string) => Promise<null>;
+    capturePayment: (id: string) => Promise<Payment>;
+    cancelPayment: (id: string) => Promise<Payment>;
+    /**
+     * Refund management
+     */
+    createRefund: (params: CreateRefundSchema) => Promise<Refund>;
+    /**
+     * Webhook management
+     */
+    handleWebhook: (params: HandleWebhookParams) => Promise<Array<WebhookEventPayload>>;
+}
+
+export { type PayPalOptions, PayPalProvider };

package/dist/paypal-provider.d.ts

@@ -0,0 +1,66 @@
+import { AbstractPayKitProvider, PayKitProvider, PaykitProviderOptions, CreateCheckoutSchema, Checkout, UpdateCheckoutSchema, CreateCustomerParams, Customer, UpdateCustomerParams, CreateSubscriptionSchema, Subscription, UpdateSubscriptionSchema, CreatePaymentSchema, Payment, UpdatePaymentSchema, CreateRefundSchema, Refund, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
+
+interface PayPalOptions extends PaykitProviderOptions {
+    /**
+     * The client ID for the PayPal API
+     */
+    clientId: string;
+    /**
+     * The client secret for the PayPal API
+     */
+    clientSecret: string;
+    /**
+     * Whether to use the sandbox environment
+     */
+    isSandbox: boolean;
+}
+declare class PayPalProvider extends AbstractPayKitProvider implements PayKitProvider {
+    readonly providerName = "paypal";
+    private client;
+    private ordersController;
+    private paymentsController;
+    private subscriptionsController;
+    private webhookController;
+    constructor(config: PayPalOptions);
+    /**
+     * Checkout management
+     * In PayPal, Order IS the checkout
+     */
+    createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
+    retrieveCheckout: (id: string) => Promise<Checkout>;
+    updateCheckout: (id: string, params: UpdateCheckoutSchema) => Promise<Checkout>;
+    deleteCheckout: (id: string) => Promise<null>;
+    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
+    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
+    deleteCustomer: (id: string) => Promise<null>;
+    retrieveCustomer: (id: string) => Promise<Customer | null>;
+    /**
+     * Subscription management
+     * Would need PayPal Subscriptions API - different from Orders
+     */
+    createSubscription: (params: CreateSubscriptionSchema) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<Subscription>;
+    updateSubscription: (id: string, params: UpdateSubscriptionSchema) => Promise<Subscription>;
+    retrieveSubscription: (id: string) => Promise<Subscription>;
+    deleteSubscription: (id: string) => Promise<null>;
+    /**
+     * Payment management
+     * In PayPal, Order IS the payment
+     */
+    createPayment: (params: CreatePaymentSchema) => Promise<Payment>;
+    updatePayment: (id: string, params: UpdatePaymentSchema) => Promise<Payment>;
+    retrievePayment: (id: string) => Promise<Payment | null>;
+    deletePayment: (id: string) => Promise<null>;
+    capturePayment: (id: string) => Promise<Payment>;
+    cancelPayment: (id: string) => Promise<Payment>;
+    /**
+     * Refund management
+     */
+    createRefund: (params: CreateRefundSchema) => Promise<Refund>;
+    /**
+     * Webhook management
+     */
+    handleWebhook: (params: HandleWebhookParams) => Promise<Array<WebhookEventPayload>>;
+}
+
+export { type PayPalOptions, PayPalProvider };