Adjustment type and VND currency (#87)

* feat: add VND currency support * feat: add adjustment type * chore: bump version * chore: rename adjustment type * chore: rename adjustment.type to be AdjustmentActionType * chore: rename adjustment type filenames
PaddleHQ · Dec 16, 2024 · 0bdda08 · 0bdda08
1 parent 9d441c5
commit 0bdda08
Show file tree

Hide file tree

Showing 13 changed files with 66 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,13 @@ When we make [non-breaking changes](https://developer.paddle.com/api-reference/a
 
 This means when upgrading minor versions of the SDK, you may notice type errors. You can safely ignore these or fix by adding additional type guards.
 
+## 2.2.0 - 2024-12-12
+
+### Added
+
+- `VND` (Vietnamese dong) as new currency
+- Added `adjustment.type` which is either `partial` which should include `items` or `full` where `items` are not required
+
 ## 2.1.3 - 2024-11-29
 
 ### Changed

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

diff --git a/src/__tests__/mocks/notifications/adjustment-created.mock.ts b/src/__tests__/mocks/notifications/adjustment-created.mock.ts
@@ -24,6 +24,7 @@ export const AdjustmentCreatedMock: IEventsResponse<IAdjustmentResponse> = {
       },
     ],
     action: 'refund',
+    type: 'partial',
     reason: 'error',
     status: 'pending_approval',
     totals: { fee: '5', tax: '8', total: '100', earnings: '87', subtotal: '92', currency_code: 'USD' },
@@ -41,6 +42,7 @@ export const AdjustmentCreatedMock: IEventsResponse<IAdjustmentResponse> = {
 export const AdjustmentCreatedMockExpectation = {
   data: {
     action: 'refund',
+    type: 'partial',
     createdAt: '2023-08-21T14:08:43.297512Z',
     creditAppliedToBalance: true,
     currencyCode: 'USD',

diff --git a/src/__tests__/mocks/notifications/adjustment-updated.mock.ts b/src/__tests__/mocks/notifications/adjustment-updated.mock.ts
@@ -24,6 +24,7 @@ export const AdjustmentUpdatedMock: IEventsResponse<IAdjustmentResponse> = {
       },
     ],
     action: 'refund',
+    type: 'partial',
     reason: 'error',
     status: 'approved',
     totals: { fee: '5', tax: '8', total: '100', earnings: '87', subtotal: '92', currency_code: 'USD' },
@@ -41,6 +42,7 @@ export const AdjustmentUpdatedMock: IEventsResponse<IAdjustmentResponse> = {
 export const AdjustmentUpdatedMockExpectation = {
   data: {
     action: 'refund',
+    type: 'partial',
     createdAt: '2023-08-21T14:08:43.297512Z',
     creditAppliedToBalance: true,
     currencyCode: 'USD',

diff --git a/src/__tests__/mocks/resources/adjustments.mock.ts b/src/__tests__/mocks/resources/adjustments.mock.ts
@@ -36,6 +36,7 @@ export const CreateAdjustmentExpectation = {
 
 export const AdjustmentMock: IAdjustmentResponse = {
   action: 'credit',
+  type: 'partial',
   items: [
     {
       amount: '1000',

diff --git a/src/entities/adjustment/adjustment.ts b/src/entities/adjustment/adjustment.ts
@@ -4,14 +4,20 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
+import {
+  type AdjustmentActionType,
+  type AdjustmentAction,
+  type AdjustmentStatus,
+  type CurrencyCode,
+} from '../../enums/index.js';
 import { AdjustmentItem } from './adjustment-item.js';
 import { PayoutTotalsAdjustment, TotalAdjustments } from '../shared/index.js';
 import { type IAdjustmentResponse } from '../../types/index.js';
 
 export class Adjustment {
   public readonly id: string;
   public readonly action: AdjustmentAction;
+  public readonly type: AdjustmentActionType;
   public readonly transactionId: string;
   public readonly subscriptionId: string | null;
   public readonly customerId: string;
@@ -28,6 +34,7 @@ export class Adjustment {
   constructor(adjustment: IAdjustmentResponse) {
     this.id = adjustment.id;
     this.action = adjustment.action;
+    this.type = adjustment.type;
     this.transactionId = adjustment.transaction_id;
     this.subscriptionId = adjustment.subscription_id ? adjustment.subscription_id : null;
     this.customerId = adjustment.customer_id;

diff --git a/src/enums/adjustment/adjustment-action-type.ts b/src/enums/adjustment/adjustment-action-type.ts
@@ -0,0 +1,7 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export type AdjustmentActionType = 'full' | 'partial';
diff --git a/src/enums/adjustment/index.ts b/src/enums/adjustment/index.ts
@@ -4,7 +4,8 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-export * from './adjustment-type.js';
-export * from './adjustment-currency-code.js';
+export * from './adjustment-action-type.js';
 export * from './adjustment-action.js';
+export * from './adjustment-currency-code.js';
 export * from './adjustment-status.js';
+export * from './adjustment-type.js';
diff --git a/src/enums/shared/currency-code.ts b/src/enums/shared/currency-code.ts
@@ -3,6 +3,7 @@
  *  Do not make changes to this file.
  *  Changes may be overwritten as part of auto-generation.
  */
+
 export type CurrencyCode =
   | 'USD'
   | 'EUR'
@@ -33,4 +34,5 @@ export type CurrencyCode =
   | 'TRY'
   | 'TWD'
   | 'UAH'
+  | 'VND'
   | 'ZAR';
diff --git a/src/notifications/entities/adjustment/adjustment-notification.ts b/src/notifications/entities/adjustment/adjustment-notification.ts
@@ -4,14 +4,20 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../../enums/index.js';
+import {
+  type AdjustmentActionType,
+  type AdjustmentAction,
+  type AdjustmentStatus,
+  type CurrencyCode,
+} from '../../../enums/index.js';
 import { AdjustmentItemNotification } from './adjustment-item-notification.js';
 import { PayoutTotalsAdjustmentNotification, TotalAdjustmentsNotification } from '../shared/index.js';
 import { type IAdjustmentNotificationResponse } from '../../types/index.js';
 
 export class AdjustmentNotification {
   public readonly id: string;
   public readonly action: AdjustmentAction;
+  public readonly type: AdjustmentActionType;
   public readonly transactionId: string;
   public readonly subscriptionId: string | null;
   public readonly customerId: string;
@@ -28,6 +34,7 @@ export class AdjustmentNotification {
   constructor(adjustment: IAdjustmentNotificationResponse) {
     this.id = adjustment.id;
     this.action = adjustment.action;
+    this.type = adjustment.type;
     this.transactionId = adjustment.transaction_id;
     this.subscriptionId = adjustment.subscription_id ? adjustment.subscription_id : null;
     this.customerId = adjustment.customer_id;

diff --git a/src/notifications/types/adjustment/adjustment-notification-response.ts b/src/notifications/types/adjustment/adjustment-notification-response.ts
@@ -4,7 +4,12 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../../enums/index.js';
+import {
+  type AdjustmentActionType,
+  type AdjustmentAction,
+  type AdjustmentStatus,
+  type CurrencyCode,
+} from '../../../enums/index.js';
 import { type IAdjustmentItemNotificationResponse } from './adjustment-item-notification-response.js';
 import {
   type IPayoutTotalsAdjustmentNotificationResponse,
@@ -14,6 +19,7 @@ import {
 export interface IAdjustmentNotificationResponse {
   id: string;
   action: AdjustmentAction;
+  type: AdjustmentActionType;
   transaction_id: string;
   subscription_id?: string | null;
   customer_id: string;

diff --git a/src/resources/adjustments/operations/create-adjustment-request-body.ts b/src/resources/adjustments/operations/create-adjustment-request-body.ts
@@ -12,9 +12,19 @@ export interface CreateAdjustmentLineItem {
   type: AdjustmentType;
 }
 
-export interface CreateAdjustmentRequestBody {
+interface CreatePartialAdjustmentRequestBody {
   action: AdjustmentAction;
   items: CreateAdjustmentLineItem[];
   reason: string;
   transactionId: string;
+  type?: 'partial';
 }
+
+interface CreateFullAdjustmentRequestBody {
+  action: AdjustmentAction;
+  reason: string;
+  transactionId: string;
+  type?: 'full';
+}
+
+export type CreateAdjustmentRequestBody = CreatePartialAdjustmentRequestBody | CreateFullAdjustmentRequestBody;
diff --git a/src/types/adjustment/adjustment-response.ts b/src/types/adjustment/adjustment-response.ts
@@ -4,13 +4,19 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
+import {
+  type AdjustmentActionType,
+  type AdjustmentAction,
+  type AdjustmentStatus,
+  type CurrencyCode,
+} from '../../enums/index.js';
 import { type IAdjustmentItemResponse } from './adjustment-item-response.js';
 import { type IPayoutTotalsAdjustmentResponse, type ITotalAdjustmentsResponse } from '../shared/index.js';
 
 export interface IAdjustmentResponse {
   id: string;
   action: AdjustmentAction;
+  type: AdjustmentActionType;
   transaction_id: string;
   subscription_id?: string | null;
   customer_id: string;