@naturalpay/sdk 1.6.33 → 1.6.35

package/dist/cjs/api/resources/{agentCards/types/CreateAgentCardsResponseDataAttributesCurrency.js → agenticPayments/types/CardAgenticPaymentsResponseDataMandatesItemCurrency.js}

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

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataMandatesItemMerchantScope.d.ts

@@ -0,0 +1,4 @@
+export declare const CardAgenticPaymentsResponseDataMandatesItemMerchantScope: {
+    readonly Any: "any";
+};
+export type CardAgenticPaymentsResponseDataMandatesItemMerchantScope = (typeof CardAgenticPaymentsResponseDataMandatesItemMerchantScope)[keyof typeof CardAgenticPaymentsResponseDataMandatesItemMerchantScope];

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataMandatesItemMerchantScope.js

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

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataMandatesItemProvider.d.ts

@@ -0,0 +1,5 @@
+export declare const CardAgenticPaymentsResponseDataMandatesItemProvider: {
+    readonly BasisTheory: "basis_theory";
+    readonly Simulation: "simulation";
+};
+export type CardAgenticPaymentsResponseDataMandatesItemProvider = (typeof CardAgenticPaymentsResponseDataMandatesItemProvider)[keyof typeof CardAgenticPaymentsResponseDataMandatesItemProvider];

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataMandatesItemProvider.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.CardAgenticPaymentsResponseDataMandatesItemProvider = void 0;
+exports.CardAgenticPaymentsResponseDataMandatesItemProvider = {
+    BasisTheory: "basis_theory",
+    Simulation: "simulation",
+};

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataMandatesItemStatus.d.ts

@@ -0,0 +1,11 @@
+export declare const CardAgenticPaymentsResponseDataMandatesItemStatus: {
+    readonly Creating: "creating";
+    readonly ReconciliationRequired: "reconciliation_required";
+    readonly RequiresAction: "requires_action";
+    readonly Active: "active";
+    readonly Revoked: "revoked";
+    readonly Error: "error";
+    readonly OutcomeUnknown: "outcome_unknown";
+    readonly Expired: "expired";
+};
+export type CardAgenticPaymentsResponseDataMandatesItemStatus = (typeof CardAgenticPaymentsResponseDataMandatesItemStatus)[keyof typeof CardAgenticPaymentsResponseDataMandatesItemStatus];

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataMandatesItemStatus.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardAgenticPaymentsResponseDataMandatesItemStatus = void 0;
+exports.CardAgenticPaymentsResponseDataMandatesItemStatus = {
+    Creating: "creating",
+    ReconciliationRequired: "reconciliation_required",
+    RequiresAction: "requires_action",
+    Active: "active",
+    Revoked: "revoked",
+    Error: "error",
+    OutcomeUnknown: "outcome_unknown",
+    Expired: "expired",
+};

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataPaymentMethod.d.ts

@@ -0,0 +1,8 @@
+import type * as Natural from "../../../index.js";
+export interface CardAgenticPaymentsResponseDataPaymentMethod {
+    id: string;
+    cardId: string;
+    provider: Natural.CardAgenticPaymentsResponseDataPaymentMethodProvider;
+    status: Natural.CardAgenticPaymentsResponseDataPaymentMethodStatus;
+    errorCode: string | null;
+}

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataPaymentMethodProvider.d.ts

@@ -0,0 +1,5 @@
+export declare const CardAgenticPaymentsResponseDataPaymentMethodProvider: {
+    readonly BasisTheory: "basis_theory";
+    readonly Simulation: "simulation";
+};
+export type CardAgenticPaymentsResponseDataPaymentMethodProvider = (typeof CardAgenticPaymentsResponseDataPaymentMethodProvider)[keyof typeof CardAgenticPaymentsResponseDataPaymentMethodProvider];

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataPaymentMethodProvider.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.CardAgenticPaymentsResponseDataPaymentMethodProvider = void 0;
+exports.CardAgenticPaymentsResponseDataPaymentMethodProvider = {
+    BasisTheory: "basis_theory",
+    Simulation: "simulation",
+};

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataPaymentMethodStatus.d.ts

@@ -0,0 +1,11 @@
+export declare const CardAgenticPaymentsResponseDataPaymentMethodStatus: {
+    readonly Enrolling: "enrolling";
+    readonly RequiresAction: "requires_action";
+    readonly Enabled: "enabled";
+    readonly Suspended: "suspended";
+    readonly Deleted: "deleted";
+    readonly ReconciliationRequired: "reconciliation_required";
+    readonly Error: "error";
+    readonly OutcomeUnknown: "outcome_unknown";
+};
+export type CardAgenticPaymentsResponseDataPaymentMethodStatus = (typeof CardAgenticPaymentsResponseDataPaymentMethodStatus)[keyof typeof CardAgenticPaymentsResponseDataPaymentMethodStatus];

package/dist/cjs/api/resources/agenticPayments/types/CardAgenticPaymentsResponseDataPaymentMethodStatus.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardAgenticPaymentsResponseDataPaymentMethodStatus = void 0;
+exports.CardAgenticPaymentsResponseDataPaymentMethodStatus = {
+    Enrolling: "enrolling",
+    RequiresAction: "requires_action",
+    Enabled: "enabled",
+    Suspended: "suspended",
+    Deleted: "deleted",
+    ReconciliationRequired: "reconciliation_required",
+    Error: "error",
+    OutcomeUnknown: "outcome_unknown",
+};

package/dist/cjs/api/resources/agenticPayments/types/index.d.ts

@@ -6,6 +6,17 @@ export * from "./CancelPurchaseAgenticPaymentsResponseDataDelivery.js";
 export * from "./CancelPurchaseAgenticPaymentsResponseDataMerchant.js";
 export * from "./CancelPurchaseAgenticPaymentsResponseDataProvider.js";
 export * from "./CancelPurchaseAgenticPaymentsResponseDataStatus.js";
+export * from "./CardAgenticPaymentsRequestProvider.js";
+export * from "./CardAgenticPaymentsResponse.js";
+export * from "./CardAgenticPaymentsResponseData.js";
+export * from "./CardAgenticPaymentsResponseDataMandatesItem.js";
+export * from "./CardAgenticPaymentsResponseDataMandatesItemCurrency.js";
+export * from "./CardAgenticPaymentsResponseDataMandatesItemMerchantScope.js";
+export * from "./CardAgenticPaymentsResponseDataMandatesItemProvider.js";
+export * from "./CardAgenticPaymentsResponseDataMandatesItemStatus.js";
+export * from "./CardAgenticPaymentsResponseDataPaymentMethod.js";
+export * from "./CardAgenticPaymentsResponseDataPaymentMethodProvider.js";
+export * from "./CardAgenticPaymentsResponseDataPaymentMethodStatus.js";
 export * from "./ClaimPurchaseAgenticPaymentsResponse.js";
 export * from "./ClaimPurchaseAgenticPaymentsResponseData.js";
 export * from "./ClaimPurchaseAgenticPaymentsResponseDataAgentToken.js";

package/dist/cjs/api/resources/agenticPayments/types/index.js

@@ -22,6 +22,17 @@ __exportStar(require("./CancelPurchaseAgenticPaymentsResponseDataDelivery.js"),
 __exportStar(require("./CancelPurchaseAgenticPaymentsResponseDataMerchant.js"), exports);
 __exportStar(require("./CancelPurchaseAgenticPaymentsResponseDataProvider.js"), exports);
 __exportStar(require("./CancelPurchaseAgenticPaymentsResponseDataStatus.js"), exports);
+__exportStar(require("./CardAgenticPaymentsRequestProvider.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponse.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseData.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataMandatesItem.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataMandatesItemCurrency.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataMandatesItemMerchantScope.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataMandatesItemProvider.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataMandatesItemStatus.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataPaymentMethod.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataPaymentMethodProvider.js"), exports);
+__exportStar(require("./CardAgenticPaymentsResponseDataPaymentMethodStatus.js"), exports);
 __exportStar(require("./ClaimPurchaseAgenticPaymentsResponse.js"), exports);
 __exportStar(require("./ClaimPurchaseAgenticPaymentsResponseData.js"), exports);
 __exportStar(require("./ClaimPurchaseAgenticPaymentsResponseDataAgentToken.js"), exports);

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

@@ -12,6 +12,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface CreateCustomerAgentsRequest {
+    /** Agent ID (agt_*). */
     agentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

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

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetAgentsRequest {
+    /** Agent ID (agt_*). */
     agentId: string;
 }

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

@@ -4,7 +4,10 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListAgentsRequest {
+    /** Filter by status. */
     status?: Natural.ListAgentsRequestStatus;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

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

@@ -5,7 +5,10 @@
  *     }
  */
 export interface ListCustomersAgentsRequest {
+    /** Agent ID (agt_*). */
     agentId: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

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

@@ -4,9 +4,14 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListInvitationsAgentsRequest {
+    /** Filter by invitation status. */
     status?: Natural.ListInvitationsAgentsRequestStatusItem | Natural.ListInvitationsAgentsRequestStatusItem[];
+    /** Filter by customer email. */
     customerEmail?: string;
+    /** Filter by agent ID (agt_*). */
     agentId?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

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

@@ -6,6 +6,7 @@
  *     }
  */
 export interface RemoveAgentsRequest {
+    /** Agent ID (agt_*). */
     agentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

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

@@ -7,7 +7,9 @@
  *     }
  */
 export interface RemoveCustomerAgentsRequest {
+    /** Agent ID (agt_*). */
     agentId: string;
+    /** Customer party ID (pty_*). */
     customerId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

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

@@ -6,6 +6,7 @@
  *     }
  */
 export interface RevokeInvitationAgentsRequest {
+    /** Invitation ID (adi_*). */
     id: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

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

@@ -12,6 +12,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface UpdAgentParams {
+    /** Agent ID (agt_*). */
     agentId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

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

@@ -7,6 +7,8 @@ export interface ListCustomersAgentsResponseDataItemAttributes {
     name: string | null;
     /** Customer email, when known */
     email: string | null;
+    /** Customer party avatar URL, when known */
+    avatarUrl: string | null;
     /** Current agent-customer relationship status */
     status: Natural.ListCustomersAgentsResponseDataItemAttributesStatus;
     /** Permissions granted or requested for this agent */

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

@@ -7,6 +7,8 @@ export interface RemoveCustomerAgentsResponseDataAttributes {
     name: string | null;
     /** Customer email, when known */
     email: string | null;
+    /** Customer party avatar URL, when known */
+    avatarUrl: string | null;
     /** Current agent-customer relationship status */
     status: Natural.RemoveCustomerAgentsResponseDataAttributesStatus;
     /** Permissions granted or requested for this agent */

package/dist/cjs/api/resources/apiKeys/client/requests/GetApiKeysRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetApiKeysRequest {
+    /** API key ID (apy_*). */
     keyId: string;
 }

package/dist/cjs/api/resources/apiKeys/client/requests/ListApiKeysRequest.d.ts

@@ -4,7 +4,10 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListApiKeysRequest {
+    /** Filter by status. */
     status?: Natural.ListApiKeysRequestStatus;
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Maximum results per page. */
     limit?: number;
 }

package/dist/cjs/api/resources/apiKeys/client/requests/RevokeApiKeysRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface RevokeApiKeysRequest {
+    /** API key ID (apy_*). */
     keyId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/approvals/client/requests/ApproveApprovalsRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface ApproveApprovalsRequest {
+    /** Approval ID (apr_*). */
     approvalId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/approvals/client/requests/DenyApprovalsRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface DenyApprovalsRequest {
+    /** Approval ID (apr_*). */
     approvalId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/approvals/client/requests/GetApprovalsRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetApprovalsRequest {
+    /** Approval ID (apr_*). */
     approvalId: string;
 }

package/dist/cjs/api/resources/approvals/client/requests/ListApprovalsRequest.d.ts

@@ -4,7 +4,10 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListApprovalsRequest {
+    /** Maximum results per page. */
     limit?: number;
+    /** Filter by status. Defaults to pending. */
     status?: Natural.ListApprovalsRequestStatus;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/cardPayments/client/requests/GetCardPaymentsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetCardPaymentsRequest {
+    /** Card payment ID (cpy_*). */
     cardPaymentId: string;
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/cardPayments/client/requests/ListCardPaymentsRequest.d.ts

@@ -4,11 +4,18 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListCardPaymentsRequest {
+    /** Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer. */
     customerPartyId?: string;
+    /** Only attempts for this payment intent (pmi_*). */
     paymentIntentId?: string;
+    /** Only attempts with this status. */
     status?: Natural.ListCardPaymentsRequestStatus;
+    /** Only attempts created after this RFC 3339 timestamp (exclusive). */
     createdAfter?: string;
+    /** Only attempts created before this RFC 3339 timestamp (exclusive). */
     createdBefore?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/cardSessions/client/requests/ClaimCardSessionsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface ClaimCardSessionsRequest {
+    /** Card session ID (csn_*). */
     sessionId: string;
+    /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/cardSessions/client/requests/GetCardSessionsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetCardSessionsRequest {
+    /** Card session ID (csn_*). */
     sessionId: string;
+    /** Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/chargebacks/client/requests/AcceptChargebacksRequest.d.ts

@@ -6,7 +6,9 @@
  *     }
  */
 export interface AcceptChargebacksRequest {
+    /** Chargeback ID (cbk_*). */
     chargebackId: string;
+    /** Connected customer to act on behalf of. */
     customerPartyId?: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/chargebacks/client/requests/GetChargebacksRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetChargebacksRequest {
+    /** Chargeback ID (cbk_*). */
     chargebackId: string;
+    /** Connected customer to act on behalf of. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/chargebacks/client/requests/GetEvidenceChargebacksRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetEvidenceChargebacksRequest {
+    /** Chargeback ID (cbk_*). */
     chargebackId: string;
+    /** Connected customer to act on behalf of. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/chargebacks/client/requests/ListChargebacksRequest.d.ts

@@ -4,10 +4,16 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListChargebacksRequest {
+    /** Connected customer to act on behalf of. */
     customerPartyId?: string;
+    /** Filter by card payment ID (cpy_*). */
     cardPaymentId?: string;
+    /** Filter by payment intent ID (pmi_*). */
     paymentIntentId?: string;
+    /** Filter by chargeback status. */
     status?: Natural.ListChargebacksRequestStatus;
+    /** Maximum results per page. */
     limit?: number;
+    /** Cursor from the previous page. */
     cursor?: string;
 }

package/dist/cjs/api/resources/chargebacks/client/requests/PreviewEvidenceChargebacksRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface PreviewEvidenceChargebacksRequest {
+    /** Chargeback ID (cbk_*). */
     chargebackId: string;
+    /** Connected customer to act on behalf of. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/chargebacks/client/requests/SubmitChargebacksRequest.d.ts

@@ -7,6 +7,7 @@
  *     }
  */
 export interface SubmitChargebacksRequest {
+    /** Chargeback ID (cbk_*). */
     chargebackId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/chargebacks/client/requests/UpdateEvidenceChargebacksRequest.d.ts

@@ -12,6 +12,7 @@ import type * as Natural from "../../../../index.js";
  *     }
  */
 export interface UpdateEvidenceChargebacksRequest {
+    /** Chargeback ID (cbk_*). */
     chargebackId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/chargebacks/client/requests/UploadFileChargebacksRequest.d.ts

@@ -8,6 +8,7 @@ import type * as core from "../../../../../core/index.js";
  *     }
  */
 export interface UploadFileChargebacksRequest {
+    /** Chargeback ID (cbk_*). */
     chargebackId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/chargebacks/types/ListChargebacksRequestStatus.d.ts

@@ -1,3 +1,4 @@
+/** Filter by chargeback status. */
 export declare const ListChargebacksRequestStatus: {
     readonly NeedsResponse: "needsResponse";
     readonly Expired: "expired";

package/dist/cjs/api/resources/chargebacks/types/ListChargebacksRequestStatus.js

@@ -2,6 +2,7 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListChargebacksRequestStatus = void 0;
+/** Filter by chargeback status. */
 exports.ListChargebacksRequestStatus = {
     NeedsResponse: "needsResponse",
     Expired: "expired",

package/dist/cjs/api/resources/customers/client/requests/GetCustomersRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface GetCustomersRequest {
+    /** Customer party ID (pty_*). */
     customerId: string;
 }

package/dist/cjs/api/resources/customers/client/requests/ListCustomersRequest.d.ts

@@ -4,7 +4,10 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListCustomersRequest {
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Filter by connection state. Active returns any non-revoked connection (including suspended and expired). Revoked returns customers whose access was revoked. All returns both. */
     status?: Natural.ListCustomersRequestStatus;
 }

package/dist/cjs/api/resources/customers/client/requests/ListInvitationsCustomersRequest.d.ts

@@ -3,6 +3,8 @@
  *     {}
  */
 export interface ListInvitationsCustomersRequest {
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Maximum results per page. */
     limit?: number;
 }

package/dist/cjs/api/resources/customers/client/requests/RemoveCustomersRequest.d.ts

@@ -6,6 +6,7 @@
  *     }
  */
 export interface RemoveCustomersRequest {
+    /** Customer party ID (pty_*). */
     customerId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/customers/client/requests/RevokeAgentCustomersRequest.d.ts

@@ -6,6 +6,8 @@
  *     }
  */
 export interface RevokeAgentCustomersRequest {
+    /** Customer party ID (pty_*). */
     customerId: string;
+    /** Agent ID (agt_*). */
     agentId: string;
 }

package/dist/cjs/api/resources/customers/client/requests/RevokeInvitationCustomersRequest.d.ts

@@ -5,5 +5,6 @@
  *     }
  */
 export interface RevokeInvitationCustomersRequest {
+    /** Invitation ID (adi_*). */
     invitationId: string;
 }

package/dist/cjs/api/resources/events/client/requests/GetEventsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetEventsRequest {
+    /** Event ID (evt_*). */
     eventId: string;
+    /** Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/events/client/requests/ListEventsRequest.d.ts

@@ -4,10 +4,16 @@ import type * as Natural from "../../../../index.js";
  *     {}
  */
 export interface ListEventsRequest {
+    /** Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf. */
     customerPartyId?: string;
+    /** Filter by event type. Required when customerPartyId names another party. */
     eventType?: Natural.ListEventsRequestEventType;
+    /** Only events created after this RFC 3339 timestamp (exclusive). */
     createdAfter?: Date;
+    /** Only events created before this RFC 3339 timestamp (exclusive). */
     createdBefore?: Date;
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Maximum results per page. */
     limit?: number;
 }

package/dist/cjs/api/resources/events/client/requests/RedeliverEventsRequest.d.ts

@@ -7,7 +7,9 @@
  *     }
  */
 export interface RedeliverEventsRequest {
+    /** Webhook ID (whk_*). */
     webhookId: string;
+    /** Event ID (evt_*). */
     eventId: string;
     /** Unique key for safely retrying a request without creating duplicates. */
     idempotencyKey: string;

package/dist/cjs/api/resources/externalAccounts/client/requests/GetExternalAccountsRequest.d.ts

@@ -5,6 +5,8 @@
  *     }
  */
 export interface GetExternalAccountsRequest {
+    /** External account ID (eac_*). */
     externalAccountId: string;
+    /** Customer party to read for (pty_*). Requires a connected agent with wallets.read permission. Omit to read your own party's banking information. */
     customerPartyId?: string;
 }

package/dist/cjs/api/resources/externalAccounts/client/requests/ListCardsExternalAccountsRequest.d.ts

@@ -3,7 +3,10 @@
  *     {}
  */
 export interface ListCardsExternalAccountsRequest {
+    /** Cursor from the previous page. */
     cursor?: string;
+    /** Maximum results per page. */
     limit?: number;
+    /** Customer party to read for (pty_*). Requires a connected agent with wallets.read permission. Omit to read your own party's banking information. */
     customerPartyId?: string;
 }