@naturalpay/sdk 1.6.39 → 1.6.42

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributes.d.ts

@@ -0,0 +1,57 @@
+import type * as Natural from "../../../index.js";
+export interface CreateCheckResponseDataAttributes {
+    /** Amount in cents. */
+    amount: number;
+    /** Currency code. */
+    currency: Natural.CreateCheckResponseDataAttributesCurrency;
+    /** Check status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, RETURNED, CANCELING, CANCELED, EXPIRED, REJECTED, or FAILED end it. */
+    status: Natural.CreateCheckResponseDataAttributesStatus;
+    /** Memo printed on the check. */
+    memo: string;
+    /** Message printed on the check, or null. */
+    message: string | null;
+    /** Description for your internal reference, or null. Never printed on the check or shared with the counterparty. */
+    internalDescription: string | null;
+    /** How the check is mailed. */
+    deliveryMethod: Natural.CreateCheckResponseDataAttributesDeliveryMethod;
+    /** Printed check number, or null. */
+    checkNumber: string | null;
+    /** Date after which the check is void, or null. */
+    voidDate: string | null;
+    /** Payee and the address the check was mailed to, captured when the check was created. */
+    payee: Natural.CreateCheckResponseDataAttributesPayee;
+    /** Delivery tracking for the mailed check, or null before it is rendered. */
+    delivery: Natural.CreateCheckResponseDataAttributesDelivery | null;
+    /** Presentment returns observed without moving the payment status. */
+    presentmentReturns: Natural.CreateCheckResponseDataAttributesPresentmentReturnsItem[];
+    /** Post-settlement return details, or null. */
+    return: Natural.CreateCheckResponseDataAttributesReturn | null;
+    /** Cancellation details when the check is canceling or canceled, or null. */
+    cancellation: Natural.CreateCheckResponseDataAttributesCancellation | null;
+    /** Failure details when the check failed, or null. */
+    failure: Natural.CreateCheckResponseDataAttributesFailure | null;
+    /** Canonical terminal reason, or null. */
+    canonicalReason: string | null;
+    /** RFC 3339 timestamp when the check was submitted, or null. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when the check was issued, or null. */
+    issuedAt: string | null;
+    /** RFC 3339 timestamp when a stop was requested, or null. */
+    stopRequestedAt: string | null;
+    /** RFC 3339 timestamp when the check completed, or null. */
+    completedAt: string | null;
+    /** RFC 3339 timestamp when the check was returned, or null. */
+    returnedAt: string | null;
+    /** RFC 3339 timestamp when the check was canceled, or null. */
+    canceledAt: string | null;
+    /** RFC 3339 timestamp when the check expired, or null. */
+    expiredAt: string | null;
+    /** RFC 3339 timestamp when the check was rejected, or null. */
+    rejectedAt: string | null;
+    /** RFC 3339 timestamp when the check reached a terminal status, or null. */
+    terminalAt: string | null;
+    /** RFC 3339 timestamp when the check was created. */
+    createdAt: string;
+    /** RFC 3339 timestamp when the check was last updated. */
+    updatedAt: string;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributes.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/check/types/CreateCheckResponseDataAttributesCancellation.d.ts

@@ -0,0 +1,10 @@
+export interface CreateCheckResponseDataAttributesCancellation {
+    /** Cancellation reason, or null. */
+    reason: string | null;
+    /** Return code that drove the cancellation, or null. */
+    returnCode: string | null;
+    /** RFC 3339 timestamp when cancellation was requested, or null. */
+    requestedAt: string | null;
+    /** RFC 3339 timestamp when cancellation was confirmed, or null. */
+    confirmedAt: string | null;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesCancellation.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/check/types/CreateCheckResponseDataAttributesCurrency.d.ts

@@ -0,0 +1,5 @@
+/** Currency code. */
+export declare const CreateCheckResponseDataAttributesCurrency: {
+    readonly Usd: "USD";
+};
+export type CreateCheckResponseDataAttributesCurrency = (typeof CreateCheckResponseDataAttributesCurrency)[keyof typeof CreateCheckResponseDataAttributesCurrency];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesCurrency.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataAttributesCurrency = void 0;
+/** Currency code. */
+exports.CreateCheckResponseDataAttributesCurrency = {
+    Usd: "USD",
+};

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesDelivery.d.ts

@@ -0,0 +1,15 @@
+import type * as Natural from "../../../index.js";
+export interface CreateCheckResponseDataAttributesDelivery {
+    /** USPS delivery status. */
+    status: Natural.CreateCheckResponseDataAttributesDeliveryStatus;
+    /** Tracking URL for the mailed check, or null. */
+    trackingUrl: string | null;
+    /** RFC 3339 timestamp when the check was mailed, or null. */
+    mailedAt: string | null;
+    /** RFC 3339 timestamp when the check was delivered, or null. */
+    deliveredAt: string | null;
+    /** RFC 3339 timestamp when the check was returned to sender, or null. */
+    returnedToSenderAt: string | null;
+    /** RFC 3339 timestamp when delivery was last updated, or null. */
+    updatedAt: string | null;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesDelivery.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/check/types/CreateCheckResponseDataAttributesDeliveryMethod.d.ts

@@ -0,0 +1,7 @@
+/** How the check is mailed. */
+export declare const CreateCheckResponseDataAttributesDeliveryMethod: {
+    readonly UspsFirstClass: "USPS_FIRST_CLASS";
+    readonly FedexTwoDay: "FEDEX_TWO_DAY";
+    readonly FedexOvernight: "FEDEX_OVERNIGHT";
+};
+export type CreateCheckResponseDataAttributesDeliveryMethod = (typeof CreateCheckResponseDataAttributesDeliveryMethod)[keyof typeof CreateCheckResponseDataAttributesDeliveryMethod];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesDeliveryMethod.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataAttributesDeliveryMethod = void 0;
+/** How the check is mailed. */
+exports.CreateCheckResponseDataAttributesDeliveryMethod = {
+    UspsFirstClass: "USPS_FIRST_CLASS",
+    FedexTwoDay: "FEDEX_TWO_DAY",
+    FedexOvernight: "FEDEX_OVERNIGHT",
+};

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesDeliveryStatus.d.ts

@@ -0,0 +1,14 @@
+/** USPS delivery status. */
+export declare const CreateCheckResponseDataAttributesDeliveryStatus: {
+    readonly Created: "CREATED";
+    readonly RenderedPdf: "RENDERED_PDF";
+    readonly Mailed: "MAILED";
+    readonly InTransit: "IN_TRANSIT";
+    readonly InLocalArea: "IN_LOCAL_AREA";
+    readonly ProcessedForDelivery: "PROCESSED_FOR_DELIVERY";
+    readonly Delivered: "DELIVERED";
+    readonly Rerouted: "REROUTED";
+    readonly ReturnedToSender: "RETURNED_TO_SENDER";
+    readonly Failed: "FAILED";
+};
+export type CreateCheckResponseDataAttributesDeliveryStatus = (typeof CreateCheckResponseDataAttributesDeliveryStatus)[keyof typeof CreateCheckResponseDataAttributesDeliveryStatus];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesDeliveryStatus.js

@@ -0,0 +1,17 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataAttributesDeliveryStatus = void 0;
+/** USPS delivery status. */
+exports.CreateCheckResponseDataAttributesDeliveryStatus = {
+    Created: "CREATED",
+    RenderedPdf: "RENDERED_PDF",
+    Mailed: "MAILED",
+    InTransit: "IN_TRANSIT",
+    InLocalArea: "IN_LOCAL_AREA",
+    ProcessedForDelivery: "PROCESSED_FOR_DELIVERY",
+    Delivered: "DELIVERED",
+    Rerouted: "REROUTED",
+    ReturnedToSender: "RETURNED_TO_SENDER",
+    Failed: "FAILED",
+};

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesFailure.d.ts

@@ -0,0 +1,6 @@
+export interface CreateCheckResponseDataAttributesFailure {
+    /** Failure code, or null. */
+    code: string | null;
+    /** Failure reason, or null. */
+    reason: string | null;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesFailure.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/check/types/CreateCheckResponseDataAttributesPayee.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Payee and the address the check was mailed to, captured when the check was created.
+ */
+export interface CreateCheckResponseDataAttributesPayee {
+    /** Payee name printed on the check. */
+    name: string;
+    /** Payee street address line 1. */
+    line1: string;
+    /** Payee street address line 2. */
+    line2: string | null;
+    /** Payee city. */
+    city: string;
+    /** Payee state. */
+    state: string;
+    /** Payee postal code. */
+    postalCode: string;
+    /** Version of the recipient address captured when the check was created. */
+    addressVersion: number;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesPayee.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/check/types/CreateCheckResponseDataAttributesPresentmentReturnsItem.d.ts

@@ -0,0 +1,8 @@
+export interface CreateCheckResponseDataAttributesPresentmentReturnsItem {
+    /** Presentment return code. */
+    code: string;
+    /** Presentment return reason. */
+    reason: string;
+    /** RFC 3339 timestamp when the presentment return was observed. */
+    observedAt: string;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesPresentmentReturnsItem.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/check/types/CreateCheckResponseDataAttributesReturn.d.ts

@@ -0,0 +1,8 @@
+export interface CreateCheckResponseDataAttributesReturn {
+    /** Return code. */
+    code: string;
+    /** Return reason, or null. */
+    reason: string | null;
+    /** RFC 3339 timestamp when the return was observed, or null. */
+    observedAt: string | null;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesReturn.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/check/types/CreateCheckResponseDataAttributesStatus.d.ts

@@ -0,0 +1,15 @@
+/** Check status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, RETURNED, CANCELING, CANCELED, EXPIRED, REJECTED, or FAILED end it. */
+export declare const CreateCheckResponseDataAttributesStatus: {
+    readonly Created: "CREATED";
+    readonly AwaitingApproval: "AWAITING_APPROVAL";
+    readonly ApprovalDenied: "APPROVAL_DENIED";
+    readonly Processing: "PROCESSING";
+    readonly Completed: "COMPLETED";
+    readonly Returned: "RETURNED";
+    readonly Canceling: "CANCELING";
+    readonly Canceled: "CANCELED";
+    readonly Expired: "EXPIRED";
+    readonly Rejected: "REJECTED";
+    readonly Failed: "FAILED";
+};
+export type CreateCheckResponseDataAttributesStatus = (typeof CreateCheckResponseDataAttributesStatus)[keyof typeof CreateCheckResponseDataAttributesStatus];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataAttributesStatus.js

@@ -0,0 +1,18 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataAttributesStatus = void 0;
+/** Check status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, RETURNED, CANCELING, CANCELED, EXPIRED, REJECTED, or FAILED end it. */
+exports.CreateCheckResponseDataAttributesStatus = {
+    Created: "CREATED",
+    AwaitingApproval: "AWAITING_APPROVAL",
+    ApprovalDenied: "APPROVAL_DENIED",
+    Processing: "PROCESSING",
+    Completed: "COMPLETED",
+    Returned: "RETURNED",
+    Canceling: "CANCELING",
+    Canceled: "CANCELED",
+    Expired: "EXPIRED",
+    Rejected: "REJECTED",
+    Failed: "FAILED",
+};

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationships.d.ts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.js";
+export interface CreateCheckResponseDataRelationships {
+    /** Party the check was created for. */
+    customerParty: Natural.CreateCheckResponseDataRelationshipsCustomerParty;
+    /** Wallet the check pays from. */
+    wallet: Natural.CreateCheckResponseDataRelationshipsWallet;
+    /** External party paid. */
+    externalParty: Natural.CreateCheckResponseDataRelationshipsExternalParty;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationships.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/check/types/CreateCheckResponseDataRelationshipsCustomerParty.d.ts

@@ -0,0 +1,8 @@
+import type * as Natural from "../../../index.js";
+/**
+ * Party the check was created for.
+ */
+export interface CreateCheckResponseDataRelationshipsCustomerParty {
+    /** Related resource identifier. */
+    data: Natural.CreateCheckResponseDataRelationshipsCustomerPartyData;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsCustomerParty.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/check/types/CreateCheckResponseDataRelationshipsCustomerPartyData.d.ts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.js";
+/**
+ * Related resource identifier.
+ */
+export interface CreateCheckResponseDataRelationshipsCustomerPartyData {
+    /** Resource type. Always `party`. */
+    type: Natural.CreateCheckResponseDataRelationshipsCustomerPartyDataType;
+    id: string;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsCustomerPartyData.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/check/types/CreateCheckResponseDataRelationshipsCustomerPartyDataType.d.ts

@@ -0,0 +1,5 @@
+/** Resource type. Always `party`. */
+export declare const CreateCheckResponseDataRelationshipsCustomerPartyDataType: {
+    readonly Party: "party";
+};
+export type CreateCheckResponseDataRelationshipsCustomerPartyDataType = (typeof CreateCheckResponseDataRelationshipsCustomerPartyDataType)[keyof typeof CreateCheckResponseDataRelationshipsCustomerPartyDataType];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsCustomerPartyDataType.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataRelationshipsCustomerPartyDataType = void 0;
+/** Resource type. Always `party`. */
+exports.CreateCheckResponseDataRelationshipsCustomerPartyDataType = {
+    Party: "party",
+};

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsExternalParty.d.ts

@@ -0,0 +1,8 @@
+import type * as Natural from "../../../index.js";
+/**
+ * External party paid.
+ */
+export interface CreateCheckResponseDataRelationshipsExternalParty {
+    /** Related resource identifier. */
+    data: Natural.CreateCheckResponseDataRelationshipsExternalPartyData;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsExternalParty.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/check/types/CreateCheckResponseDataRelationshipsExternalPartyData.d.ts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.js";
+/**
+ * Related resource identifier.
+ */
+export interface CreateCheckResponseDataRelationshipsExternalPartyData {
+    /** Resource type. Always `external_party`. */
+    type: Natural.CreateCheckResponseDataRelationshipsExternalPartyDataType;
+    id: string;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsExternalPartyData.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/check/types/CreateCheckResponseDataRelationshipsExternalPartyDataType.d.ts

@@ -0,0 +1,5 @@
+/** Resource type. Always `external_party`. */
+export declare const CreateCheckResponseDataRelationshipsExternalPartyDataType: {
+    readonly ExternalParty: "external_party";
+};
+export type CreateCheckResponseDataRelationshipsExternalPartyDataType = (typeof CreateCheckResponseDataRelationshipsExternalPartyDataType)[keyof typeof CreateCheckResponseDataRelationshipsExternalPartyDataType];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsExternalPartyDataType.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataRelationshipsExternalPartyDataType = void 0;
+/** Resource type. Always `external_party`. */
+exports.CreateCheckResponseDataRelationshipsExternalPartyDataType = {
+    ExternalParty: "external_party",
+};

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsWallet.d.ts

@@ -0,0 +1,8 @@
+import type * as Natural from "../../../index.js";
+/**
+ * Wallet the check pays from.
+ */
+export interface CreateCheckResponseDataRelationshipsWallet {
+    /** Related resource identifier. */
+    data: Natural.CreateCheckResponseDataRelationshipsWalletData;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsWallet.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/check/types/CreateCheckResponseDataRelationshipsWalletData.d.ts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.js";
+/**
+ * Related resource identifier.
+ */
+export interface CreateCheckResponseDataRelationshipsWalletData {
+    /** Resource type. Always `wallet`. */
+    type: Natural.CreateCheckResponseDataRelationshipsWalletDataType;
+    id: string;
+}

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsWalletData.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/check/types/CreateCheckResponseDataRelationshipsWalletDataType.d.ts

@@ -0,0 +1,5 @@
+/** Resource type. Always `wallet`. */
+export declare const CreateCheckResponseDataRelationshipsWalletDataType: {
+    readonly Wallet: "wallet";
+};
+export type CreateCheckResponseDataRelationshipsWalletDataType = (typeof CreateCheckResponseDataRelationshipsWalletDataType)[keyof typeof CreateCheckResponseDataRelationshipsWalletDataType];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataRelationshipsWalletDataType.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataRelationshipsWalletDataType = void 0;
+/** Resource type. Always `wallet`. */
+exports.CreateCheckResponseDataRelationshipsWalletDataType = {
+    Wallet: "wallet",
+};

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataType.d.ts

@@ -0,0 +1,5 @@
+/** Resource type. Always `check`. */
+export declare const CreateCheckResponseDataType: {
+    readonly Check: "check";
+};
+export type CreateCheckResponseDataType = (typeof CreateCheckResponseDataType)[keyof typeof CreateCheckResponseDataType];

package/dist/cjs/api/resources/check/types/CreateCheckResponseDataType.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCheckResponseDataType = void 0;
+/** Resource type. Always `check`. */
+exports.CreateCheckResponseDataType = {
+    Check: "check",
+};

package/dist/cjs/api/resources/check/types/GetCheckResponse.d.ts

@@ -0,0 +1,4 @@
+import type * as Natural from "../../../index.js";
+export interface GetCheckResponse {
+    data: Natural.GetCheckResponseData;
+}

package/dist/cjs/api/resources/check/types/GetCheckResponse.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/check/types/GetCheckResponseData.d.ts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.js";
+export interface GetCheckResponseData {
+    /** Resource type. Always `check`. */
+    type: Natural.GetCheckResponseDataType;
+    /** Check ID (chk_*). */
+    id: string;
+    attributes: Natural.GetCheckResponseDataAttributes;
+    relationships: Natural.GetCheckResponseDataRelationships;
+}

package/dist/cjs/api/resources/check/types/GetCheckResponseData.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/check/types/GetCheckResponseDataAttributes.d.ts

@@ -0,0 +1,57 @@
+import type * as Natural from "../../../index.js";
+export interface GetCheckResponseDataAttributes {
+    /** Amount in cents. */
+    amount: number;
+    /** Currency code. */
+    currency: Natural.GetCheckResponseDataAttributesCurrency;
+    /** Check status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, RETURNED, CANCELING, CANCELED, EXPIRED, REJECTED, or FAILED end it. */
+    status: Natural.GetCheckResponseDataAttributesStatus;
+    /** Memo printed on the check. */
+    memo: string;
+    /** Message printed on the check, or null. */
+    message: string | null;
+    /** Description for your internal reference, or null. Never printed on the check or shared with the counterparty. */
+    internalDescription: string | null;
+    /** How the check is mailed. */
+    deliveryMethod: Natural.GetCheckResponseDataAttributesDeliveryMethod;
+    /** Printed check number, or null. */
+    checkNumber: string | null;
+    /** Date after which the check is void, or null. */
+    voidDate: string | null;
+    /** Payee and the address the check was mailed to, captured when the check was created. */
+    payee: Natural.GetCheckResponseDataAttributesPayee;
+    /** Delivery tracking for the mailed check, or null before it is rendered. */
+    delivery: Natural.GetCheckResponseDataAttributesDelivery | null;
+    /** Presentment returns observed without moving the payment status. */
+    presentmentReturns: Natural.GetCheckResponseDataAttributesPresentmentReturnsItem[];
+    /** Post-settlement return details, or null. */
+    return: Natural.GetCheckResponseDataAttributesReturn | null;
+    /** Cancellation details when the check is canceling or canceled, or null. */
+    cancellation: Natural.GetCheckResponseDataAttributesCancellation | null;
+    /** Failure details when the check failed, or null. */
+    failure: Natural.GetCheckResponseDataAttributesFailure | null;
+    /** Canonical terminal reason, or null. */
+    canonicalReason: string | null;
+    /** RFC 3339 timestamp when the check was submitted, or null. */
+    submittedAt: string | null;
+    /** RFC 3339 timestamp when the check was issued, or null. */
+    issuedAt: string | null;
+    /** RFC 3339 timestamp when a stop was requested, or null. */
+    stopRequestedAt: string | null;
+    /** RFC 3339 timestamp when the check completed, or null. */
+    completedAt: string | null;
+    /** RFC 3339 timestamp when the check was returned, or null. */
+    returnedAt: string | null;
+    /** RFC 3339 timestamp when the check was canceled, or null. */
+    canceledAt: string | null;
+    /** RFC 3339 timestamp when the check expired, or null. */
+    expiredAt: string | null;
+    /** RFC 3339 timestamp when the check was rejected, or null. */
+    rejectedAt: string | null;
+    /** RFC 3339 timestamp when the check reached a terminal status, or null. */
+    terminalAt: string | null;
+    /** RFC 3339 timestamp when the check was created. */
+    createdAt: string;
+    /** RFC 3339 timestamp when the check was last updated. */
+    updatedAt: string;
+}

package/dist/cjs/api/resources/check/types/GetCheckResponseDataAttributes.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/check/types/GetCheckResponseDataAttributesCancellation.d.ts

@@ -0,0 +1,10 @@
+export interface GetCheckResponseDataAttributesCancellation {
+    /** Cancellation reason, or null. */
+    reason: string | null;
+    /** Return code that drove the cancellation, or null. */
+    returnCode: string | null;
+    /** RFC 3339 timestamp when cancellation was requested, or null. */
+    requestedAt: string | null;
+    /** RFC 3339 timestamp when cancellation was confirmed, or null. */
+    confirmedAt: string | null;
+}

package/dist/cjs/api/resources/check/types/GetCheckResponseDataAttributesCancellation.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/check/types/GetCheckResponseDataAttributesCurrency.d.ts

@@ -0,0 +1,5 @@
+/** Currency code. */
+export declare const GetCheckResponseDataAttributesCurrency: {
+    readonly Usd: "USD";
+};
+export type GetCheckResponseDataAttributesCurrency = (typeof GetCheckResponseDataAttributesCurrency)[keyof typeof GetCheckResponseDataAttributesCurrency];

package/dist/cjs/api/resources/check/types/GetCheckResponseDataAttributesCurrency.js

@@ -0,0 +1,8 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetCheckResponseDataAttributesCurrency = void 0;
+/** Currency code. */
+exports.GetCheckResponseDataAttributesCurrency = {
+    Usd: "USD",
+};

package/dist/cjs/api/resources/check/types/GetCheckResponseDataAttributesDelivery.d.ts

@@ -0,0 +1,15 @@
+import type * as Natural from "../../../index.js";
+export interface GetCheckResponseDataAttributesDelivery {
+    /** USPS delivery status. */
+    status: Natural.GetCheckResponseDataAttributesDeliveryStatus;
+    /** Tracking URL for the mailed check, or null. */
+    trackingUrl: string | null;
+    /** RFC 3339 timestamp when the check was mailed, or null. */
+    mailedAt: string | null;
+    /** RFC 3339 timestamp when the check was delivered, or null. */
+    deliveredAt: string | null;
+    /** RFC 3339 timestamp when the check was returned to sender, or null. */
+    returnedToSenderAt: string | null;
+    /** RFC 3339 timestamp when delivery was last updated, or null. */
+    updatedAt: string | null;
+}

package/dist/cjs/api/resources/check/types/GetCheckResponseDataAttributesDelivery.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/check/types/GetCheckResponseDataAttributesDeliveryMethod.d.ts

@@ -0,0 +1,7 @@
+/** How the check is mailed. */
+export declare const GetCheckResponseDataAttributesDeliveryMethod: {
+    readonly UspsFirstClass: "USPS_FIRST_CLASS";
+    readonly FedexTwoDay: "FEDEX_TWO_DAY";
+    readonly FedexOvernight: "FEDEX_OVERNIGHT";
+};
+export type GetCheckResponseDataAttributesDeliveryMethod = (typeof GetCheckResponseDataAttributesDeliveryMethod)[keyof typeof GetCheckResponseDataAttributesDeliveryMethod];