Diverge Notification and API entities (#3)

PaddleHQ · Feb 16, 2024 · 1be29ff · 1be29ff
1 parent 401d57c
commit 1be29ff
Show file tree

Hide file tree

Showing 206 changed files with 3,103 additions and 424 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx&utm_medium=paddle-node-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
 
+## 0.5.0 - 2024-02-16
+
+> **Breaking changes:** This version includes major improvements that introduce breaking changes. These are called out below.
+
+### Changed
+
+- We removed the shared entities between API and Notification as we foresee them diverging. No Action required for this change
+
 ## 0.4.0 - 2024-02-14
 
 ### Added

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

diff --git a/src/__tests__/mocks/notifications/subscription-activated.mock.ts b/src/__tests__/mocks/notifications/subscription-activated.mock.ts
@@ -4,7 +4,8 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type IEventsResponse, type ISubscriptionNotificationResponse } from '../../../types';
+import { type IEventsResponse } from '../../../types';
+import { ISubscriptionNotificationResponse } from '../../../notifications';
 
 export const SubscriptionActivatedMock: IEventsResponse<ISubscriptionNotificationResponse> = {
   event_id: 'evt_01h7ht60mmw6d4sf4h38g3t4yq',
@@ -109,15 +110,22 @@ export const SubscriptionActivatedMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (per seat)',
           id: 'pri_01gsz8x8sawmvhz1pv30nge1ke',
+          importMeta: null,
+          name: null,
           productId: 'pro_01gsz4t5hdjse780zja8vvr7jg',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '3240',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 10,
         recurring: true,
@@ -134,15 +142,22 @@ export const SubscriptionActivatedMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (recurring addon)',
+          importMeta: null,
+          name: null,
           id: 'pri_01h1vjfevh5etwq3rb416a23h2',
           productId: 'pro_01h1vjes1y163xfj1rh1tkfb65',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '10800',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 1,
         recurring: true,

diff --git a/src/__tests__/mocks/notifications/subscription-canceled.mock.ts b/src/__tests__/mocks/notifications/subscription-canceled.mock.ts
@@ -4,7 +4,8 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type IEventsResponse, type ISubscriptionNotificationResponse } from '../../../types';
+import { type IEventsResponse } from '../../../types';
+import { ISubscriptionNotificationResponse } from '../../../notifications';
 
 export const SubscriptionCanceledMock: IEventsResponse<ISubscriptionNotificationResponse> = {
   event_id: 'evt_01h7jk37p1ezj1k5b4kt83t35j',
@@ -124,15 +125,22 @@ export const SubscriptionCanceledMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (per seat)',
           id: 'pri_01gsz8x8sawmvhz1pv30nge1ke',
+          importMeta: null,
+          name: null,
           productId: 'pro_01gsz4t5hdjse780zja8vvr7jg',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '3240',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 10,
         recurring: true,
@@ -149,15 +157,22 @@ export const SubscriptionCanceledMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (recurring addon)',
+          importMeta: null,
+          name: null,
           id: 'pri_01h1vjfevh5etwq3rb416a23h2',
           productId: 'pro_01h1vjes1y163xfj1rh1tkfb65',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '10800',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 1,
         recurring: true,
@@ -174,15 +189,22 @@ export const SubscriptionCanceledMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (recurring addon)',
+          importMeta: null,
+          name: null,
           id: 'pri_01gsz95g2zrkagg294kpstx54r',
           productId: 'pro_01gsz92krfzy3hcx5h5rtgnfwz',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '30000',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 1,
         recurring: true,

diff --git a/src/__tests__/mocks/notifications/subscription-created.mock.ts b/src/__tests__/mocks/notifications/subscription-created.mock.ts
@@ -4,7 +4,8 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type IEventsResponse, type ISubscriptionNotificationResponse } from '../../../types';
+import { type IEventsResponse } from '../../../types';
+import { ISubscriptionNotificationResponse } from '../../../notifications';
 
 export const SubscriptionCreatedMock: IEventsResponse<ISubscriptionNotificationResponse> = {
   event_id: 'evt_01h7ht60jy5hpdv5x8tfsaxje4',
@@ -109,15 +110,22 @@ export const SubscriptionCreatedMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (per seat)',
           id: 'pri_01gsz8x8sawmvhz1pv30nge1ke',
+          importMeta: null,
+          name: null,
           productId: 'pro_01gsz4t5hdjse780zja8vvr7jg',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '3240',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 10,
         recurring: true,
@@ -134,15 +142,22 @@ export const SubscriptionCreatedMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (recurring addon)',
+          importMeta: null,
+          name: null,
           id: 'pri_01h1vjfevh5etwq3rb416a23h2',
           productId: 'pro_01h1vjes1y163xfj1rh1tkfb65',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '10800',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 1,
         recurring: true,

diff --git a/src/__tests__/mocks/notifications/subscription-imported.mock.ts b/src/__tests__/mocks/notifications/subscription-imported.mock.ts
@@ -4,7 +4,8 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type IEventsResponse, type ISubscriptionNotificationResponse } from '../../../types';
+import { type IEventsResponse } from '../../../types';
+import { ISubscriptionNotificationResponse } from '../../../notifications';
 
 export const SubscriptionImportedMock: IEventsResponse<ISubscriptionNotificationResponse> = {
   event_id: 'evt_01gxwxwnghn8xa7amfwqb0992q',
@@ -124,15 +125,22 @@ export const SubscriptionImportedMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (per seat)',
           id: 'pri_01gsz8x8sawmvhz1pv30nge1ke',
+          importMeta: null,
+          name: null,
           productId: 'pro_01gsz4t5hdjse780zja8vvr7jg',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '3600',
             currencyCode: 'GBP',
           },
+          unitPriceOverrides: [],
         },
         quantity: 10,
         recurring: true,
@@ -149,15 +157,22 @@ export const SubscriptionImportedMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (recurring addon)',
+          importMeta: null,
+          name: null,
           id: 'pri_01gsz95g2zrkagg294kpstx54r',
           productId: 'pro_01gsz92krfzy3hcx5h5rtgnfwz',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '30000',
             currencyCode: 'GBP',
           },
+          unitPriceOverrides: [],
         },
         quantity: 1,
         recurring: true,
@@ -171,15 +186,22 @@ export const SubscriptionImportedMockExpectation = {
         previouslyBilledAt: '2023-04-13T09:07:04.730931Z',
         price: {
           billingCycle: null,
+          customData: null,
           description: 'One-time charge',
+          importMeta: null,
+          name: null,
           id: 'pri_01gsz98e27ak2tyhexptwc58yk',
           productId: 'pro_01gsz97mq9pa4fkyy0wqenepkz',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '23880',
             currencyCode: 'GBP',
           },
+          unitPriceOverrides: [],
         },
         quantity: 1,
         recurring: false,

diff --git a/src/__tests__/mocks/notifications/subscription-past-due.mock.ts b/src/__tests__/mocks/notifications/subscription-past-due.mock.ts
@@ -4,7 +4,8 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type IEventsResponse, type ISubscriptionNotificationResponse } from '../../../types';
+import { type IEventsResponse } from '../../../types';
+import { ISubscriptionNotificationResponse } from '../../../notifications';
 
 export const SubscriptionPastDueMock: IEventsResponse<ISubscriptionNotificationResponse> = {
   event_id: 'evt_01h7jagte1wnq80w5bw5gbmrwk',
@@ -109,15 +110,22 @@ export const SubscriptionPastDueMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (per seat)',
           id: 'pri_01gsz8x8sawmvhz1pv30nge1ke',
+          importMeta: null,
+          name: null,
           productId: 'pro_01gsz4t5hdjse780zja8vvr7jg',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '3240',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 10,
         recurring: true,
@@ -134,15 +142,22 @@ export const SubscriptionPastDueMockExpectation = {
             frequency: 1,
             interval: 'month',
           },
+          customData: null,
           description: 'Monthly (recurring addon)',
+          importMeta: null,
+          name: null,
           id: 'pri_01h1vjfevh5etwq3rb416a23h2',
           productId: 'pro_01h1vjes1y163xfj1rh1tkfb65',
+          quantity: null,
+          status: null,
           taxMode: 'account_setting',
           trialPeriod: null,
+          type: null,
           unitPrice: {
             amount: '10800',
             currencyCode: 'USD',
           },
+          unitPriceOverrides: [],
         },
         quantity: 1,
         recurring: true,