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

Comparing version 0.1.0 to 0.2.0

dist/types.d.ts

@@ -7,3 +7,3 @@ import { PaddleWebhook } from './webhook';
 };
-export declare type ListCouponsResponse = {
+export declare type Coupon = {
     coupon: string;
@@ -18,3 +18,4 @@ description: string;
     expires: string;
-}[];
+};
+export declare type ListCouponsResponse = Coupon[];
 export declare type CreateCouponsParameters = {
@@ -57,15 +58,16 @@ coupon_code?: string;
 };
+export declare type Product = {
+    id: number;
+    name: string;
+    description: string | null;
+    base_price: number;
+    sale_price: null;
+    screenshots: Record<string, unknown>[];
+    icon: string;
+    currency: 'USD' | 'GBP' | 'EUR';
+};
 export declare type ListProductsResponse = {
     total: number;
     count: number;
-    products: {
-        id: number;
-        name: string;
-        description: string | null;
-        base_price: number;
-        sale_price: null;
-        screenshots: Record<string, unknown>[];
-        icon: string;
-        currency: 'USD' | 'GBP' | 'EUR';
-    }[];
+    products: Product[];
 };
@@ -77,6 +79,7 @@ export declare type GenerateLicenseParameters = {
 };
-export declare type GenerateLicenseResponse = {
+export declare type License = {
     license_code: string;
     expires_at: string;
 };
+export declare type GenerateLicenseResponse = License;
 export declare type GeneratePayLinkParameters = {
@@ -125,4 +128,5 @@ /**
 };
+export declare type PayLink = string;
 export declare type GeneratePayLinkResponse = {
-    url: string;
+    url: PayLink;
 };
@@ -135,3 +139,3 @@ export declare type ListTransactionsEntity = 'user' | 'subscription' | 'order' | 'checkout' | 'product';
 };
-export declare type ListTransactionsResponse = {
+export declare type Transaction = {
     order_id: string;
@@ -157,3 +161,4 @@ checkout_id: string;
     receipt_url: string;
-}[];
+};
+export declare type ListTransactionsResponse = Transaction[];
 export declare type RefundPaymentParameters = {
@@ -170,3 +175,3 @@ order_id: string;
 };
-export declare type ListPlansResponse = {
+export declare type Plan = {
     id: number;
@@ -183,3 +188,4 @@ name: string;
     trial_days: number;
-}[];
+};
+export declare type ListPlansResponse = Plan[];
 export declare type CreatePlanParameters = {
@@ -205,3 +211,3 @@ plan_name: string;
 };
-export declare type ListUsersResponse = {
+export declare type User = {
     subscription_id: number;
@@ -236,3 +242,4 @@ plan_id: number;
     };
-}[];
+};
+export declare type ListUsersResponse = User[];
 export declare type UpdateUserParameters = {
@@ -267,3 +274,3 @@ subscription_id: number;
 };
-export declare type ListModifiersResponse = {
+export declare type Modifier = {
     modifier_id: number;
@@ -275,3 +282,4 @@ subscription_id: number;
     description?: string;
-}[];
+};
+export declare type ListModifiersResponse = Modifier[];
 export declare type CreateModifiersParameters = {
@@ -298,3 +306,3 @@ subscription_id: number;
 };
-export declare type ListPaymentsResponse = {
+export declare type Payment = {
     id: number;
@@ -308,3 +316,4 @@ subscription_id: number;
     receipt_url: string;
-}[];
+};
+export declare type ListPaymentsResponse = Payment[];
 export declare type ReschedulePaymentParameters = {
@@ -334,2 +343,11 @@ payment_id: number;
 };
+export declare type WebhookHistory = {
+    id: string;
+    alert_name: string;
+    status: string;
+    created_at: string;
+    updated_at: string;
+    attempts: number;
+    fields: PaddleWebhook;
+};
 export declare type GetWebhookHistoryResponse = {
@@ -342,11 +360,3 @@ current_page: number;
     query_tail: string;
-    data: {
-        id: string;
-        alert_name: string;
-        status: string;
-        created_at: string;
-        updated_at: string;
-        attempts: number;
-        fields: PaddleWebhook;
-    }[];
+    data: WebhookHistory[];
 };

package.json

 {
   "name": "@invertase/node-paddle-sdk",
   "private": false,
-  "version": "0.1.0",
+  "version": "0.2.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

@@ -12,3 +12,3 @@ import { PaddleWebhook } from './webhook';
 
-export type ListCouponsResponse = {
+export type Coupon = {
   coupon: string;
@@ -23,4 +23,6 @@ description: string;
   expires: string;
-}[];
+};
 
+export type ListCouponsResponse = Coupon[];
+
 export type CreateCouponsParameters = {
@@ -93,15 +95,17 @@ // Will be randomly generated if not specified.
 
+export type Product = {
+  id: number;
+  name: string;
+  description: string | null;
+  base_price: number;
+  sale_price: null;
+  screenshots: Record<string, unknown>[];
+  icon: string;
+  currency: 'USD' | 'GBP' | 'EUR';
+};
+
 export type ListProductsResponse = {
   total: number;
   count: number;
-  products: {
-    id: number;
-    name: string;
-    description: string | null;
-    base_price: number;
-    sale_price: null;
-    screenshots: Record<string, unknown>[];
-    icon: string;
-    currency: 'USD' | 'GBP' | 'EUR';
-  }[];
+  products: Product[];
 };
@@ -118,3 +122,3 @@
 
-export type GenerateLicenseResponse = {
+export type License = {
   license_code: string;
@@ -124,2 +128,4 @@ expires_at: string;
 
+export type GenerateLicenseResponse = License;
+
 export type GeneratePayLinkParameters = {
@@ -196,4 +202,6 @@ /**
 
+export type PayLink = string;
+
 export type GeneratePayLinkResponse = {
-  url: string;
+  url: PayLink;
 };
@@ -212,3 +220,3 @@
 
-export type ListTransactionsResponse = {
+export type Transaction = {
   order_id: string;
@@ -234,4 +242,6 @@ checkout_id: string;
   receipt_url: string;
-}[];
+};
 
+export type ListTransactionsResponse = Transaction[];
+
 export type RefundPaymentParameters = {
@@ -255,3 +265,3 @@ // The order ID of the payment you wish to refund. NB. Subscription orders are hyphenated and one-time orders are an integer.
 
-export type ListPlansResponse = {
+export type Plan = {
   id: number;
@@ -264,4 +274,6 @@ name: string;
   trial_days: number;
-}[];
+};
 
+export type ListPlansResponse = Plan[];
+
 export type CreatePlanParameters = {
@@ -303,3 +315,3 @@ // The name of the subscription plan.
 
-export type ListUsersResponse = {
+export type User = {
   subscription_id: number;
@@ -336,4 +348,6 @@ plan_id: number;
       };
-}[];
+};
 
+export type ListUsersResponse = User[];
+
 export type UpdateUserParameters = {
@@ -385,3 +399,3 @@ // The ID of the subscription you’re updating.
 
-export type ListModifiersResponse = {
+export type Modifier = {
   modifier_id: number;
@@ -393,4 +407,6 @@ subscription_id: number;
   description?: string;
-}[];
+};
 
+export type ListModifiersResponse = Modifier[];
+
 export type CreateModifiersParameters = {
@@ -432,3 +448,3 @@ // The ID of the subscription that you want to add a modifier for.
 
-export type ListPaymentsResponse = {
+export type Payment = {
   id: number;
@@ -442,4 +458,6 @@ subscription_id: number;
   receipt_url: string;
-}[];
+};
 
+export type ListPaymentsResponse = Payment[];
+
 export type ReschedulePaymentParameters = {
@@ -482,2 +500,13 @@ // The upcoming subscription payment ID. This can be obtained by calling the List Payments API.
 
+export type WebhookHistory = {
+  id: string;
+  alert_name: string;
+  status: string;
+  created_at: string;
+  updated_at: string;
+  attempts: number;
+  // The fields included are dependent upon the alert_name.
+  fields: PaddleWebhook;
+};
+
 export type GetWebhookHistoryResponse = {
@@ -490,12 +519,3 @@ current_page: number;
   query_tail: string;
-  data: {
-    id: string;
-    alert_name: string;
-    status: string;
-    created_at: string;
-    updated_at: string;
-    attempts: number;
-    // The fields included are dependent upon the alert_name.
-    fields: PaddleWebhook;
-  }[];
+  data: WebhookHistory[];
 };

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

85751

increased by0.75%

Lines of code

1800

increased by1.12%

No dependency changes