@naturalpay/sdk 1.6.15 → 1.6.17

package/README.md

@@ -19,6 +19,7 @@ The Natural TypeScript library provides convenient access to the Natural APIs fr
 - [Environments](#environments)
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
+- [File Uploads](#file-uploads)
 - [Pagination](#pagination)
 - [Advanced](#advanced)
   - [Subpackage Exports](#subpackage-exports)
@@ -434,6 +435,52 @@ try {
 }
 ```
 
+## File Uploads
+
+You can upload files using the client:
+
+```typescript
+import { createReadStream } from "fs";
+import * as fs from "fs";
+import { NaturalClient } from "@naturalpay/sdk";
+
+const client = new NaturalClient({ token: "YOUR_TOKEN", instanceId: "YOUR_INSTANCE_ID" });
+await client.chargebacks.uploadFile({
+    file: fs.createReadStream("/path/to/your/file"),
+    idempotencyKey: "Idempotency-Key",
+    chargebackId: "chargebackId"
+});
+```
+The client accepts a variety of types for file upload parameters:
+* Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`
+* Buffered types: `Buffer`, `Blob`, `File`, `ArrayBuffer`, `ArrayBufferView`, and `Uint8Array`
+
+### Metadata
+
+You can configure metadata when uploading a file:
+```typescript
+const file: Uploadable.WithMetadata = {
+    data: createReadStream("path/to/file"),
+    filename: "my-file",       // optional
+    contentType: "audio/mpeg", // optional
+    contentLength: 1949,       // optional
+};
+```
+
+Alternatively, you can upload a file directly from a file path:
+```typescript
+const file : Uploadable.FromPath = {
+    path: "path/to/file",
+    filename: "my-file",        // optional
+    contentType: "audio/mpeg",  // optional
+    contentLength: 1949,        // optional
+};
+```
+
+The metadata is used to set the `Content-Length`, `Content-Type`, and `Content-Disposition` headers. If not provided, the client will attempt to determine them automatically.
+For example, `fs.ReadStream` has a `path` property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.
+
+
 ## Pagination
 
 List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@naturalpay/sdk",
-        "X-Fern-SDK-Version": "1.6.15",
-        "User-Agent": "@naturalpay/sdk/1.6.15",
+        "X-Fern-SDK-Version": "1.6.17",
+        "User-Agent": "@naturalpay/sdk/1.6.17",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Instance-ID": options === null || options === void 0 ? void 0 : options.instanceId,

package/dist/cjs/Client.d.ts

@@ -3,6 +3,7 @@ import { AgentKeysClient } from "./api/resources/agentKeys/client/Client.js";
 import { AgentsClient } from "./api/resources/agents/client/Client.js";
 import { ApiKeysClient } from "./api/resources/apiKeys/client/Client.js";
 import { ApprovalsClient } from "./api/resources/approvals/client/Client.js";
+import { ChargebacksClient } from "./api/resources/chargebacks/client/Client.js";
 import { CustomersClient } from "./api/resources/customers/client/Client.js";
 import { EventsClient } from "./api/resources/events/client/Client.js";
 import { ExternalAccountsClient } from "./api/resources/externalAccounts/client/Client.js";
@@ -39,6 +40,7 @@ export declare class NaturalClient {
     protected _ach: AchClient | undefined;
     protected _realtime: RealtimeClient | undefined;
     protected _wire: WireClient | undefined;
+    protected _chargebacks: ChargebacksClient | undefined;
     protected _transactions: TransactionsClient | undefined;
     protected _transfers: TransfersClient | undefined;
     protected _paymentRequests: PaymentRequestsClient | undefined;
@@ -62,6 +64,7 @@ export declare class NaturalClient {
     get ach(): AchClient;
     get realtime(): RealtimeClient;
     get wire(): WireClient;
+    get chargebacks(): ChargebacksClient;
     get transactions(): TransactionsClient;
     get transfers(): TransfersClient;
     get paymentRequests(): PaymentRequestsClient;

package/dist/cjs/Client.js

@@ -49,23 +49,24 @@ const Client_js_2 = require("./api/resources/agentKeys/client/Client.js");
 const Client_js_3 = require("./api/resources/agents/client/Client.js");
 const Client_js_4 = require("./api/resources/apiKeys/client/Client.js");
 const Client_js_5 = require("./api/resources/approvals/client/Client.js");
-const Client_js_6 = require("./api/resources/customers/client/Client.js");
-const Client_js_7 = require("./api/resources/events/client/Client.js");
-const Client_js_8 = require("./api/resources/externalAccounts/client/Client.js");
-const Client_js_9 = require("./api/resources/externalParties/client/Client.js");
-const Client_js_10 = require("./api/resources/externalPartyAccounts/client/Client.js");
-const Client_js_11 = require("./api/resources/invitationLinks/client/Client.js");
-const Client_js_12 = require("./api/resources/invitations/client/Client.js");
-const Client_js_13 = require("./api/resources/parties/client/Client.js");
-const Client_js_14 = require("./api/resources/paymentRequests/client/Client.js");
-const Client_js_15 = require("./api/resources/payments/client/Client.js");
-const Client_js_16 = require("./api/resources/realtime/client/Client.js");
-const Client_js_17 = require("./api/resources/simulations/client/Client.js");
-const Client_js_18 = require("./api/resources/transactions/client/Client.js");
-const Client_js_19 = require("./api/resources/transfers/client/Client.js");
-const Client_js_20 = require("./api/resources/wallets/client/Client.js");
-const Client_js_21 = require("./api/resources/webhooks/client/Client.js");
-const Client_js_22 = require("./api/resources/wire/client/Client.js");
+const Client_js_6 = require("./api/resources/chargebacks/client/Client.js");
+const Client_js_7 = require("./api/resources/customers/client/Client.js");
+const Client_js_8 = require("./api/resources/events/client/Client.js");
+const Client_js_9 = require("./api/resources/externalAccounts/client/Client.js");
+const Client_js_10 = require("./api/resources/externalParties/client/Client.js");
+const Client_js_11 = require("./api/resources/externalPartyAccounts/client/Client.js");
+const Client_js_12 = require("./api/resources/invitationLinks/client/Client.js");
+const Client_js_13 = require("./api/resources/invitations/client/Client.js");
+const Client_js_14 = require("./api/resources/parties/client/Client.js");
+const Client_js_15 = require("./api/resources/paymentRequests/client/Client.js");
+const Client_js_16 = require("./api/resources/payments/client/Client.js");
+const Client_js_17 = require("./api/resources/realtime/client/Client.js");
+const Client_js_18 = require("./api/resources/simulations/client/Client.js");
+const Client_js_19 = require("./api/resources/transactions/client/Client.js");
+const Client_js_20 = require("./api/resources/transfers/client/Client.js");
+const Client_js_21 = require("./api/resources/wallets/client/Client.js");
+const Client_js_22 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_23 = require("./api/resources/wire/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 class NaturalClient {
@@ -78,23 +79,23 @@ class NaturalClient {
     }
     get customers() {
         var _a;
-        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_js_6.CustomersClient(this._options)));
+        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_js_7.CustomersClient(this._options)));
     }
     get invitationLinks() {
         var _a;
-        return ((_a = this._invitationLinks) !== null && _a !== void 0 ? _a : (this._invitationLinks = new Client_js_11.InvitationLinksClient(this._options)));
+        return ((_a = this._invitationLinks) !== null && _a !== void 0 ? _a : (this._invitationLinks = new Client_js_12.InvitationLinksClient(this._options)));
     }
     get payments() {
         var _a;
-        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_15.PaymentsClient(this._options)));
+        return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_16.PaymentsClient(this._options)));
     }
     get externalParties() {
         var _a;
-        return ((_a = this._externalParties) !== null && _a !== void 0 ? _a : (this._externalParties = new Client_js_9.ExternalPartiesClient(this._options)));
+        return ((_a = this._externalParties) !== null && _a !== void 0 ? _a : (this._externalParties = new Client_js_10.ExternalPartiesClient(this._options)));
     }
     get externalPartyAccounts() {
         var _a;
-        return ((_a = this._externalPartyAccounts) !== null && _a !== void 0 ? _a : (this._externalPartyAccounts = new Client_js_10.ExternalPartyAccountsClient(this._options)));
+        return ((_a = this._externalPartyAccounts) !== null && _a !== void 0 ? _a : (this._externalPartyAccounts = new Client_js_11.ExternalPartyAccountsClient(this._options)));
     }
     get ach() {
         var _a;
@@ -102,23 +103,27 @@ class NaturalClient {
     }
     get realtime() {
         var _a;
-        return ((_a = this._realtime) !== null && _a !== void 0 ? _a : (this._realtime = new Client_js_16.RealtimeClient(this._options)));
+        return ((_a = this._realtime) !== null && _a !== void 0 ? _a : (this._realtime = new Client_js_17.RealtimeClient(this._options)));
     }
     get wire() {
         var _a;
-        return ((_a = this._wire) !== null && _a !== void 0 ? _a : (this._wire = new Client_js_22.WireClient(this._options)));
+        return ((_a = this._wire) !== null && _a !== void 0 ? _a : (this._wire = new Client_js_23.WireClient(this._options)));
+    }
+    get chargebacks() {
+        var _a;
+        return ((_a = this._chargebacks) !== null && _a !== void 0 ? _a : (this._chargebacks = new Client_js_6.ChargebacksClient(this._options)));
     }
     get transactions() {
         var _a;
-        return ((_a = this._transactions) !== null && _a !== void 0 ? _a : (this._transactions = new Client_js_18.TransactionsClient(this._options)));
+        return ((_a = this._transactions) !== null && _a !== void 0 ? _a : (this._transactions = new Client_js_19.TransactionsClient(this._options)));
     }
     get transfers() {
         var _a;
-        return ((_a = this._transfers) !== null && _a !== void 0 ? _a : (this._transfers = new Client_js_19.TransfersClient(this._options)));
+        return ((_a = this._transfers) !== null && _a !== void 0 ? _a : (this._transfers = new Client_js_20.TransfersClient(this._options)));
     }
     get paymentRequests() {
         var _a;
-        return ((_a = this._paymentRequests) !== null && _a !== void 0 ? _a : (this._paymentRequests = new Client_js_14.PaymentRequestsClient(this._options)));
+        return ((_a = this._paymentRequests) !== null && _a !== void 0 ? _a : (this._paymentRequests = new Client_js_15.PaymentRequestsClient(this._options)));
     }
     get approvals() {
         var _a;
@@ -126,19 +131,19 @@ class NaturalClient {
     }
     get invitations() {
         var _a;
-        return ((_a = this._invitations) !== null && _a !== void 0 ? _a : (this._invitations = new Client_js_12.InvitationsClient(this._options)));
+        return ((_a = this._invitations) !== null && _a !== void 0 ? _a : (this._invitations = new Client_js_13.InvitationsClient(this._options)));
     }
     get parties() {
         var _a;
-        return ((_a = this._parties) !== null && _a !== void 0 ? _a : (this._parties = new Client_js_13.PartiesClient(this._options)));
+        return ((_a = this._parties) !== null && _a !== void 0 ? _a : (this._parties = new Client_js_14.PartiesClient(this._options)));
     }
     get wallets() {
         var _a;
-        return ((_a = this._wallets) !== null && _a !== void 0 ? _a : (this._wallets = new Client_js_20.WalletsClient(this._options)));
+        return ((_a = this._wallets) !== null && _a !== void 0 ? _a : (this._wallets = new Client_js_21.WalletsClient(this._options)));
     }
     get externalAccounts() {
         var _a;
-        return ((_a = this._externalAccounts) !== null && _a !== void 0 ? _a : (this._externalAccounts = new Client_js_8.ExternalAccountsClient(this._options)));
+        return ((_a = this._externalAccounts) !== null && _a !== void 0 ? _a : (this._externalAccounts = new Client_js_9.ExternalAccountsClient(this._options)));
     }
     get apiKeys() {
         var _a;
@@ -150,15 +155,15 @@ class NaturalClient {
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_21.WebhooksClient(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_22.WebhooksClient(this._options)));
     }
     get events() {
         var _a;
-        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_js_7.EventsClient(this._options)));
+        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_js_8.EventsClient(this._options)));
     }
     get simulations() {
         var _a;
-        return ((_a = this._simulations) !== null && _a !== void 0 ? _a : (this._simulations = new Client_js_17.SimulationsClient(this._options)));
+        return ((_a = this._simulations) !== null && _a !== void 0 ? _a : (this._simulations = new Client_js_18.SimulationsClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

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

@@ -66,7 +66,8 @@ export declare class AchClient {
      *         amount: 25000,
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
-     *         companyEntryDescription: "PAYOUT"
+     *         companyEntryDescription: "PAYOUT",
+     *         addenda: "Invoice 1042, July services"
      *     })
      */
     create(request: Natural.NewAchParams, requestOptions?: AchClient.RequestOptions): core.HttpResponsePromise<Natural.NewAch>;

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

@@ -228,7 +228,8 @@ class AchClient {
      *         amount: 25000,
      *         currency: "USD",
      *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
-     *         companyEntryDescription: "PAYOUT"
+     *         companyEntryDescription: "PAYOUT",
+     *         addenda: "Invoice 1042, July services"
      *     })
      */
     create(request, requestOptions) {

package/dist/cjs/api/resources/ach/client/requests/NewAchParams.d.ts

@@ -7,7 +7,8 @@ import type * as Natural from "../../../../index.js";
  *         amount: 25000,
  *         currency: "USD",
  *         externalPartyAccountId: "epa_019cd1798d8e5a2f8ceb96020cc3991a",
- *         companyEntryDescription: "PAYOUT"
+ *         companyEntryDescription: "PAYOUT",
+ *         addenda: "Invoice 1042, July services"
  *     }
  */
 export interface NewAchParams {
@@ -29,4 +30,6 @@ export interface NewAchParams {
     mandateId?: string;
     /** ACH company entry description. Maximum 10 characters. */
     companyEntryDescription: string;
+    /** Payment-related information carried to the receiving bank as the NACHA addenda record. Maximum 80 characters. */
+    addenda?: string;
 }

package/dist/cjs/api/resources/ach/types/AchAttrs.d.ts

@@ -10,6 +10,8 @@ export interface AchAttrs {
     status: Natural.AchStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
+    addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */
     secCode: Natural.AchSecCode;
     submittedDescriptor: Natural.AchSubmittedDescriptor;

package/dist/cjs/api/resources/ach/types/AchDetailAttrs.d.ts

@@ -10,6 +10,8 @@ export interface AchDetailAttrs {
     status: Natural.AchDetailStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
+    addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */
     secCode: Natural.AchDetailSecCode;
     submittedDescriptor: Natural.AchDetailSubmittedDescriptor;

package/dist/cjs/api/resources/ach/types/CancelledAchAttrs.d.ts

@@ -10,6 +10,8 @@ export interface CancelledAchAttrs {
     status: Natural.CancelledAchStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
+    addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */
     secCode: Natural.CancelledAchSecCode;
     submittedDescriptor: Natural.CancelledAchSubmittedDescriptor;

package/dist/cjs/api/resources/ach/types/NewAchAttrs.d.ts

@@ -10,6 +10,8 @@ export interface NewAchAttrs {
     status: Natural.NewAchStatus;
     /** The company entry description requested at creation. Echoes the create input verbatim; see `submittedDescriptor` for what was sent to the bank. */
     companyEntryDescription: string;
+    /** Payment-related information carried to the receiving bank as the NACHA addenda record, or null when none was provided. */
+    addenda: string | null;
     /** ACH SEC code the entry is submitted under: WEB, PPD, TEL, or CCD. */
     secCode: Natural.NewAchSecCode;
     submittedDescriptor: Natural.NewAchSubmittedDescriptor;

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

@@ -227,7 +227,7 @@ export declare class AgentsClient {
      *                 type: "email",
      *                 value: "value"
      *             }],
-     *         permissions: ["payments.read"]
+     *         permissions: ["disputes.read"]
      *     })
      */
     createCustomer(request: Natural.CreateCustomerAgentsRequest, requestOptions?: AgentsClient.RequestOptions): core.HttpResponsePromise<Natural.CreateCustomerAgentsResponse>;

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

@@ -738,7 +738,7 @@ class AgentsClient {
      *                 type: "email",
      *                 value: "value"
      *             }],
-     *         permissions: ["payments.read"]
+     *         permissions: ["disputes.read"]
      *     })
      */
     createCustomer(request, requestOptions) {

package/dist/cjs/api/resources/agents/client/requests/CreateCustomerAgentsRequest.d.ts

@@ -8,7 +8,7 @@ import type * as Natural from "../../../../index.js";
  *                 type: "email",
  *                 value: "value"
  *             }],
- *         permissions: ["payments.read"]
+ *         permissions: ["disputes.read"]
  *     }
  */
 export interface CreateCustomerAgentsRequest {

package/dist/cjs/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.d.ts

@@ -1,4 +1,6 @@
 export declare const CreateCustomerAgentsRequestPermissionsItem: {
+    readonly DisputesRead: "disputes.read";
+    readonly DisputesCreate: "disputes.create";
     readonly PaymentsRead: "payments.read";
     readonly PaymentsCreate: "payments.create";
     readonly ExternalPartiesRead: "external_parties.read";
@@ -21,7 +23,10 @@ export declare const CreateCustomerAgentsRequestPermissionsItem: {
     readonly CardPaymentsRead: "card_payments.read";
     readonly RefundsRead: "refunds.read";
     readonly RefundsCreate: "refunds.create";
+    readonly VoiceSessionsRead: "voice_sessions.read";
+    readonly VoiceSessionsCreate: "voice_sessions.create";
     readonly ChargebacksRead: "chargebacks.read";
+    readonly ChargebacksRespond: "chargebacks.respond";
     readonly MandatesRead: "mandates.read";
     readonly EnrollmentRead: "enrollment.read";
 };

package/dist/cjs/api/resources/agents/types/CreateCustomerAgentsRequestPermissionsItem.js

@@ -3,6 +3,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CreateCustomerAgentsRequestPermissionsItem = void 0;
 exports.CreateCustomerAgentsRequestPermissionsItem = {
+    DisputesRead: "disputes.read",
+    DisputesCreate: "disputes.create",
     PaymentsRead: "payments.read",
     PaymentsCreate: "payments.create",
     ExternalPartiesRead: "external_parties.read",
@@ -25,7 +27,10 @@ exports.CreateCustomerAgentsRequestPermissionsItem = {
     CardPaymentsRead: "card_payments.read",
     RefundsRead: "refunds.read",
     RefundsCreate: "refunds.create",
+    VoiceSessionsRead: "voice_sessions.read",
+    VoiceSessionsCreate: "voice_sessions.create",
     ChargebacksRead: "chargebacks.read",
+    ChargebacksRespond: "chargebacks.respond",
     MandatesRead: "mandates.read",
     EnrollmentRead: "enrollment.read",
 };

package/dist/cjs/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.d.ts

@@ -39,10 +39,14 @@ export declare const CreateApiKeysRequestScopesItem: {
     readonly DisputesRead: "disputes.read";
     readonly DisputesCreate: "disputes.create";
     readonly PaymentIntentsRead: "payment_intents.read";
+    readonly PaymentIntentsCreate: "payment_intents.create";
     readonly CardPaymentsRead: "card_payments.read";
     readonly RefundsRead: "refunds.read";
     readonly RefundsCreate: "refunds.create";
+    readonly VoiceSessionsRead: "voice_sessions.read";
+    readonly VoiceSessionsCreate: "voice_sessions.create";
     readonly ChargebacksRead: "chargebacks.read";
+    readonly ChargebacksRespond: "chargebacks.respond";
     readonly MandatesRead: "mandates.read";
     readonly EnrollmentRead: "enrollment.read";
 };

package/dist/cjs/api/resources/apiKeys/types/CreateApiKeysRequestScopesItem.js

@@ -43,10 +43,14 @@ exports.CreateApiKeysRequestScopesItem = {
     DisputesRead: "disputes.read",
     DisputesCreate: "disputes.create",
     PaymentIntentsRead: "payment_intents.read",
+    PaymentIntentsCreate: "payment_intents.create",
     CardPaymentsRead: "card_payments.read",
     RefundsRead: "refunds.read",
     RefundsCreate: "refunds.create",
+    VoiceSessionsRead: "voice_sessions.read",
+    VoiceSessionsCreate: "voice_sessions.create",
     ChargebacksRead: "chargebacks.read",
+    ChargebacksRespond: "chargebacks.respond",
     MandatesRead: "mandates.read",
     EnrollmentRead: "enrollment.read",
 };

package/dist/cjs/api/resources/approvals/types/ApprovalAttrs.d.ts

@@ -14,6 +14,8 @@ export interface ApprovalAttrs {
     ach: Natural.ListApprovalsResponseDataItemAttributesAch | null;
     /** Wire-specific review context. Null unless the target is a wire. */
     wire: Natural.ListApprovalsResponseDataItemAttributesWire | null;
+    /** Check-specific review context. Null unless the target is a check. */
+    check: Natural.ListApprovalsResponseDataItemAttributesCheck | null;
     /** Realtime-specific review context. Null unless the target is a realtime payment. */
     realtime: Natural.ListApprovalsResponseDataItemAttributesRealtime | null;
     /** Who initiated the operation under review, when resolvable. */

package/dist/cjs/api/resources/approvals/types/ApprovalDetailAttrs.d.ts

@@ -14,6 +14,8 @@ export interface ApprovalDetailAttrs {
     ach: Natural.GetApprovalsResponseDataAttributesAch | null;
     /** Wire-specific review context. Null unless the target is a wire. */
     wire: Natural.GetApprovalsResponseDataAttributesWire | null;
+    /** Check-specific review context. Null unless the target is a check. */
+    check: Natural.GetApprovalsResponseDataAttributesCheck | null;
     /** Realtime-specific review context. Null unless the target is a realtime payment. */
     realtime: Natural.GetApprovalsResponseDataAttributesRealtime | null;
     /** Who initiated the operation under review, when resolvable. */

package/dist/cjs/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesAch.d.ts

@@ -6,6 +6,8 @@ export interface ApproveApprovalsResponseDataAttributesAch {
     secCode: Natural.ApproveApprovalsResponseDataAttributesAchSecCode;
     /** Company entry description submitted on the ACH entry. */
     companyEntryDescription: string;
+    /** Payment-related information submitted as the NACHA addenda record, or null. */
+    addenda: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */

package/dist/cjs/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesCheck.d.ts

@@ -0,0 +1,12 @@
+export interface ApproveApprovalsResponseDataAttributesCheck {
+    /** Name printed on the check. */
+    payeeName: string;
+    /** Payee mailing address city. */
+    payeeCity: string;
+    /** Payee mailing address state. */
+    payeeState: string;
+    /** Check amount in cents. */
+    amount: number;
+    /** Memo printed on the check. */
+    memo: string;
+}

package/dist/cjs/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesCheck.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/approvals/types/ApproveApprovalsResponseDataAttributesTargetType.d.ts

@@ -6,5 +6,6 @@ export declare const ApproveApprovalsResponseDataAttributesTargetType: {
     readonly Ach: "ach";
     readonly Realtime: "realtime";
     readonly Wire: "wire";
+    readonly Check: "check";
 };
 export type ApproveApprovalsResponseDataAttributesTargetType = (typeof ApproveApprovalsResponseDataAttributesTargetType)[keyof typeof ApproveApprovalsResponseDataAttributesTargetType];

package/dist/cjs/api/resources/approvals/types/ApproveApprovalsResponseDataAttributesTargetType.js

@@ -10,4 +10,5 @@ exports.ApproveApprovalsResponseDataAttributesTargetType = {
     Ach: "ach",
     Realtime: "realtime",
     Wire: "wire",
+    Check: "check",
 };

package/dist/cjs/api/resources/approvals/types/ApproveResultAttrs.d.ts

@@ -14,6 +14,8 @@ export interface ApproveResultAttrs {
     ach: Natural.ApproveApprovalsResponseDataAttributesAch | null;
     /** Wire-specific review context. Null unless the target is a wire. */
     wire: Natural.ApproveApprovalsResponseDataAttributesWire | null;
+    /** Check-specific review context. Null unless the target is a check. */
+    check: Natural.ApproveApprovalsResponseDataAttributesCheck | null;
     /** Realtime-specific review context. Null unless the target is a realtime payment. */
     realtime: Natural.ApproveApprovalsResponseDataAttributesRealtime | null;
     /** Who initiated the operation under review, when resolvable. */

package/dist/cjs/api/resources/approvals/types/DenyApprovalsResponseDataAttributesAch.d.ts

@@ -6,6 +6,8 @@ export interface DenyApprovalsResponseDataAttributesAch {
     secCode: Natural.DenyApprovalsResponseDataAttributesAchSecCode;
     /** Company entry description submitted on the ACH entry. */
     companyEntryDescription: string;
+    /** Payment-related information submitted as the NACHA addenda record, or null. */
+    addenda: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */

package/dist/cjs/api/resources/approvals/types/DenyApprovalsResponseDataAttributesCheck.d.ts

@@ -0,0 +1,12 @@
+export interface DenyApprovalsResponseDataAttributesCheck {
+    /** Name printed on the check. */
+    payeeName: string;
+    /** Payee mailing address city. */
+    payeeCity: string;
+    /** Payee mailing address state. */
+    payeeState: string;
+    /** Check amount in cents. */
+    amount: number;
+    /** Memo printed on the check. */
+    memo: string;
+}

package/dist/cjs/api/resources/approvals/types/DenyApprovalsResponseDataAttributesCheck.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/approvals/types/DenyApprovalsResponseDataAttributesTargetType.d.ts

@@ -6,5 +6,6 @@ export declare const DenyApprovalsResponseDataAttributesTargetType: {
     readonly Ach: "ach";
     readonly Realtime: "realtime";
     readonly Wire: "wire";
+    readonly Check: "check";
 };
 export type DenyApprovalsResponseDataAttributesTargetType = (typeof DenyApprovalsResponseDataAttributesTargetType)[keyof typeof DenyApprovalsResponseDataAttributesTargetType];

package/dist/cjs/api/resources/approvals/types/DenyApprovalsResponseDataAttributesTargetType.js

@@ -10,4 +10,5 @@ exports.DenyApprovalsResponseDataAttributesTargetType = {
     Ach: "ach",
     Realtime: "realtime",
     Wire: "wire",
+    Check: "check",
 };

package/dist/cjs/api/resources/approvals/types/DenyResultAttrs.d.ts

@@ -14,6 +14,8 @@ export interface DenyResultAttrs {
     ach: Natural.DenyApprovalsResponseDataAttributesAch | null;
     /** Wire-specific review context. Null unless the target is a wire. */
     wire: Natural.DenyApprovalsResponseDataAttributesWire | null;
+    /** Check-specific review context. Null unless the target is a check. */
+    check: Natural.DenyApprovalsResponseDataAttributesCheck | null;
     /** Realtime-specific review context. Null unless the target is a realtime payment. */
     realtime: Natural.DenyApprovalsResponseDataAttributesRealtime | null;
     /** Who initiated the operation under review, when resolvable. */

package/dist/cjs/api/resources/approvals/types/GetApprovalsResponseDataAttributesAch.d.ts

@@ -6,6 +6,8 @@ export interface GetApprovalsResponseDataAttributesAch {
     secCode: Natural.GetApprovalsResponseDataAttributesAchSecCode;
     /** Company entry description submitted on the ACH entry. */
     companyEntryDescription: string;
+    /** Payment-related information submitted as the NACHA addenda record, or null. */
+    addenda: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */

package/dist/cjs/api/resources/approvals/types/GetApprovalsResponseDataAttributesCheck.d.ts

@@ -0,0 +1,12 @@
+export interface GetApprovalsResponseDataAttributesCheck {
+    /** Name printed on the check. */
+    payeeName: string;
+    /** Payee mailing address city. */
+    payeeCity: string;
+    /** Payee mailing address state. */
+    payeeState: string;
+    /** Check amount in cents. */
+    amount: number;
+    /** Memo printed on the check. */
+    memo: string;
+}

package/dist/cjs/api/resources/approvals/types/GetApprovalsResponseDataAttributesCheck.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/approvals/types/GetApprovalsResponseDataAttributesTargetType.d.ts

@@ -6,5 +6,6 @@ export declare const GetApprovalsResponseDataAttributesTargetType: {
     readonly Ach: "ach";
     readonly Realtime: "realtime";
     readonly Wire: "wire";
+    readonly Check: "check";
 };
 export type GetApprovalsResponseDataAttributesTargetType = (typeof GetApprovalsResponseDataAttributesTargetType)[keyof typeof GetApprovalsResponseDataAttributesTargetType];

package/dist/cjs/api/resources/approvals/types/GetApprovalsResponseDataAttributesTargetType.js

@@ -10,4 +10,5 @@ exports.GetApprovalsResponseDataAttributesTargetType = {
     Ach: "ach",
     Realtime: "realtime",
     Wire: "wire",
+    Check: "check",
 };

package/dist/cjs/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesAch.d.ts

@@ -6,6 +6,8 @@ export interface ListApprovalsResponseDataItemAttributesAch {
     secCode: Natural.ListApprovalsResponseDataItemAttributesAchSecCode;
     /** Company entry description submitted on the ACH entry. */
     companyEntryDescription: string;
+    /** Payment-related information submitted as the NACHA addenda record, or null. */
+    addenda: string | null;
     /** Company name submitted on the ACH entry. */
     companyName: string;
     /** RFC 3339 timestamp when the funds are expected to be available, or null when unknown. */