@invertase/node-paddle-sdk - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

dist/types.d.ts

 import { PaddleWebhook } from './webhook';
-export declare type State = 'active' | 'trailing' | 'past_due' | 'deleted';
+export declare type State = 'active' | 'trailing' | 'past_due' | 'deleted' | 'paused';
 export declare type PlanType = 'day' | 'week' | 'month' | 'year';
@@ -4,0 +4,0 @@ export declare type ListCouponsParameters = {

dist/webhook.d.ts

@@ -9,2 +9,16 @@ import { State } from './types';
     subscription_payment_refunded: SubscriptionPaymentRefundedWebhook;
+    payment_succeeded: PaymentSucceededWebhook;
+    payment_refunded: PaymentRefundedWebhook;
+    locker_processed: LockerProcessedWebhook;
+    payment_dispute_created: PaymentDisputeCreatedWebhook;
+    payment_dispute_closed: PaymentDisputeClosedWebhook;
+    high_risk_transaction_created: HighRiskTransactionCreatedWebhook;
+    high_risk_transaction_updated: HighRiskTransactionUpdatedWebhook;
+    transfer_created: TransferCreatedWebhook;
+    transfer_paid: TransferPaidWebhook;
+    new_audience_member: NewAudienceMemberWebhook;
+    update_audience_member: UpdateAudienceMemberWebhook;
+    invoice_paid: InvoicePaidWebhook;
+    invoice_sent: InvoiceSentWebhook;
+    invoice_overdue: InvoiceOverdueWebhook;
 };
@@ -16,3 +30,3 @@ declare type WebhookBase = {
 };
-export declare type PaddleWebhook = SubscriptionCreatedWebhook | SubscriptionUpdatedWebhook | SubscriptionCancelledWebhook | SubscriptionPaymentSucceededWebhook | SubscriptionPaymentFailedWebhook | SubscriptionPaymentRefundedWebhook;
+export declare type PaddleWebhook = SubscriptionCreatedWebhook | SubscriptionUpdatedWebhook | SubscriptionCancelledWebhook | SubscriptionPaymentSucceededWebhook | SubscriptionPaymentFailedWebhook | SubscriptionPaymentRefundedWebhook | PaymentSucceededWebhook | PaymentRefundedWebhook | LockerProcessedWebhook | PaymentDisputeCreatedWebhook | PaymentDisputeClosedWebhook | HighRiskTransactionCreatedWebhook | HighRiskTransactionUpdatedWebhook | TransferCreatedWebhook | TransferPaidWebhook | NewAudienceMemberWebhook | UpdateAudienceMemberWebhook | InvoicePaidWebhook | InvoiceSentWebhook | InvoiceOverdueWebhook;
 export declare type SubscriptionCreatedWebhook = {
@@ -127,2 +141,3 @@ alert_name: 'subscription_created';
     subscription_plan_id: string;
+    unit_price: string;
     update_url: string;
@@ -164,2 +179,251 @@ instalments: string;
 } & WebhookBase;
+export declare type PaymentSucceededWebhook = {
+    balance_currency: string;
+    balance_earnings: string;
+    balance_fee: string;
+    balance_gross: string;
+    balance_tax: string;
+    checkout_id: string;
+    country: string;
+    coupon: string;
+    currency: string;
+    customer_name: string;
+    earnings: string;
+    email: string;
+    fee: string;
+    ip: string;
+    marketing_consent: 0 | 1;
+    order_id: string;
+    passthrough: string;
+    payment_method: 'card' | 'paypal' | 'free' | 'apple-pay' | 'wire-transfer';
+    payment_tax: string;
+    product_id: string;
+    product_name: string;
+    quanity: string;
+    receipt_url: string;
+    sale_gross: string;
+    used_price_override: string;
+} & WebhookBase;
+export declare type PaymentRefundedWebhook = {
+    amount: string;
+    balance_currency: string;
+    balance_earnings_decrease: string;
+    balance_fee_refund: string;
+    balance_gross_refund: string;
+    balance_tax_refund: string;
+    checkout_id: string;
+    currency: string;
+    earnings_decrease: string;
+    email: string;
+    fee_refund: string;
+    gross_refund: string;
+    marketing_consent: 0 | 1;
+    order_id: string;
+    passthrough: string;
+    quantity: string;
+    refund_reason: string;
+    refund_type: 'full' | 'vat' | 'partial';
+    tax_refund: string;
+} & WebhookBase;
+export declare type LockerProcessedWebhook = {
+    checkout_id: string;
+    checkout_recovery: '0' | '1';
+    coupon: string;
+    download: string;
+    email: string;
+    instructions: string;
+    license: string;
+    marketing_consent: 0 | 1;
+    order_id: string;
+    product_id: string;
+    quantity: string;
+    source: string;
+};
+export declare type PaymentDisputeCreatedWebhook = {
+    amount: string;
+    balance_amount: string;
+    balance_currency: string;
+    balance_fee: string;
+    checkout_id: string;
+    currency: string;
+    email: string;
+    fee_usd: string;
+    marketing_consent: 0 | 1;
+    order_id: string;
+    passthrough: string;
+    status: string;
+} & WebhookBase;
+export declare type PaymentDisputeClosedWebhook = {
+    amount: string;
+    balance_amount: string;
+    balance_currency: string;
+    balance_fee: string;
+    checkout_id: string;
+    currency: string;
+    email: string;
+    fee_usd: string;
+    marketing_consent: 0 | 1;
+    order_id: string;
+    passthrough: string;
+    status: string;
+} & WebhookBase;
+export declare type HighRiskTransactionCreatedWebhook = {
+    case_id: string;
+    checkout_id: string;
+    created_at: string;
+    customer_email_address: string;
+    customer_user_id: string;
+    marketing_consent: 0 | 1;
+    passthrough: string;
+    product_id: string;
+    risk_score: string;
+    status: 'pending';
+} & WebhookBase;
+export declare type HighRiskTransactionUpdatedWebhook = {
+    case_id: string;
+    checkout_id: string;
+    created_at: string;
+    customer_email_address: string;
+    customer_user_id: string;
+    marketing_consent: 0 | 1;
+    order_id: string;
+    passthrough: string;
+    product_id: string;
+    risk_score: string;
+    status: 'accepted' | 'rejected';
+} & WebhookBase;
+export declare type TransferCreatedWebhook = {
+    amount: string;
+    currency: string;
+    payout_id: string;
+    status: 'unpaid';
+} & WebhookBase;
+export declare type TransferPaidWebhook = {
+    amount: string;
+    currency: string;
+    payout_id: string;
+    status: 'paid';
+} & WebhookBase;
+export declare type NewAudienceMemberWebhook = {
+    created_at: string;
+    email: string;
+    marketing_consent: 0 | 1;
+    products: string;
+    source: string;
+    /**
+     * @deprecated use marketing_consent instead
+     */
+    subscribed: string;
+    user_id: string;
+} & WebhookBase;
+export declare type UpdateAudienceMemberWebhook = {
+    new_customer_email: string;
+    new_marketing_consent: 0 | 1;
+    old_customer_email: string;
+    old_marketing_consent: 0 | 1;
+    products: string;
+    source: string;
+    user_id: string;
+} & WebhookBase;
+export declare type InvoicePaidWebhook = {
+    payment_id: string;
+    amount: string;
+    sale_gross: string;
+    term_days: string;
+    status: 'paid';
+    purchase_order_number: string;
+    invoiced_at: string;
+    currency: string;
+    product_id: string;
+    product_name: string;
+    product_additional_information: string;
+    customer_name: string;
+    email: string;
+    customer_vat_number: string;
+    customer_company_number: string;
+    customer_address: string;
+    customer_city: string;
+    customer_state: string;
+    customer_zipcode: string;
+    county: string;
+    contract_id: string;
+    contract_start_date: string;
+    contract_end_date: string;
+    passthrough: string;
+    date_created: string;
+    balance_currency: string;
+    payment_tax: string;
+    payment_method: 'card' | 'paypal' | 'apple-pay' | 'wire-transfer';
+    fee: string;
+    earnings: string;
+    balance_earnings: string;
+    balance_fee: string;
+    balance_tax: string;
+    balance_gross: string;
+    date_reconciled: string;
+} & WebhookBase;
+export declare type InvoiceSentWebhook = {
+    payment_id: string;
+    amount: string;
+    sale_gross: string;
+    term_days: string;
+    status: 'unpaid';
+    purchase_order_number: string;
+    invoiced_at: string;
+    currency: string;
+    product_id: string;
+    product_name: string;
+    product_additional_information: string;
+    customer_id: string;
+    customer_name: string;
+    email: string;
+    customer_vat_number: string;
+    customer_company_number: string;
+    customer_address: string;
+    customer_city: string;
+    customer_state: string;
+    customer_zipcode: string;
+    county: string;
+    contract_id: string;
+    contract_start_date: string;
+    passthrough: string;
+    date_created: string;
+    balance_currency: string;
+    payment_tax: string;
+    fee: string;
+    earnings: string;
+} & WebhookBase;
+export declare type InvoiceOverdueWebhook = {
+    payment_id: string;
+    amount: string;
+    sale_gross: string;
+    term_days: string;
+    status: 'overdue';
+    purchase_order_number: string;
+    invoiced_at: string;
+    currency: string;
+    product_id: string;
+    product_name: string;
+    product_additional_information: string;
+    customer_id: string;
+    customer_name: string;
+    email: string;
+    customer_vat_number: string;
+    customer_company_number: string;
+    customer_address: string;
+    customer_city: string;
+    customer_state: string;
+    customer_zipcode: string;
+    county: string;
+    contract_id: string;
+    contract_start_date: string;
+    contract_end_date: string;
+    passthrough: string;
+    date_created: string;
+    balance_currency: string;
+    payment_tax: string;
+    payment_method: 'card' | 'paypal' | 'apple-pay' | 'wire-transfer';
+    fee: string;
+    earnings: string;
+} & WebhookBase;
 export {};

package.json

 {
   "name": "@invertase/node-paddle-sdk",
   "private": false,
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "A fully typed NodeJS library for integration with Paddle.",
@@ -6,0 +6,0 @@ "main": "dist/node-paddle-sdk.cjs.js",

src/types.ts

 import { PaddleWebhook } from './webhook';
 
-export type State = 'active' | 'trailing' | 'past_due' | 'deleted';
+export type State = 'active' | 'trailing' | 'past_due' | 'deleted' | 'paused';
 
@@ -5,0 +5,0 @@ export type PlanType = 'day' | 'week' | 'month' | 'year';

src/webhook.ts

@@ -10,2 +10,16 @@ import { State } from './types';
   subscription_payment_refunded: SubscriptionPaymentRefundedWebhook;
+  payment_succeeded: PaymentSucceededWebhook;
+  payment_refunded: PaymentRefundedWebhook;
+  locker_processed: LockerProcessedWebhook;
+  payment_dispute_created: PaymentDisputeCreatedWebhook;
+  payment_dispute_closed: PaymentDisputeClosedWebhook;
+  high_risk_transaction_created: HighRiskTransactionCreatedWebhook;
+  high_risk_transaction_updated: HighRiskTransactionUpdatedWebhook;
+  transfer_created: TransferCreatedWebhook;
+  transfer_paid: TransferPaidWebhook;
+  new_audience_member: NewAudienceMemberWebhook;
+  update_audience_member: UpdateAudienceMemberWebhook;
+  invoice_paid: InvoicePaidWebhook;
+  invoice_sent: InvoiceSentWebhook;
+  invoice_overdue: InvoiceOverdueWebhook;
 };
@@ -25,3 +39,17 @@
   | SubscriptionPaymentFailedWebhook
-  | SubscriptionPaymentRefundedWebhook;
+  | SubscriptionPaymentRefundedWebhook
+  | PaymentSucceededWebhook
+  | PaymentRefundedWebhook
+  | LockerProcessedWebhook
+  | PaymentDisputeCreatedWebhook
+  | PaymentDisputeClosedWebhook
+  | HighRiskTransactionCreatedWebhook
+  | HighRiskTransactionUpdatedWebhook
+  | TransferCreatedWebhook
+  | TransferPaidWebhook
+  | NewAudienceMemberWebhook
+  | UpdateAudienceMemberWebhook
+  | InvoicePaidWebhook
+  | InvoiceSentWebhook
+  | InvoiceOverdueWebhook;
 
@@ -141,2 +169,3 @@ export type SubscriptionCreatedWebhook = {
   subscription_plan_id: string;
+  unit_price: string;
   update_url: string;
@@ -179,1 +208,264 @@ instalments: string;
 } & WebhookBase;
+
+export type PaymentSucceededWebhook = {
+  balance_currency: string;
+  balance_earnings: string;
+  balance_fee: string;
+  balance_gross: string;
+  balance_tax: string;
+  checkout_id: string;
+  country: string;
+  coupon: string;
+  currency: string;
+  customer_name: string;
+  earnings: string;
+  email: string;
+  fee: string;
+  ip: string;
+  marketing_consent: 0 | 1;
+  order_id: string;
+  passthrough: string;
+  payment_method: 'card' | 'paypal' | 'free' | 'apple-pay' | 'wire-transfer';
+  payment_tax: string;
+  product_id: string;
+  product_name: string;
+  quanity: string;
+  receipt_url: string;
+  sale_gross: string;
+  used_price_override: string;
+} & WebhookBase;
+
+export type PaymentRefundedWebhook = {
+  amount: string;
+  balance_currency: string;
+  balance_earnings_decrease: string;
+  balance_fee_refund: string;
+  balance_gross_refund: string;
+  balance_tax_refund: string;
+  checkout_id: string;
+  currency: string;
+  earnings_decrease: string;
+  email: string;
+  fee_refund: string;
+  gross_refund: string;
+  marketing_consent: 0 | 1;
+  order_id: string;
+  passthrough: string;
+  quantity: string;
+  refund_reason: string;
+  refund_type: 'full' | 'vat' | 'partial';
+  tax_refund: string;
+} & WebhookBase;
+
+export type LockerProcessedWebhook = {
+  checkout_id: string;
+  checkout_recovery: '0' | '1'; // is this correct?
+  coupon: string;
+  download: string;
+  email: string;
+  instructions: string;
+  license: string;
+  marketing_consent: 0 | 1;
+  order_id: string;
+  product_id: string;
+  quantity: string;
+  source: string;
+};
+
+export type PaymentDisputeCreatedWebhook = {
+  amount: string;
+  balance_amount: string;
+  balance_currency: string;
+  balance_fee: string;
+  checkout_id: string;
+  currency: string;
+  email: string;
+  fee_usd: string;
+  marketing_consent: 0 | 1;
+  order_id: string;
+  passthrough: string;
+  status: string;
+} & WebhookBase;
+
+export type PaymentDisputeClosedWebhook = {
+  amount: string;
+  balance_amount: string;
+  balance_currency: string;
+  balance_fee: string;
+  checkout_id: string;
+  currency: string;
+  email: string;
+  fee_usd: string;
+  marketing_consent: 0 | 1;
+  order_id: string;
+  passthrough: string;
+  status: string;
+} & WebhookBase;
+
+export type HighRiskTransactionCreatedWebhook = {
+  case_id: string;
+  checkout_id: string;
+  created_at: string;
+  customer_email_address: string;
+  customer_user_id: string;
+  marketing_consent: 0 | 1;
+  passthrough: string;
+  product_id: string;
+  risk_score: string;
+  status: 'pending';
+} & WebhookBase;
+
+export type HighRiskTransactionUpdatedWebhook = {
+  case_id: string;
+  checkout_id: string;
+  created_at: string;
+  customer_email_address: string;
+  customer_user_id: string;
+  marketing_consent: 0 | 1;
+  order_id: string;
+  passthrough: string;
+  product_id: string;
+  risk_score: string;
+  status: 'accepted' | 'rejected';
+} & WebhookBase;
+
+export type TransferCreatedWebhook = {
+  amount: string;
+  currency: string;
+  payout_id: string;
+  status: 'unpaid';
+} & WebhookBase;
+
+export type TransferPaidWebhook = {
+  amount: string;
+  currency: string;
+  payout_id: string;
+  status: 'paid';
+} & WebhookBase;
+
+export type NewAudienceMemberWebhook = {
+  created_at: string;
+  email: string;
+  marketing_consent: 0 | 1;
+  products: string;
+  source: string;
+  /**
+   * @deprecated use marketing_consent instead
+   */
+  subscribed: string;
+  user_id: string;
+} & WebhookBase;
+
+export type UpdateAudienceMemberWebhook = {
+  new_customer_email: string;
+  new_marketing_consent: 0 | 1;
+  old_customer_email: string;
+  old_marketing_consent: 0 | 1;
+  products: string;
+  source: string;
+  user_id: string;
+} & WebhookBase;
+
+export type InvoicePaidWebhook = {
+  payment_id: string;
+  amount: string;
+  sale_gross: string;
+  term_days: string;
+  status: 'paid';
+  purchase_order_number: string;
+  invoiced_at: string;
+  currency: string;
+  product_id: string;
+  product_name: string;
+  product_additional_information: string;
+  customer_name: string;
+  email: string;
+  customer_vat_number: string;
+  customer_company_number: string;
+  customer_address: string;
+  customer_city: string;
+  customer_state: string;
+  customer_zipcode: string;
+  county: string;
+  contract_id: string;
+  contract_start_date: string;
+  contract_end_date: string;
+  passthrough: string;
+  date_created: string;
+  balance_currency: string;
+  payment_tax: string;
+  payment_method: 'card' | 'paypal' | 'apple-pay' | 'wire-transfer';
+  fee: string;
+  earnings: string;
+  balance_earnings: string;
+  balance_fee: string;
+  balance_tax: string;
+  balance_gross: string;
+  date_reconciled: string;
+} & WebhookBase;
+
+export type InvoiceSentWebhook = {
+  payment_id: string;
+  amount: string;
+  sale_gross: string;
+  term_days: string;
+  status: 'unpaid';
+  purchase_order_number: string;
+  invoiced_at: string;
+  currency: string;
+  product_id: string;
+  product_name: string;
+  product_additional_information: string;
+  customer_id: string;
+  customer_name: string;
+  email: string;
+  customer_vat_number: string;
+  customer_company_number: string;
+  customer_address: string;
+  customer_city: string;
+  customer_state: string;
+  customer_zipcode: string;
+  county: string;
+  contract_id: string;
+  contract_start_date: string;
+  passthrough: string;
+  date_created: string;
+  balance_currency: string;
+  payment_tax: string;
+  fee: string;
+  earnings: string;
+} & WebhookBase;
+
+export type InvoiceOverdueWebhook = {
+  payment_id: string;
+  amount: string;
+  sale_gross: string;
+  term_days: string;
+  status: 'overdue';
+  purchase_order_number: string;
+  invoiced_at: string;
+  currency: string;
+  product_id: string;
+  product_name: string;
+  product_additional_information: string;
+  customer_id: string;
+  customer_name: string;
+  email: string;
+  customer_vat_number: string;
+  customer_company_number: string;
+  customer_address: string;
+  customer_city: string;
+  customer_state: string;
+  customer_zipcode: string;
+  county: string;
+  contract_id: string;
+  contract_start_date: string;
+  contract_end_date: string;
+  passthrough: string;
+  date_created: string;
+  balance_currency: string;
+  payment_tax: string;
+  payment_method: 'card' | 'paypal' | 'apple-pay' | 'wire-transfer';
+  fee: string;
+  earnings: string;
+} & WebhookBase;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

101256

increased by18.01%

Lines of code

2346

increased by30.19%

No dependency changes