@paid-ai/paid-node 1.7.1 → 2.0.0

package/dist/cjs/api/resources/valueModels/client/requests/ValueModelUploadRequest.d.ts

@@ -0,0 +1,46 @@
+import type * as Paid from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         content: {
+ *             currency: "currency",
+ *             valueTypes: [{
+ *                     slug: "slug",
+ *                     name: "name",
+ *                     calculationTimeline: [{
+ *                             effectiveFrom: "2024-01-15T09:30:00Z",
+ *                             calculation: {
+ *                                 unit: {
+ *                                     type: "monetary"
+ *                                 },
+ *                                 formulaIds: ["formulaIds"],
+ *                                 signalEventNames: ["signalEventNames"],
+ *                                 segmentTableIds: ["segmentTableIds"],
+ *                                 overrideIds: ["overrideIds"]
+ *                             }
+ *                         }]
+ *                 }],
+ *             formulas: [{
+ *                     id: "id",
+ *                     valueTypeSlug: "valueTypeSlug",
+ *                     label: "label",
+ *                     variables: [{
+ *                             id: "id",
+ *                             label: "label"
+ *                         }],
+ *                     expression: "expression"
+ *                 }],
+ *             signals: [{
+ *                     eventName: "eventName",
+ *                     label: "label"
+ *                 }]
+ *         }
+ *     }
+ */
+export interface ValueModelUploadRequest {
+    content: Paid.ValueModelContent;
+    effectiveFrom?: string;
+    effectiveTo?: string;
+    /** Optimistic concurrency guard: the active version this upload is based on. When supplied and it does not match the live active version, the upload fails with 409 instead of overwriting a concurrent change. */
+    expectedActiveVersion?: number;
+}

package/dist/cjs/api/resources/valueModels/client/requests/ValueModelUploadRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/valueModels/client/requests/index.d.ts

@@ -0,0 +1,4 @@
+export type { GetValueModelVersionRequest } from "./GetValueModelVersionRequest.js";
+export type { ListValueModelVersionsRequest } from "./ListValueModelVersionsRequest.js";
+export type { RefreshValueModelBackfillRequest } from "./RefreshValueModelBackfillRequest.js";
+export type { ValueModelUploadRequest } from "./ValueModelUploadRequest.js";

package/dist/cjs/api/resources/valueModels/client/requests/index.js

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

package/dist/cjs/api/resources/valueModels/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/cjs/api/resources/valueModels/index.js

@@ -0,0 +1,17 @@
+"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("./client/index.js"), exports);

package/dist/cjs/api/resources/valueReceipts/client/Client.d.ts

@@ -11,42 +11,65 @@ export declare class ValueReceipts {
     protected readonly _options: ValueReceipts.Options;
     constructor(_options: ValueReceipts.Options);
     /**
-     * Find or create a value receipt by natural key (customer + product/order + dates), then populate it with current data inline. Returns the ID, status, and public URL. Posted (sealed) VRs are returned as-is without re-populating.
+     * List value receipts for the organization
+     *
+     * @param {Paid.ListValueReceiptsRequest} request
+     * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.valueReceipts.listValueReceipts()
+     */
+    listValueReceipts(request?: Paid.ListValueReceiptsRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptListResponse>;
+    private __listValueReceipts;
+    /**
+     * Creates a value receipt for a customer and date range, optionally scoped to a product or an order. Every call creates a receipt, so calling twice for the same period gives the customer two. The date range must have ended; a range with nothing delivered in it reports zero. Returns the receipt's ID and public URL.
      *
      * @param {Paid.SyncValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
-     *     await client.valueReceipts.syncValueReceipt({
+     *     await client.valueReceipts.createValueReceipt({
      *         startDate: "2024-01-15T09:30:00Z",
      *         endDate: "2024-01-15T09:30:00Z"
      *     })
      */
-    syncValueReceipt(request: Paid.SyncValueReceiptRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptSyncResponse>;
-    private __syncValueReceipt;
+    createValueReceipt(request: Paid.SyncValueReceiptRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptSyncResponse>;
+    private __createValueReceipt;
     /**
-     * List value receipts for the organization
+     * Deprecated — use POST /value-receipts. Returns the receipt this customer already has for the date range (200), and creates one only if there is none (201), so calling twice does not give the customer two receipts. A receipt does not change after it is created, so a repeated call reports the same figures. Create a new receipt to report the period again with newer data.
      *
-     * @param {Paid.ListValueReceiptsRequest} request
+     * @param {Paid.SyncValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
-     *     await client.valueReceipts.listValueReceipts()
+     *     await client.valueReceipts.syncValueReceipt({
+     *         startDate: "2024-01-15T09:30:00Z",
+     *         endDate: "2024-01-15T09:30:00Z"
+     *     })
      */
-    listValueReceipts(request?: Paid.ListValueReceiptsRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptListResponse>;
-    private __listValueReceipts;
+    syncValueReceipt(request: Paid.SyncValueReceiptRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptSyncResponse>;
+    private __syncValueReceipt;
     /**
      * Get a value receipt by ID, including its publish/share state.
      *
      * @param {Paid.GetValueReceiptByIdRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *
@@ -58,12 +81,13 @@ export declare class ValueReceipts {
     getValueReceiptById(request: Paid.GetValueReceiptByIdRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptDetail>;
     private __getValueReceiptById;
     /**
-     * Re-populate an existing draft value receipt with current data inline. Returns the slim sync response. Sealed VRs cannot be refreshed.
+     * Deprecated. A value receipt is immutable from creation, so it cannot be re-populated. A receipt you own answers 409, and one that does not exist or belongs to another organization answers 404. To get current data, create a new receipt for the period with `POST /value-receipts`.
      *
      * @param {Paid.RefreshValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
@@ -76,11 +100,12 @@ export declare class ValueReceipts {
     refreshValueReceipt(request: Paid.RefreshValueReceiptRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptSyncResponse>;
     private __refreshValueReceipt;
     /**
-     * Transition a draft value receipt to sealed (posted) status. Sealed VRs are immutable — they cannot be updated or re-populated.
+     * Deprecated. A value receipt is immutable from creation, so it is already sealed and this call has nothing to do. It answers 200 for any receipt the organization owns.
      *
      * @param {Paid.SealValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
@@ -98,6 +123,7 @@ export declare class ValueReceipts {
      * @param {Paid.ArchiveValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *
@@ -109,12 +135,14 @@ export declare class ValueReceipts {
     archiveValueReceipt(request: Paid.ArchiveValueReceiptRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.SuccessResponse>;
     private __archiveValueReceipt;
     /**
-     * Restore an archived value receipt.
+     * Restore an archived value receipt. A receipt with no content, or one that failed to build, stays archived and answers 409. So does one whose period another value receipt now covers.
      *
      * @param {Paid.UnarchiveValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
@@ -125,12 +153,14 @@ export declare class ValueReceipts {
     unarchiveValueReceipt(request: Paid.UnarchiveValueReceiptRequest, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.SuccessResponse>;
     private __unarchiveValueReceipt;
     /**
-     * Make a value receipt publicly accessible via URL.
+     * Make a value receipt publicly accessible via URL. An archived receipt is rejected with 409 — unarchive it first. So is one with no content, which has nothing to show.
      *
      * @param {Paid.PublishValueReceiptBody} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
@@ -141,11 +171,12 @@ export declare class ValueReceipts {
     publishValueReceipt(request: Paid.PublishValueReceiptBody, requestOptions?: ValueReceipts.RequestOptions): core.HttpResponsePromise<Paid.ValueReceiptDetail>;
     private __publishValueReceipt;
     /**
-     * Revoke public access to a value receipt.
+     * Revoke public access to a value receipt. Available for archived receipts too, so a live link can always be revoked.
      *
      * @param {Paid.UnpublishValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *

package/dist/cjs/api/resources/valueReceipts/client/Client.js

@@ -65,30 +65,116 @@ class ValueReceipts {
         this._options = _options;
     }
     /**
-     * Find or create a value receipt by natural key (customer + product/order + dates), then populate it with current data inline. Returns the ID, status, and public URL. Posted (sealed) VRs are returned as-is without re-populating.
+     * List value receipts for the organization
+     *
+     * @param {Paid.ListValueReceiptsRequest} request
+     * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.InternalServerError}
+     *
+     * @example
+     *     await client.valueReceipts.listValueReceipts()
+     */
+    listValueReceipts(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listValueReceipts(request, requestOptions));
+    }
+    __listValueReceipts() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { limit, offset, customerId, externalCustomerId, orderId, productId, archived } = request;
+            const _queryParams = {};
+            if (limit != null) {
+                _queryParams.limit = limit.toString();
+            }
+            if (offset != null) {
+                _queryParams.offset = offset.toString();
+            }
+            if (customerId != null) {
+                _queryParams.customerId = customerId;
+            }
+            if (externalCustomerId != null) {
+                _queryParams.externalCustomerId = externalCustomerId;
+            }
+            if (orderId != null) {
+                _queryParams.orderId = orderId;
+            }
+            if (productId != null) {
+                _queryParams.productId = productId;
+            }
+            if (archived != null) {
+                _queryParams.archived = archived;
+            }
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, "value-receipts/"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Paid.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PaidError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PaidError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling GET /value-receipts/.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Creates a value receipt for a customer and date range, optionally scoped to a product or an order. Every call creates a receipt, so calling twice for the same period gives the customer two. The date range must have ended; a range with nothing delivered in it reports zero. Returns the receipt's ID and public URL.
      *
      * @param {Paid.SyncValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
-     *     await client.valueReceipts.syncValueReceipt({
+     *     await client.valueReceipts.createValueReceipt({
      *         startDate: "2024-01-15T09:30:00Z",
      *         endDate: "2024-01-15T09:30:00Z"
      *     })
      */
-    syncValueReceipt(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__syncValueReceipt(request, requestOptions));
+    createValueReceipt(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createValueReceipt(request, requestOptions));
     }
-    __syncValueReceipt(request, requestOptions) {
+    __createValueReceipt(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
             const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, "value-receipts/sync"),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, "value-receipts/"),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
@@ -106,6 +192,8 @@ class ValueReceipts {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -126,7 +214,7 @@ class ValueReceipts {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.PaidTimeoutError("Timeout exceeded when calling POST /value-receipts/sync.");
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling POST /value-receipts/.");
                 case "unknown":
                     throw new errors.PaidError({
                         message: _response.error.errorMessage,
@@ -136,51 +224,38 @@ class ValueReceipts {
         });
     }
     /**
-     * List value receipts for the organization
+     * Deprecated — use POST /value-receipts. Returns the receipt this customer already has for the date range (200), and creates one only if there is none (201), so calling twice does not give the customer two receipts. A receipt does not change after it is created, so a repeated call reports the same figures. Create a new receipt to report the period again with newer data.
      *
-     * @param {Paid.ListValueReceiptsRequest} request
+     * @param {Paid.SyncValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
-     *     await client.valueReceipts.listValueReceipts()
+     *     await client.valueReceipts.syncValueReceipt({
+     *         startDate: "2024-01-15T09:30:00Z",
+     *         endDate: "2024-01-15T09:30:00Z"
+     *     })
      */
-    listValueReceipts(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listValueReceipts(request, requestOptions));
+    syncValueReceipt(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__syncValueReceipt(request, requestOptions));
     }
-    __listValueReceipts() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+    __syncValueReceipt(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { limit, offset, customerId, externalCustomerId, orderId, productId, archived } = request;
-            const _queryParams = {};
-            if (limit != null) {
-                _queryParams.limit = limit.toString();
-            }
-            if (offset != null) {
-                _queryParams.offset = offset.toString();
-            }
-            if (customerId != null) {
-                _queryParams.customerId = customerId;
-            }
-            if (externalCustomerId != null) {
-                _queryParams.externalCustomerId = externalCustomerId;
-            }
-            if (orderId != null) {
-                _queryParams.orderId = orderId;
-            }
-            if (productId != null) {
-                _queryParams.productId = productId;
-            }
-            if (archived != null) {
-                _queryParams.archived = archived;
-            }
             const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, "value-receipts/"),
-                method: "GET",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Default, "value-receipts/sync"),
+                method: "POST",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -190,6 +265,14 @@ class ValueReceipts {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Paid.ConflictError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Paid.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -208,7 +291,7 @@ class ValueReceipts {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.PaidTimeoutError("Timeout exceeded when calling GET /value-receipts/.");
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling POST /value-receipts/sync.");
                 case "unknown":
                     throw new errors.PaidError({
                         message: _response.error.errorMessage,
@@ -223,6 +306,7 @@ class ValueReceipts {
      * @param {Paid.GetValueReceiptByIdRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *
@@ -253,6 +337,8 @@ class ValueReceipts {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -283,12 +369,13 @@ class ValueReceipts {
         });
     }
     /**
-     * Re-populate an existing draft value receipt with current data inline. Returns the slim sync response. Sealed VRs cannot be refreshed.
+     * Deprecated. A value receipt is immutable from creation, so it cannot be re-populated. A receipt you own answers 409, and one that does not exist or belongs to another organization answers 404. To get current data, create a new receipt for the period with `POST /value-receipts`.
      *
      * @param {Paid.RefreshValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
@@ -325,6 +412,8 @@ class ValueReceipts {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
                     case 409:
@@ -357,11 +446,12 @@ class ValueReceipts {
         });
     }
     /**
-     * Transition a draft value receipt to sealed (posted) status. Sealed VRs are immutable — they cannot be updated or re-populated.
+     * Deprecated. A value receipt is immutable from creation, so it is already sealed and this call has nothing to do. It answers 200 for any receipt the organization owns.
      *
      * @param {Paid.SealValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
@@ -396,6 +486,8 @@ class ValueReceipts {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
                     case 409:
@@ -433,6 +525,7 @@ class ValueReceipts {
      * @param {Paid.ArchiveValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *
@@ -466,6 +559,8 @@ class ValueReceipts {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -496,12 +591,14 @@ class ValueReceipts {
         });
     }
     /**
-     * Restore an archived value receipt.
+     * Restore an archived value receipt. A receipt with no content, or one that failed to build, stays archived and answers 409. So does one whose period another value receipt now covers.
      *
      * @param {Paid.UnarchiveValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
@@ -534,8 +631,12 @@ class ValueReceipts {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Paid.ConflictError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Paid.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -564,12 +665,14 @@ class ValueReceipts {
         });
     }
     /**
-     * Make a value receipt publicly accessible via URL.
+     * Make a value receipt publicly accessible via URL. An archived receipt is rejected with 409 — unarchive it first. So is one with no content, which has nothing to show.
      *
      * @param {Paid.PublishValueReceiptBody} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
+     * @throws {@link Paid.ConflictError}
      * @throws {@link Paid.InternalServerError}
      *
      * @example
@@ -602,8 +705,12 @@ class ValueReceipts {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Paid.ConflictError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Paid.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -632,11 +739,12 @@ class ValueReceipts {
         });
     }
     /**
-     * Revoke public access to a value receipt.
+     * Revoke public access to a value receipt. Available for archived receipts too, so a live link can always be revoked.
      *
      * @param {Paid.UnpublishValueReceiptRequest} request
      * @param {ValueReceipts.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Paid.ForbiddenError}
      * @throws {@link Paid.NotFoundError}
      * @throws {@link Paid.InternalServerError}
      *
@@ -670,6 +778,8 @@ class ValueReceipts {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:

package/dist/cjs/api/resources/valueReceipts/client/requests/PublishValueReceiptBody.d.ts

@@ -6,5 +6,6 @@
  */
 export interface PublishValueReceiptBody {
     id: string;
+    /** When the public link stops working. Must be in the future, or the request fails with 409. Omit or set null for a link that does not expire. */
     publishExpiresAt?: string | null;
 }

package/dist/cjs/api/resources/valueReceipts/client/requests/index.d.ts

@@ -4,6 +4,5 @@ export type { ListValueReceiptsRequest } from "./ListValueReceiptsRequest.js";
 export type { PublishValueReceiptBody } from "./PublishValueReceiptBody.js";
 export type { RefreshValueReceiptRequest } from "./RefreshValueReceiptRequest.js";
 export type { SealValueReceiptRequest } from "./SealValueReceiptRequest.js";
-export type { SyncValueReceiptRequest } from "./SyncValueReceiptRequest.js";
 export type { UnarchiveValueReceiptRequest } from "./UnarchiveValueReceiptRequest.js";
 export type { UnpublishValueReceiptRequest } from "./UnpublishValueReceiptRequest.js";