@naturalpay/sdk 1.6.39 → 1.6.42

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributes.d.mts

@@ -0,0 +1,57 @@
+import type * as Natural from "../../../index.mjs";
+export interface CancelCheckResponseDataAttributes {
+    /** Amount in cents. */
+    amount: number;
+    /** Currency code. */
+    currency: Natural.CancelCheckResponseDataAttributesCurrency;
+    /** Check status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, RETURNED, CANCELING, CANCELED, EXPIRED, REJECTED, or FAILED end it. */
+    status: Natural.CancelCheckResponseDataAttributesStatus;
+    /** 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.CancelCheckResponseDataAttributesDeliveryMethod;
+    /** 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.CancelCheckResponseDataAttributesPayee;
+    /** Delivery tracking for the mailed check, or null before it is rendered. */
+    delivery: Natural.CancelCheckResponseDataAttributesDelivery | null;
+    /** Presentment returns observed without moving the payment status. */
+    presentmentReturns: Natural.CancelCheckResponseDataAttributesPresentmentReturnsItem[];
+    /** Post-settlement return details, or null. */
+    return: Natural.CancelCheckResponseDataAttributesReturn | null;
+    /** Cancellation details when the check is canceling or canceled, or null. */
+    cancellation: Natural.CancelCheckResponseDataAttributesCancellation | null;
+    /** Failure details when the check failed, or null. */
+    failure: Natural.CancelCheckResponseDataAttributesFailure | 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/esm/api/resources/check/types/CancelCheckResponseDataAttributes.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesCancellation.d.mts

@@ -0,0 +1,10 @@
+export interface CancelCheckResponseDataAttributesCancellation {
+    /** 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/esm/api/resources/check/types/CancelCheckResponseDataAttributesCancellation.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesCurrency.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency code. */
+export const CancelCheckResponseDataAttributesCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesDelivery.d.mts

@@ -0,0 +1,15 @@
+import type * as Natural from "../../../index.mjs";
+export interface CancelCheckResponseDataAttributesDelivery {
+    /** USPS delivery status. */
+    status: Natural.CancelCheckResponseDataAttributesDeliveryStatus;
+    /** 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/esm/api/resources/check/types/CancelCheckResponseDataAttributesDelivery.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesDeliveryMethod.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesDeliveryMethod.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** How the check is mailed. */
+export const CancelCheckResponseDataAttributesDeliveryMethod = {
+    UspsFirstClass: "USPS_FIRST_CLASS",
+    FedexTwoDay: "FEDEX_TWO_DAY",
+    FedexOvernight: "FEDEX_OVERNIGHT",
+};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesDeliveryStatus.d.mts

@@ -0,0 +1,14 @@
+/** USPS delivery status. */
+export declare const CancelCheckResponseDataAttributesDeliveryStatus: {
+    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 CancelCheckResponseDataAttributesDeliveryStatus = (typeof CancelCheckResponseDataAttributesDeliveryStatus)[keyof typeof CancelCheckResponseDataAttributesDeliveryStatus];

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesDeliveryStatus.mjs

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+/** USPS delivery status. */
+export const CancelCheckResponseDataAttributesDeliveryStatus = {
+    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/esm/api/resources/check/types/CancelCheckResponseDataAttributesFailure.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesFailure.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesPayee.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Payee and the address the check was mailed to, captured when the check was created.
+ */
+export interface CancelCheckResponseDataAttributesPayee {
+    /** 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/esm/api/resources/check/types/CancelCheckResponseDataAttributesPayee.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesPresentmentReturnsItem.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesPresentmentReturnsItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesReturn.d.mts

@@ -0,0 +1,8 @@
+export interface CancelCheckResponseDataAttributesReturn {
+    /** 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/esm/api/resources/check/types/CancelCheckResponseDataAttributesReturn.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesStatus.d.mts

@@ -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 CancelCheckResponseDataAttributesStatus: {
+    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 CancelCheckResponseDataAttributesStatus = (typeof CancelCheckResponseDataAttributesStatus)[keyof typeof CancelCheckResponseDataAttributesStatus];

package/dist/esm/api/resources/check/types/CancelCheckResponseDataAttributesStatus.mjs

@@ -0,0 +1,15 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Check status, in lifecycle order: CREATED, AWAITING_APPROVAL, PROCESSING, COMPLETED; APPROVAL_DENIED, RETURNED, CANCELING, CANCELED, EXPIRED, REJECTED, or FAILED end it. */
+export const CancelCheckResponseDataAttributesStatus = {
+    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/esm/api/resources/check/types/CancelCheckResponseDataRelationships.d.mts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.mjs";
+export interface CancelCheckResponseDataRelationships {
+    /** Party the check was created for. */
+    customerParty: Natural.CancelCheckResponseDataRelationshipsCustomerParty;
+    /** Wallet the check pays from. */
+    wallet: Natural.CancelCheckResponseDataRelationshipsWallet;
+    /** External party paid. */
+    externalParty: Natural.CancelCheckResponseDataRelationshipsExternalParty;
+}

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationships.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsCustomerParty.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsCustomerParty.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsCustomerPartyData.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsCustomerPartyData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsCustomerPartyDataType.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsCustomerPartyDataType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Resource type. Always `party`. */
+export const CancelCheckResponseDataRelationshipsCustomerPartyDataType = {
+    Party: "party",
+};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsExternalParty.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsExternalParty.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsExternalPartyData.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsExternalPartyData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsExternalPartyDataType.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsExternalPartyDataType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Resource type. Always `external_party`. */
+export const CancelCheckResponseDataRelationshipsExternalPartyDataType = {
+    ExternalParty: "external_party",
+};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsWallet.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsWallet.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsWalletData.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsWalletData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsWalletDataType.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataRelationshipsWalletDataType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Resource type. Always `wallet`. */
+export const CancelCheckResponseDataRelationshipsWalletDataType = {
+    Wallet: "wallet",
+};

package/dist/esm/api/resources/check/types/CancelCheckResponseDataType.d.mts

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

package/dist/esm/api/resources/check/types/CancelCheckResponseDataType.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Resource type. Always `check`. */
+export const CancelCheckResponseDataType = {
+    Check: "check",
+};

package/dist/esm/api/resources/check/types/CreateCheckRequestCurrency.d.mts

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

package/dist/esm/api/resources/check/types/CreateCheckRequestCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency code. Defaults to USD. */
+export const CreateCheckRequestCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/check/types/CreateCheckRequestDeliveryMethod.d.mts

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

package/dist/esm/api/resources/check/types/CreateCheckRequestDeliveryMethod.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** How the check is mailed. Defaults to USPS_FIRST_CLASS. */
+export const CreateCheckRequestDeliveryMethod = {
+    UspsFirstClass: "USPS_FIRST_CLASS",
+    FedexTwoDay: "FEDEX_TWO_DAY",
+    FedexOvernight: "FEDEX_OVERNIGHT",
+};

package/dist/esm/api/resources/check/types/CreateCheckResponse.d.mts

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

package/dist/esm/api/resources/check/types/CreateCheckResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CreateCheckResponseData.d.mts

@@ -0,0 +1,9 @@
+import type * as Natural from "../../../index.mjs";
+export interface CreateCheckResponseData {
+    /** Resource type. Always `check`. */
+    type: Natural.CreateCheckResponseDataType;
+    /** Check ID (chk_*). */
+    id: string;
+    attributes: Natural.CreateCheckResponseDataAttributes;
+    relationships: Natural.CreateCheckResponseDataRelationships;
+}

package/dist/esm/api/resources/check/types/CreateCheckResponseData.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CreateCheckResponseDataAttributes.d.mts

@@ -0,0 +1,57 @@
+import type * as Natural from "../../../index.mjs";
+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/esm/api/resources/check/types/CreateCheckResponseDataAttributes.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CreateCheckResponseDataAttributesCancellation.d.mts

@@ -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/esm/api/resources/check/types/CreateCheckResponseDataAttributesCancellation.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CreateCheckResponseDataAttributesCurrency.d.mts

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

package/dist/esm/api/resources/check/types/CreateCheckResponseDataAttributesCurrency.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Currency code. */
+export const CreateCheckResponseDataAttributesCurrency = {
+    Usd: "USD",
+};

package/dist/esm/api/resources/check/types/CreateCheckResponseDataAttributesDelivery.d.mts

@@ -0,0 +1,15 @@
+import type * as Natural from "../../../index.mjs";
+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/esm/api/resources/check/types/CreateCheckResponseDataAttributesDelivery.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/check/types/CreateCheckResponseDataAttributesDeliveryMethod.d.mts

@@ -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/esm/api/resources/check/types/CreateCheckResponseDataAttributesDeliveryMethod.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** How the check is mailed. */
+export const CreateCheckResponseDataAttributesDeliveryMethod = {
+    UspsFirstClass: "USPS_FIRST_CLASS",
+    FedexTwoDay: "FEDEX_TWO_DAY",
+    FedexOvernight: "FEDEX_OVERNIGHT",
+};