@paddle/paddle-node-sdk 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -4,11 +4,29 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-> **Important:** While in early access (version 0.X.Y) we may introduce breaking changes. Where we can, we'll tag breaking changes in this changelog and communicate ahead of time.
-
 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.
 
 
+## 1.0.2 - 2024-03-12
+
+### Added
+
+- Exported `ApiError` class for usage in `try/catch` block.
+
+### Changed
+
+- Added `customerId` property to `Address` and `Business` entities, see [related changelog](https://developer.paddle.com/changelog/2024/address-business-webhooks-customer-id?utm_source=dx&utm_medium=paddle-node-sdk).
+
+---
+
+## 1.0.1 - 2024-02-20
+
+### Changed
+
+- Removed early access notice from README and Changelog.
+
+---
+
 ## 1.0.0 - 2024-02-20
 
 ### Changed

package/README.md

@@ -8,15 +8,6 @@ For working with Paddle in your frontend, use [Paddle.js](https://developer.padd
 
 > **Important:** This package works with Paddle Billing. It does not support Paddle Classic. To work with Paddle Classic, see: [Paddle Classic API reference](https://developer.paddle.com/classic/api-reference/1384a288aca7a-api-reference?utm_source=dx&utm_medium=paddle-node-sdk)
 
-
-## Before you begin
-
-This SDK is in early access, which means that we're actively developing it based on feedback from our developer community.
-
-If you've used this SDK, we'd love to hear how you found it! Email us at [team-dx@paddle.com](mailto:team-dx@paddle.com) with any thoughts.
-
-While in early access, we may introduce breaking changes. Where we can, we'll tag breaking changes and communicate ahead of time. Please pin the version of the SDK in your `package.json` to avoid downloading newer versions with potential breaking changes.
-
 ## Installation
 
 Install using `npm`:
@@ -215,6 +206,26 @@ const product = await archiveProduct('id')
 console.log('Product', product)
 ```
 
+### Error Handling
+
+If a request fails, Paddle returns an `error` object that contains the same information as [errors returned by the API](https://developer.paddle.com/api-reference/about/errors?utm_source=dx&utm_medium=paddle-node-sdk). You can use the `code` attribute to search an error in [the error reference](https://developer.paddle.com/errors/overview?utm_source=dx&utm_medium=paddle-node-sdk) and to handle the error in your app. Validation errors also return an array of `errors` that tell you which fields failed validation.
+
+This example shows how to handle an error with the code `conflict`:
+
+```typescript
+import { ApiError } from '@paddle/paddle-node-sdk'
+
+try {
+  // Call functions from the SDK
+} catch (e: any) {
+  // e.code will always follow the error code defined in our documentation
+  const paddleApiError = e as ApiError;
+  if (paddleApiError.code === 'conflict') {
+    // Handle Conflict error
+  }
+}
+```
+
 ## Resources
 
 ### Webhook signature verification 
@@ -274,4 +285,4 @@ The Node.js SDK has complete feature parity with the Paddle API. All operations
 ## Learn more
 
 - [Paddle API reference](https://developer.paddle.com/api-reference/overview?utm_source=dx&utm_medium=paddle-node-sdk)
-- [Sign up for Paddle Billing](https://login.paddle.com/signup?utm_source=dx&utm_medium=paddle-node-sdk)
+- [Sign up for Paddle Billing](https://login.paddle.com/signup?utm_source=dx&utm_medium=paddle-node-sdk)

package/dist/entities/address/address.d.ts

@@ -3,6 +3,7 @@ import { type CountryCode, type Status } from '../../enums';
 import { type IAddressResponse } from '../../types';
 export declare class Address {
     readonly id: string;
+    readonly customerId: string;
     readonly description: string | null;
     readonly firstLine: string | null;
     readonly secondLine: string | null;

package/dist/entities/address/address.js

@@ -5,6 +5,7 @@ const index_1 = require("../index");
 class Address {
     constructor(address) {
         this.id = address.id;
+        this.customerId = address.customer_id;
         this.description = address.description ? address.description : null;
         this.firstLine = address.first_line ? address.first_line : null;
         this.secondLine = address.second_line ? address.second_line : null;

package/dist/entities/business/business.d.ts

@@ -3,6 +3,7 @@ import { type Status } from '../../enums';
 import { type IBusinessResponse } from '../../types';
 export declare class Business {
     readonly id: string;
+    readonly customerId: string;
     readonly name: string;
     readonly companyNumber: string | null;
     readonly taxIdentifier: string | null;

package/dist/entities/business/business.js

@@ -5,6 +5,7 @@ const index_1 = require("../index");
 class Business {
     constructor(business) {
         this.id = business.id;
+        this.customerId = business.customer_id;
         this.name = business.name;
         this.companyNumber = business.company_number ? business.company_number : null;
         this.taxIdentifier = business.tax_identifier ? business.tax_identifier : null;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { Environment } from './internal';
+export { Environment, ApiError, type PaddleOptions } from './internal';
 export { SDK_VERSION } from './version';
 export { Paddle } from './paddle';
 export * from './entities';

package/dist/index.js

@@ -14,9 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Paddle = exports.SDK_VERSION = exports.Environment = void 0;
+exports.Paddle = exports.SDK_VERSION = exports.ApiError = exports.Environment = void 0;
 var internal_1 = require("./internal");
 Object.defineProperty(exports, "Environment", { enumerable: true, get: function () { return internal_1.Environment; } });
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return internal_1.ApiError; } });
 var version_1 = require("./version");
 Object.defineProperty(exports, "SDK_VERSION", { enumerable: true, get: function () { return version_1.SDK_VERSION; } });
 var paddle_1 = require("./paddle");

package/dist/internal/index.d.ts

@@ -1,3 +1,4 @@
 export type { ErrorResponse, ResponsePaginated, Response, ErrorDetail, ErrorField } from './types/response';
 export type { PaddleOptions } from './types/config';
 export * from './api';
+export { ApiError } from './errors/generic';

package/dist/internal/index.js

@@ -14,4 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiError = void 0;
 __exportStar(require("./api"), exports);
+var generic_1 = require("./errors/generic");
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return generic_1.ApiError; } });

package/dist/internal/types/config.d.ts

@@ -1,4 +1,4 @@
-import { type Environment } from '../api/environment';
+import { type Environment } from '../api';
 export interface PaddleOptions {
     environment?: Environment;
 }

package/dist/notifications/entities/address/address-notification.d.ts

@@ -3,6 +3,7 @@ import { type CustomData, ImportMeta } from '../../../entities';
 import { type IAddressNotificationResponse } from '../../types';
 export declare class AddressNotification {
     readonly id: string;
+    readonly customerId: string | null;
     readonly description: string | null;
     readonly firstLine: string | null;
     readonly secondLine: string | null;

package/dist/notifications/entities/address/address-notification.js

@@ -4,7 +4,9 @@ exports.AddressNotification = void 0;
 const entities_1 = require("../../../entities");
 class AddressNotification {
     constructor(address) {
+        var _a;
         this.id = address.id;
+        this.customerId = (_a = address.customer_id) !== null && _a !== void 0 ? _a : null;
         this.description = address.description ? address.description : null;
         this.firstLine = address.first_line ? address.first_line : null;
         this.secondLine = address.second_line ? address.second_line : null;

package/dist/notifications/entities/business/business-notification.d.ts

@@ -4,6 +4,7 @@ import { type IBusinessNotificationResponse } from '../../types';
 import { type CustomData } from '../../../entities';
 export declare class BusinessNotification {
     readonly id: string;
+    readonly customerId: string | null;
     readonly name: string;
     readonly companyNumber: string | null;
     readonly taxIdentifier: string | null;

package/dist/notifications/entities/business/business-notification.js

@@ -4,7 +4,9 @@ exports.BusinessNotification = void 0;
 const index_1 = require("../index");
 class BusinessNotification {
     constructor(business) {
+        var _a;
         this.id = business.id;
+        this.customerId = (_a = business.customer_id) !== null && _a !== void 0 ? _a : null;
         this.name = business.name;
         this.companyNumber = business.company_number ? business.company_number : null;
         this.taxIdentifier = business.tax_identifier ? business.tax_identifier : null;

package/dist/notifications/types/address/address-notification-response.d.ts

@@ -2,6 +2,7 @@ import { type CountryCode, type Status } from '../../../enums';
 import { type ICustomData, type IImportMetaResponse } from '../../../types';
 export interface IAddressNotificationResponse {
     id: string;
+    customer_id?: string | null;
     description?: string | null;
     first_line?: string | null;
     second_line?: string | null;

package/dist/notifications/types/business/business-notification-response.d.ts

@@ -3,6 +3,7 @@ import { type Status } from '../../../enums';
 import { type ICustomData } from '../../../types';
 export interface IBusinessNotificationResponse {
     id: string;
+    customer_id?: string | null;
     name: string;
     company_number?: string | null;
     tax_identifier?: string | null;

package/dist/types/address/address-response.d.ts

@@ -2,6 +2,7 @@ import { type ICustomData, type IImportMetaResponse } from '../index';
 import { type CountryCode, type Status } from '../../enums';
 export interface IAddressResponse {
     id: string;
+    customer_id: string;
     description?: string | null;
     first_line?: string | null;
     second_line?: string | null;

package/dist/types/business/business-response.d.ts

@@ -2,6 +2,7 @@ import { type IBusinessContacts, type ICustomData, type IImportMetaResponse } fr
 import { type Status } from '../../enums';
 export interface IBusinessResponse {
     id: string;
+    customer_id: string;
     name: string;
     company_number?: string | null;
     tax_identifier?: string | null;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.0";
+export declare const SDK_VERSION = "1.0.2";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = '1.0.0';
+exports.SDK_VERSION = '1.0.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "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",