@paddle/paddle-node-sdk 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -8,6 +8,17 @@ 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.2.5 - 2023-12-15
+
+### Added
+
+- Added `reports.list()` to [list reports](https://developer.paddle.com/api-reference/reports/list-reports?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `reports.create()` to [create a new report](https://developer.paddle.com/api-reference/reports/create-report?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `reports.get()` to [get a report](https://developer.paddle.com/api-reference/reports/get-report?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `reports.getReportCsv()` to [get a CSV file for a report](https://developer.paddle.com/api-reference/reports/get-report-csv?utm_source=dx&utm_medium=paddle-node-sdk)
+
+---
+
 ## 0.2.4 - 2023-12-14
 
 ### Changed
@@ -33,7 +44,6 @@ Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx
 - Added `notifications.replay()` to [replay a notification](https://developer.paddle.com/api-reference/notifications/replay-notification?utm_source=dx&utm_medium=paddle-node-sdk)
 - Added `notifications.getLogs()` to [get all logs for a notification](https://developer.paddle.com/api-reference/notification-logs/list-notification-logs?utm_source=dx&utm_medium=paddle-node-sdk)
 
-
 ### Fixed
 
 - Fixed incorrect type of `action` in `subscriptions.scheduled_change`

package/README.md

@@ -269,9 +269,7 @@ app.listen(3000)
 
 ## Feature parity 
 
-While in early access, not all operations in the Paddle API are available in our Node.js SDK. We're working on complete feature parity for our final release.
-
-This table shows which operations are available as of the latest release.
+The Node.js SDK has complete feature parity with the Paddle API. All operations in the Paddle API are supported.
 
 | Paddle API operation                         | Support  |
 |----------------------------------------------|:--------:|
@@ -330,6 +328,11 @@ This table shows which operations are available as of the latest release.
 | Create an adjustment                         |    ✅     |
 | **Pricing preview**                          | **Full** |
 | Preview prices                               |    ✅     |
+| **Reports**                                  | **Full** |
+| List reports                                 |    ✅     |
+| Create a report                              |    ✅     |
+| Get a report                                 |    ✅     |
+| Get a CSV file for a report                  |    ✅     |
 | **Event types**                              | **Full** |
 | List event types                             |    ✅     |
 | **Events**                                   | **Full** |

package/dist/entities/index.d.ts

@@ -13,4 +13,5 @@ export * from './payout';
 export * from './event-types';
 export * from './notification-settings';
 export * from './notifications';
+export * from './report';
 export type CustomData = object;

package/dist/entities/index.js

@@ -29,3 +29,4 @@ __exportStar(require("./payout"), exports);
 __exportStar(require("./event-types"), exports);
 __exportStar(require("./notification-settings"), exports);
 __exportStar(require("./notifications"), exports);
+__exportStar(require("./report"), exports);

package/dist/entities/report/index.d.ts

@@ -0,0 +1,4 @@
+export * from './report-filters';
+export * from './report';
+export * from './report-csv';
+export * from './report-collection';

package/dist/entities/report/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./report-filters"), exports);
+__exportStar(require("./report"), exports);
+__exportStar(require("./report-csv"), exports);
+__exportStar(require("./report-collection"), exports);

package/dist/entities/report/report-collection.d.ts

@@ -0,0 +1,6 @@
+import { Report } from '../../entities';
+import { type IReportResponse } from '../../types';
+import { Collection } from '../../internal/base';
+export declare class ReportCollection extends Collection<IReportResponse, Report> {
+    fromJson(data: IReportResponse): Report;
+}

package/dist/entities/report/report-collection.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportCollection = void 0;
+const entities_1 = require("../../entities");
+const base_1 = require("../../internal/base");
+class ReportCollection extends base_1.Collection {
+    fromJson(data) {
+        return new entities_1.Report(data);
+    }
+}
+exports.ReportCollection = ReportCollection;

package/dist/entities/report/report-csv.d.ts

@@ -0,0 +1,5 @@
+import { type IReportCsvResponse } from '../../types';
+export declare class ReportCsv {
+    readonly url: string;
+    constructor(response: IReportCsvResponse);
+}

package/dist/entities/report/report-csv.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportCsv = void 0;
+class ReportCsv {
+    constructor(response) {
+        this.url = response.url;
+    }
+}
+exports.ReportCsv = ReportCsv;

package/dist/entities/report/report-filters.d.ts

@@ -0,0 +1,8 @@
+import { type IReportFilters } from '../../types';
+import { type ReportFilterName, type ReportFilterOperator } from '../../enums';
+export declare class ReportFilters {
+    readonly name: ReportFilterName;
+    readonly operator: null | ReportFilterOperator;
+    readonly value: string[] | string;
+    constructor(reportFiltersResponse: IReportFilters);
+}

package/dist/entities/report/report-filters.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportFilters = void 0;
+class ReportFilters {
+    constructor(reportFiltersResponse) {
+        var _a;
+        this.name = reportFiltersResponse.name;
+        this.operator = (_a = reportFiltersResponse.operator) !== null && _a !== void 0 ? _a : null;
+        this.value = reportFiltersResponse.value;
+    }
+}
+exports.ReportFilters = ReportFilters;

package/dist/entities/report/report.d.ts

@@ -0,0 +1,13 @@
+import { type IReportResponse } from '../../types';
+import { ReportFilters } from '../index';
+import { type ReportStatus, type ReportType } from '../../enums';
+export declare class Report {
+    readonly id: string;
+    readonly status: ReportStatus;
+    readonly rows: number | null;
+    readonly type: ReportType;
+    readonly filters: ReportFilters[];
+    readonly expiresAt: string | null;
+    readonly createdAt: string;
+    constructor(reportResponse: IReportResponse);
+}

package/dist/entities/report/report.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Report = void 0;
+const index_1 = require("../index");
+class Report {
+    constructor(reportResponse) {
+        var _a, _b, _c;
+        this.id = reportResponse.id;
+        this.status = reportResponse.status;
+        this.rows = (_a = reportResponse.rows) !== null && _a !== void 0 ? _a : null;
+        this.type = reportResponse.type;
+        this.filters = (_b = reportResponse.filters) === null || _b === void 0 ? void 0 : _b.map((filter) => new index_1.ReportFilters(filter));
+        this.expiresAt = (_c = reportResponse.expires_at) !== null && _c !== void 0 ? _c : null;
+        this.createdAt = reportResponse.created_at;
+    }
+}
+exports.Report = Report;

package/dist/enums/index.d.ts

@@ -6,3 +6,4 @@ export * from './transaction';
 export * from './payout';
 export * from './notification-settings';
 export * from './notification';
+export * from './report';

package/dist/enums/index.js

@@ -22,3 +22,4 @@ __exportStar(require("./transaction"), exports);
 __exportStar(require("./payout"), exports);
 __exportStar(require("./notification-settings"), exports);
 __exportStar(require("./notification"), exports);
+__exportStar(require("./report"), exports);

package/dist/enums/report/index.d.ts

@@ -0,0 +1,4 @@
+export * from './report-status';
+export * from './report-type';
+export * from './report-filter-name';
+export * from './report-filter-operator';

package/dist/enums/report/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./report-status"), exports);
+__exportStar(require("./report-type"), exports);
+__exportStar(require("./report-filter-name"), exports);
+__exportStar(require("./report-filter-operator"), exports);

package/dist/enums/report/report-filter-name.d.ts

@@ -0,0 +1 @@
+export type ReportFilterName = 'action' | 'collection_mode' | 'currency_code' | 'origin' | 'status' | 'updated_at';

package/dist/enums/report/report-filter-name.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/enums/report/report-filter-operator.d.ts

@@ -0,0 +1 @@
+export type ReportFilterOperator = 'lt' | 'gte';

package/dist/enums/report/report-filter-operator.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/enums/report/report-status.d.ts

@@ -0,0 +1 @@
+export type ReportStatus = 'pending' | 'ready' | 'failed' | 'expired';

package/dist/enums/report/report-status.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/enums/report/report-type.d.ts

@@ -0,0 +1 @@
+export type ReportType = 'adjustments' | 'adjustment_line_items' | 'transactions' | 'transaction_line_items';

package/dist/enums/report/report-type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/notifications/events/index.d.ts

@@ -8,3 +8,4 @@ export * from './price';
 export * from './product';
 export * from './subscription';
 export * from './transaction';
+export * from './report';

package/dist/notifications/events/index.js

@@ -24,3 +24,4 @@ __exportStar(require("./price"), exports);
 __exportStar(require("./product"), exports);
 __exportStar(require("./subscription"), exports);
 __exportStar(require("./transaction"), exports);
+__exportStar(require("./report"), exports);

package/dist/notifications/events/report/index.d.ts

@@ -0,0 +1,2 @@
+export * from './report-created-event';
+export * from './report-updated-event';

package/dist/notifications/events/report/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./report-created-event"), exports);
+__exportStar(require("./report-updated-event"), exports);

package/dist/notifications/events/report/report-created-event.d.ts

@@ -0,0 +1,9 @@
+import { Event } from '../../../entities/events/event';
+import { Report } from '../../../entities';
+import { EventName } from '../../helpers';
+import { type IEventsResponse, type IReportResponse } from '../../../types';
+export declare class ReportCreatedEvent extends Event {
+    readonly eventType = EventName.ReportCreated;
+    readonly data: Report;
+    constructor(response: IEventsResponse<IReportResponse>);
+}

package/dist/notifications/events/report/report-created-event.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportCreatedEvent = void 0;
+const event_1 = require("../../../entities/events/event");
+const entities_1 = require("../../../entities");
+const helpers_1 = require("../../helpers");
+class ReportCreatedEvent extends event_1.Event {
+    constructor(response) {
+        super(response);
+        this.eventType = helpers_1.EventName.ReportCreated;
+        this.data = new entities_1.Report(response.data);
+    }
+}
+exports.ReportCreatedEvent = ReportCreatedEvent;

package/dist/notifications/events/report/report-updated-event.d.ts

@@ -0,0 +1,9 @@
+import { Event } from '../../../entities/events/event';
+import { Report } from '../../../entities';
+import { EventName } from '../../helpers';
+import { type IEventsResponse, type IReportResponse } from '../../../types';
+export declare class ReportUpdatedEvent extends Event {
+    readonly eventType = EventName.ReportUpdated;
+    readonly data: Report;
+    constructor(response: IEventsResponse<IReportResponse>);
+}

package/dist/notifications/events/report/report-updated-event.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportUpdatedEvent = void 0;
+const event_1 = require("../../../entities/events/event");
+const entities_1 = require("../../../entities");
+const helpers_1 = require("../../helpers");
+class ReportUpdatedEvent extends event_1.Event {
+    constructor(response) {
+        super(response);
+        this.eventType = helpers_1.EventName.ReportUpdated;
+        this.data = new entities_1.Report(response.data);
+    }
+}
+exports.ReportUpdatedEvent = ReportUpdatedEvent;

package/dist/notifications/helpers/types.d.ts

@@ -1,5 +1,5 @@
-import { type AddressCreatedEvent, type AddressUpdatedEvent, type BusinessCreatedEvent, type AdjustmentCreatedEvent, type AdjustmentUpdatedEvent, type BusinessUpdatedEvent, type CustomerCreatedEvent, type CustomerUpdatedEvent, type DiscountCreatedEvent, type DiscountImportedEvent, type DiscountUpdatedEvent, type PayoutCreatedEvent, type PayoutPaidEvent, type PriceCreatedEvent, type PriceUpdatedEvent, type ProductCreatedEvent, type ProductUpdatedEvent, type SubscriptionCreatedEvent, type SubscriptionActivatedEvent, type SubscriptionCanceledEvent, type SubscriptionImportedEvent, type SubscriptionPausedEvent, type SubscriptionResumedEvent, type SubscriptionTrialingEvent, type SubscriptionUpdatedEvent, type TransactionCanceledEvent, type TransactionBilledEvent, type TransactionCompletedEvent, type TransactionCreatedEvent, type TransactionPaidEvent, type SubscriptionPastDueEvent, type TransactionPastDueEvent, type TransactionPaymentFailedEvent, type TransactionReadyEvent, type TransactionUpdatedEvent } from '../events';
-export type EventEntity = AddressCreatedEvent | AddressUpdatedEvent | AdjustmentUpdatedEvent | AdjustmentCreatedEvent | BusinessCreatedEvent | BusinessUpdatedEvent | CustomerCreatedEvent | CustomerUpdatedEvent | DiscountCreatedEvent | DiscountUpdatedEvent | DiscountImportedEvent | PayoutCreatedEvent | PayoutPaidEvent | PriceCreatedEvent | PriceUpdatedEvent | ProductCreatedEvent | ProductUpdatedEvent | SubscriptionActivatedEvent | SubscriptionCanceledEvent | SubscriptionCreatedEvent | SubscriptionImportedEvent | SubscriptionPastDueEvent | SubscriptionPausedEvent | SubscriptionResumedEvent | SubscriptionTrialingEvent | SubscriptionUpdatedEvent | TransactionBilledEvent | TransactionCanceledEvent | TransactionCompletedEvent | TransactionCreatedEvent | TransactionPaidEvent | TransactionPastDueEvent | TransactionPaymentFailedEvent | TransactionReadyEvent | TransactionUpdatedEvent;
+import { type AddressCreatedEvent, type AddressUpdatedEvent, type BusinessCreatedEvent, type AdjustmentCreatedEvent, type AdjustmentUpdatedEvent, type BusinessUpdatedEvent, type CustomerCreatedEvent, type CustomerUpdatedEvent, type DiscountCreatedEvent, type DiscountImportedEvent, type DiscountUpdatedEvent, type PayoutCreatedEvent, type PayoutPaidEvent, type PriceCreatedEvent, type PriceUpdatedEvent, type ProductCreatedEvent, type ProductUpdatedEvent, type SubscriptionCreatedEvent, type SubscriptionActivatedEvent, type SubscriptionCanceledEvent, type SubscriptionImportedEvent, type SubscriptionPausedEvent, type SubscriptionResumedEvent, type SubscriptionTrialingEvent, type SubscriptionUpdatedEvent, type TransactionCanceledEvent, type TransactionBilledEvent, type TransactionCompletedEvent, type TransactionCreatedEvent, type TransactionPaidEvent, type SubscriptionPastDueEvent, type TransactionPastDueEvent, type TransactionPaymentFailedEvent, type TransactionReadyEvent, type TransactionUpdatedEvent, type ReportUpdatedEvent, type ReportCreatedEvent } from '../events';
+export type EventEntity = AddressCreatedEvent | AddressUpdatedEvent | AdjustmentUpdatedEvent | AdjustmentCreatedEvent | BusinessCreatedEvent | BusinessUpdatedEvent | CustomerCreatedEvent | CustomerUpdatedEvent | DiscountCreatedEvent | DiscountUpdatedEvent | DiscountImportedEvent | PayoutCreatedEvent | PayoutPaidEvent | PriceCreatedEvent | PriceUpdatedEvent | ProductCreatedEvent | ProductUpdatedEvent | SubscriptionActivatedEvent | SubscriptionCanceledEvent | SubscriptionCreatedEvent | SubscriptionImportedEvent | SubscriptionPastDueEvent | SubscriptionPausedEvent | SubscriptionResumedEvent | SubscriptionTrialingEvent | SubscriptionUpdatedEvent | TransactionBilledEvent | TransactionCanceledEvent | TransactionCompletedEvent | TransactionCreatedEvent | TransactionPaidEvent | TransactionPastDueEvent | TransactionPaymentFailedEvent | TransactionReadyEvent | TransactionUpdatedEvent | ReportUpdatedEvent | ReportCreatedEvent;
 export declare enum EventName {
     AddressCreated = "address.created",
     AddressUpdated = "address.updated",
@@ -35,6 +35,8 @@ export declare enum EventName {
     TransactionPastDue = "transaction.past_due",
     TransactionPaymentFailed = "transaction.payment_failed",
     TransactionReady = "transaction.ready",
-    TransactionUpdated = "transaction.updated"
+    TransactionUpdated = "transaction.updated",
+    ReportCreated = "report.created",
+    ReportUpdated = "report.updated"
 }
-export type IEventName = 'address.created' | 'address.updated' | 'adjustment.created' | 'adjustment.updated' | 'business.created' | 'business.updated' | 'customer.created' | 'customer.updated' | 'discount.created' | 'discount.updated' | 'discount.imported' | 'payout.updated' | 'payout.paid' | 'price.updated' | 'price.created' | 'product.updated' | 'product.created' | 'subscription.activated' | 'subscription.canceled' | 'subscription.imported' | 'subscription.created' | 'subscription.past_due' | 'subscription.paused' | 'subscription.resumed' | 'subscription.trialing' | 'subscription.updated' | 'transaction.billed' | 'transaction.canceled' | 'transaction.completed' | 'transaction.paid' | 'transaction.created' | 'transaction.past_due' | 'transaction.payment_failed' | 'transaction.ready' | 'transaction.updated';
+export type IEventName = 'address.created' | 'address.updated' | 'adjustment.created' | 'adjustment.updated' | 'business.created' | 'business.updated' | 'customer.created' | 'customer.updated' | 'discount.created' | 'discount.updated' | 'discount.imported' | 'payout.updated' | 'payout.paid' | 'price.updated' | 'price.created' | 'product.updated' | 'product.created' | 'subscription.activated' | 'subscription.canceled' | 'subscription.imported' | 'subscription.created' | 'subscription.past_due' | 'subscription.paused' | 'subscription.resumed' | 'subscription.trialing' | 'subscription.updated' | 'transaction.billed' | 'transaction.canceled' | 'transaction.completed' | 'transaction.paid' | 'transaction.created' | 'transaction.past_due' | 'transaction.payment_failed' | 'transaction.ready' | 'transaction.updated' | 'report.created' | 'report.updated';

package/dist/notifications/helpers/types.js

@@ -38,4 +38,6 @@ var EventName;
     EventName["TransactionPaymentFailed"] = "transaction.payment_failed";
     EventName["TransactionReady"] = "transaction.ready";
     EventName["TransactionUpdated"] = "transaction.updated";
+    EventName["ReportCreated"] = "report.created";
+    EventName["ReportUpdated"] = "report.updated";
 })(EventName || (exports.EventName = EventName = {}));

package/dist/notifications/helpers/webhooks.js

@@ -91,6 +91,10 @@ class Webhooks {
                 return new events_1.TransactionReadyEvent(data);
             case types_1.EventName.TransactionUpdated:
                 return new events_1.TransactionUpdatedEvent(data);
+            case types_1.EventName.ReportCreated:
+                return new events_1.ReportCreatedEvent(data);
+            case types_1.EventName.ReportUpdated:
+                return new events_1.ReportUpdatedEvent(data);
             default:
                 logger_1.Logger.log('Unknown event_type');
                 return null;

package/dist/paddle.d.ts

@@ -1,4 +1,4 @@
-import { AddressesResource, AdjustmentsResource, BusinessesResource, CustomersResource, DiscountsResource, EventTypesResource, NotificationSettingsResource, NotificationsResource, PricesResource, PricingPreviewResource, ProductsResource, SubscriptionsResource, TransactionsResource } from './resources';
+import { AddressesResource, AdjustmentsResource, BusinessesResource, CustomersResource, DiscountsResource, EventTypesResource, NotificationSettingsResource, NotificationsResource, PricesResource, PricingPreviewResource, ProductsResource, ReportsResource, SubscriptionsResource, TransactionsResource } from './resources';
 import { type PaddleOptions } from './internal';
 import { EventsResource } from './resources/events';
 import { Webhooks } from './notifications';
@@ -20,5 +20,6 @@ export declare class Paddle {
     eventTypes: EventTypesResource;
     notificationSettings: NotificationSettingsResource;
     notifications: NotificationsResource;
+    reports: ReportsResource;
     constructor(apiKey: string, options?: PaddleOptions);
 }

package/dist/paddle.js

@@ -27,6 +27,7 @@ class Paddle {
         this.eventTypes = new resources_1.EventTypesResource(this.client);
         this.notificationSettings = new resources_1.NotificationSettingsResource(this.client);
         this.notifications = new resources_1.NotificationsResource(this.client);
+        this.reports = new resources_1.ReportsResource(this.client);
     }
 }
 exports.Paddle = Paddle;

package/dist/resources/index.d.ts

@@ -11,3 +11,4 @@ export * from './pricing-preview';
 export * from './event-types';
 export * from './notification-settings';
 export * from './notifications';
+export * from './reports';

package/dist/resources/index.js

@@ -27,3 +27,4 @@ __exportStar(require("./pricing-preview"), exports);
 __exportStar(require("./event-types"), exports);
 __exportStar(require("./notification-settings"), exports);
 __exportStar(require("./notifications"), exports);
+__exportStar(require("./reports"), exports);

package/dist/resources/reports/index.d.ts

@@ -0,0 +1,10 @@
+import { Report, ReportCollection, ReportCsv } from '../../entities';
+import { BaseResource } from '../../internal/base';
+import { type CreateReportRequestBody, type ListReportQueryParameters } from './operations';
+export * from './operations';
+export declare class ReportsResource extends BaseResource {
+    list(queryParams?: ListReportQueryParameters): ReportCollection;
+    create(createReportParameters: CreateReportRequestBody): Promise<Report>;
+    get(reportId: string): Promise<Report>;
+    getReportCsv(reportId: string): Promise<ReportCsv>;
+}

package/dist/resources/reports/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportsResource = void 0;
+const entities_1 = require("../../entities");
+const base_1 = require("../../internal/base");
+const ReportPaths = {
+    list: '/reports',
+    create: '/reports',
+    get: '/reports/{report_id}',
+    getReportCsv: '/reports/{report_id}/download-url',
+};
+__exportStar(require("./operations"), exports);
+class ReportsResource extends base_1.BaseResource {
+    list(queryParams) {
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.ReportCollection(this.client, ReportPaths.list + '?' + queryParameters.toQueryString());
+    }
+    create(createReportParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.client.post(ReportPaths.create, createReportParameters);
+            const data = this.handleResponse(response);
+            return new entities_1.Report(data);
+        });
+    }
+    get(reportId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const urlWithPathParams = new base_1.PathParameters(ReportPaths.get, {
+                report_id: reportId,
+            }).deriveUrl();
+            const response = yield this.client.get(urlWithPathParams);
+            const data = this.handleResponse(response);
+            return new entities_1.Report(data);
+        });
+    }
+    getReportCsv(reportId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const urlWithPathParams = new base_1.PathParameters(ReportPaths.getReportCsv, {
+                report_id: reportId,
+            }).deriveUrl();
+            const response = yield this.client.get(urlWithPathParams);
+            const data = this.handleResponse(response);
+            return new entities_1.ReportCsv(data);
+        });
+    }
+}
+exports.ReportsResource = ReportsResource;

package/dist/resources/reports/operations/create-report-request-object.d.ts

@@ -0,0 +1,6 @@
+import { type IReportFilters } from '../../../types';
+import { type ReportType } from '../../../enums';
+export interface CreateReportRequestBody {
+    type: ReportType;
+    filters?: IReportFilters[] | null;
+}

package/dist/resources/reports/operations/create-report-request-object.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/resources/reports/operations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './list-report-query-parameters';
+export * from './create-report-request-object';

package/dist/resources/reports/operations/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./list-report-query-parameters"), exports);
+__exportStar(require("./create-report-request-object"), exports);

package/dist/resources/reports/operations/list-report-query-parameters.d.ts

@@ -0,0 +1,7 @@
+import { type ReportStatus } from '../../../enums';
+export interface ListReportQueryParameters {
+    after?: string;
+    orderBy?: string;
+    perPage?: number;
+    status?: ReportStatus[];
+}

package/dist/resources/reports/operations/list-report-query-parameters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -9,6 +9,7 @@ import { type IProductResponse } from '../product';
 import { type ISubscriptionNotificationResponse } from '../subscription';
 import { type ITransactionResponse } from '../transaction';
 import { type IPayoutResponse } from '../payout';
+import { type IReportResponse } from '../report';
 export interface IEventsResponse<T = object> {
     event_id: string;
     notification_id: string;
@@ -121,5 +122,11 @@ interface ITransactionReady extends IEventsResponse<ITransactionResponse> {
 interface ITransactionUpdated extends IEventsResponse<ITransactionResponse> {
     event_type: EventName.TransactionUpdated;
 }
-export type IEvents = IAddressCreated | IAddressUpdated | IAdjustmentCreated | IAdjustmentUpdated | IBusinessCreated | IBusinessUpdated | ICustomerCreated | ICustomerUpdated | IDiscountCreated | IDiscountUpdated | IDiscountImported | IPayoutCreated | IPayoutPaid | IPriceCreated | IPriceUpdated | IProductCreated | IProductUpdated | ISubscriptionActivated | ISubscriptionCanceled | ISubscriptionCreated | ISubscriptionImported | ISubscriptionPastDue | ISubscriptionPaused | ISubscriptionResumed | ISubscriptionTrialing | ISubscriptionUpdated | ITransactionBilled | ITransactionCanceled | ITransactionCompleted | ITransactionCreated | ITransactionPaid | ITransactionPastDue | ITransactionPaymentFailed | ITransactionReady | ITransactionUpdated;
+interface IReportCreated extends IEventsResponse<IReportResponse> {
+    event_type: EventName.ReportCreated;
+}
+interface IReportUpdated extends IEventsResponse<IReportResponse> {
+    event_type: EventName.ReportUpdated;
+}
+export type IEvents = IAddressCreated | IAddressUpdated | IAdjustmentCreated | IAdjustmentUpdated | IBusinessCreated | IBusinessUpdated | ICustomerCreated | ICustomerUpdated | IDiscountCreated | IDiscountUpdated | IDiscountImported | IPayoutCreated | IPayoutPaid | IPriceCreated | IPriceUpdated | IProductCreated | IProductUpdated | ISubscriptionActivated | ISubscriptionCanceled | ISubscriptionCreated | ISubscriptionImported | ISubscriptionPastDue | ISubscriptionPaused | ISubscriptionResumed | ISubscriptionTrialing | ISubscriptionUpdated | ITransactionBilled | ITransactionCanceled | ITransactionCompleted | ITransactionCreated | ITransactionPaid | ITransactionPastDue | ITransactionPaymentFailed | ITransactionReady | ITransactionUpdated | IReportCreated | IReportUpdated;
 export {};

package/dist/types/index.d.ts

@@ -14,3 +14,4 @@ export * from './payout';
 export * from './event-types';
 export * from './notification-settings';
 export * from './notifications';
+export * from './report';

package/dist/types/index.js

@@ -30,3 +30,4 @@ __exportStar(require("./payout"), exports);
 __exportStar(require("./event-types"), exports);
 __exportStar(require("./notification-settings"), exports);
 __exportStar(require("./notifications"), exports);
+__exportStar(require("./report"), exports);

package/dist/types/report/index.d.ts

@@ -0,0 +1,3 @@
+export * from './report-filters';
+export * from './report';
+export * from './reports-csv';

package/dist/types/report/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./report-filters"), exports);
+__exportStar(require("./report"), exports);
+__exportStar(require("./reports-csv"), exports);

package/dist/types/report/report-filters.d.ts

@@ -0,0 +1,6 @@
+import { type ReportFilterName, type ReportFilterOperator } from '../../enums';
+export interface IReportFilters {
+    name: ReportFilterName;
+    operator?: null | ReportFilterOperator;
+    value: string[] | string;
+}

package/dist/types/report/report-filters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/report/report.d.ts

@@ -0,0 +1,11 @@
+import { type IReportFilters } from '../index';
+import { type ReportType, type ReportStatus } from '../../enums';
+export interface IReportResponse {
+    id: string;
+    status: ReportStatus;
+    rows?: number | null;
+    type: ReportType;
+    filters: IReportFilters[];
+    expires_at?: string | null;
+    created_at: string;
+}

package/dist/types/report/report.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/report/reports-csv.d.ts

@@ -0,0 +1,3 @@
+export interface IReportCsvResponse {
+    url: string;
+}

package/dist/types/report/reports-csv.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.2.4";
+export declare const SDK_VERSION = "0.2.5";

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "A NodeJS SDK for Paddle Billing API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",