@naturalpay/sdk 1.6.8 → 1.6.9

package/dist/esm/api/resources/events/types/GetEventsResponseDataAttributesEventType.d.mts

@@ -39,6 +39,10 @@ export declare const GetEventsResponseDataAttributesEventType: {
     readonly AchSettled: "ach.settled";
     readonly AchFailed: "ach.failed";
     readonly AchReturned: "ach.returned";
+    readonly RealtimeCreated: "realtime.created";
+    readonly RealtimeProcessing: "realtime.processing";
+    readonly RealtimeSettled: "realtime.settled";
+    readonly RealtimeFailed: "realtime.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/esm/api/resources/events/types/GetEventsResponseDataAttributesEventType.mjs

@@ -40,6 +40,10 @@ export const GetEventsResponseDataAttributesEventType = {
     AchSettled: "ach.settled",
     AchFailed: "ach.failed",
     AchReturned: "ach.returned",
+    RealtimeCreated: "realtime.created",
+    RealtimeProcessing: "realtime.processing",
+    RealtimeSettled: "realtime.settled",
+    RealtimeFailed: "realtime.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/esm/api/resources/events/types/ListEventsRequestEventType.d.mts

@@ -39,6 +39,10 @@ export declare const ListEventsRequestEventType: {
     readonly AchSettled: "ach.settled";
     readonly AchFailed: "ach.failed";
     readonly AchReturned: "ach.returned";
+    readonly RealtimeCreated: "realtime.created";
+    readonly RealtimeProcessing: "realtime.processing";
+    readonly RealtimeSettled: "realtime.settled";
+    readonly RealtimeFailed: "realtime.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/esm/api/resources/events/types/ListEventsRequestEventType.mjs

@@ -40,6 +40,10 @@ export const ListEventsRequestEventType = {
     AchSettled: "ach.settled",
     AchFailed: "ach.failed",
     AchReturned: "ach.returned",
+    RealtimeCreated: "realtime.created",
+    RealtimeProcessing: "realtime.processing",
+    RealtimeSettled: "realtime.settled",
+    RealtimeFailed: "realtime.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/esm/api/resources/events/types/ListEventsResponseDataItemAttributesEventType.d.mts

@@ -39,6 +39,10 @@ export declare const ListEventsResponseDataItemAttributesEventType: {
     readonly AchSettled: "ach.settled";
     readonly AchFailed: "ach.failed";
     readonly AchReturned: "ach.returned";
+    readonly RealtimeCreated: "realtime.created";
+    readonly RealtimeProcessing: "realtime.processing";
+    readonly RealtimeSettled: "realtime.settled";
+    readonly RealtimeFailed: "realtime.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

package/dist/esm/api/resources/events/types/ListEventsResponseDataItemAttributesEventType.mjs

@@ -40,6 +40,10 @@ export const ListEventsResponseDataItemAttributesEventType = {
     AchSettled: "ach.settled",
     AchFailed: "ach.failed",
     AchReturned: "ach.returned",
+    RealtimeCreated: "realtime.created",
+    RealtimeProcessing: "realtime.processing",
+    RealtimeSettled: "realtime.settled",
+    RealtimeFailed: "realtime.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

package/dist/esm/api/resources/externalPartyAccounts/types/CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem.d.mts

@@ -0,0 +1,5 @@
+export declare const CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem: {
+    readonly Ach: "ach";
+    readonly Realtime: "realtime";
+};
+export type CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem = (typeof CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem)[keyof typeof CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem];

package/dist/esm/api/resources/externalPartyAccounts/types/CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem = {
+    Ach: "ach",
+    Realtime: "realtime",
+};

package/dist/esm/api/resources/externalPartyAccounts/types/ExtPartyAcctAttrs.d.mts

@@ -3,6 +3,8 @@ export interface ExtPartyAcctAttrs {
     accountDetails: Natural.UsBankAccountDetails;
     /** Account validation state. `pending` when validation could not complete at creation; it resolves asynchronously to `validated` or `failed`. */
     validationState: Natural.ExtPartyAcctValidationState;
+    /** Advisory list of payment rails this account is expected to accept. Refreshed periodically from the payment network; the authoritative check happens when a payment is created. */
+    supportedRails: Natural.ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem[];
     /** ISO creation timestamp. */
     createdAt: string;
     /** ISO update timestamp. */

package/dist/esm/api/resources/externalPartyAccounts/types/ExtPartyAcctDetailAttrs.d.mts

@@ -3,6 +3,8 @@ export interface ExtPartyAcctDetailAttrs {
     accountDetails: Natural.UsBankAccountDetails;
     /** Account validation state. `pending` when validation could not complete at creation; it resolves asynchronously to `validated` or `failed`. */
     validationState: Natural.ExtPartyAcctDetailValidationState;
+    /** Advisory list of payment rails this account is expected to accept. Refreshed periodically from the payment network; the authoritative check happens when a payment is created. */
+    supportedRails: Natural.GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem[];
     /** ISO creation timestamp. */
     createdAt: string;
     /** ISO update timestamp. */

package/dist/esm/api/resources/externalPartyAccounts/types/GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem.d.mts

@@ -0,0 +1,5 @@
+export declare const GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem: {
+    readonly Ach: "ach";
+    readonly Realtime: "realtime";
+};
+export type GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem = (typeof GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem)[keyof typeof GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem];

package/dist/esm/api/resources/externalPartyAccounts/types/GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem = {
+    Ach: "ach",
+    Realtime: "realtime",
+};

package/dist/esm/api/resources/externalPartyAccounts/types/ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem.d.mts

@@ -0,0 +1,5 @@
+export declare const ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem: {
+    readonly Ach: "ach";
+    readonly Realtime: "realtime";
+};
+export type ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem = (typeof ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem)[keyof typeof ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem];

package/dist/esm/api/resources/externalPartyAccounts/types/ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem.mjs

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem = {
+    Ach: "ach",
+    Realtime: "realtime",
+};

package/dist/esm/api/resources/externalPartyAccounts/types/NewExtPartyAcctAttrs.d.mts

@@ -3,6 +3,8 @@ export interface NewExtPartyAcctAttrs {
     accountDetails: Natural.UsBankAccountDetails;
     /** Account validation state. `pending` when validation could not complete at creation; it resolves asynchronously to `validated` or `failed`. */
     validationState: Natural.NewExtPartyAcctValidationState;
+    /** Advisory list of payment rails this account is expected to accept. Refreshed periodically from the payment network; the authoritative check happens when a payment is created. */
+    supportedRails: Natural.CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem[];
     /** ISO creation timestamp. */
     createdAt: string;
     /** ISO update timestamp. */

package/dist/esm/api/resources/externalPartyAccounts/types/index.d.mts

@@ -1,5 +1,6 @@
 export * from "./CreateExternalPartyAccountsRequestAccountDetailsType.mjs";
 export * from "./CreateExternalPartyAccountsResponseDataAttributesAccountDetailsType.mjs";
+export * from "./CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem.mjs";
 export * from "./ExtPartyAcct.mjs";
 export * from "./ExtPartyAcctAttrs.mjs";
 export * from "./ExtPartyAcctDetail.mjs";
@@ -20,8 +21,10 @@ export * from "./ExtPartyAcctPaging.mjs";
 export * from "./ExtPartyAcctRels.mjs";
 export * from "./ExtPartyAcctValidationState.mjs";
 export * from "./GetExternalPartyAccountsResponseDataAttributesAccountDetailsType.mjs";
+export * from "./GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem.mjs";
 export * from "./ListExternalPartyAccountsResponseDataItem.mjs";
 export * from "./ListExternalPartyAccountsResponseDataItemAttributesAccountDetailsType.mjs";
+export * from "./ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem.mjs";
 export * from "./NewExtPartyAcct.mjs";
 export * from "./NewExtPartyAcctAttrs.mjs";
 export * from "./NewExtPartyAcctData.mjs";

package/dist/esm/api/resources/externalPartyAccounts/types/index.mjs

@@ -1,5 +1,6 @@
 export * from "./CreateExternalPartyAccountsRequestAccountDetailsType.mjs";
 export * from "./CreateExternalPartyAccountsResponseDataAttributesAccountDetailsType.mjs";
+export * from "./CreateExternalPartyAccountsResponseDataAttributesSupportedRailsItem.mjs";
 export * from "./ExtPartyAcct.mjs";
 export * from "./ExtPartyAcctAttrs.mjs";
 export * from "./ExtPartyAcctDetail.mjs";
@@ -20,8 +21,10 @@ export * from "./ExtPartyAcctPaging.mjs";
 export * from "./ExtPartyAcctRels.mjs";
 export * from "./ExtPartyAcctValidationState.mjs";
 export * from "./GetExternalPartyAccountsResponseDataAttributesAccountDetailsType.mjs";
+export * from "./GetExternalPartyAccountsResponseDataAttributesSupportedRailsItem.mjs";
 export * from "./ListExternalPartyAccountsResponseDataItem.mjs";
 export * from "./ListExternalPartyAccountsResponseDataItemAttributesAccountDetailsType.mjs";
+export * from "./ListExternalPartyAccountsResponseDataItemAttributesSupportedRailsItem.mjs";
 export * from "./NewExtPartyAcct.mjs";
 export * from "./NewExtPartyAcctAttrs.mjs";
 export * from "./NewExtPartyAcctData.mjs";

package/dist/esm/api/resources/index.d.mts

@@ -43,6 +43,9 @@ export * from "./paymentRequests/types/index.mjs";
 export * from "./payments/client/requests/index.mjs";
 export * as payments from "./payments/index.mjs";
 export * from "./payments/types/index.mjs";
+export * from "./realtime/client/requests/index.mjs";
+export * as realtime from "./realtime/index.mjs";
+export * from "./realtime/types/index.mjs";
 export * from "./simulations/client/requests/index.mjs";
 export * as simulations from "./simulations/index.mjs";
 export * from "./simulations/types/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -43,6 +43,9 @@ export * from "./paymentRequests/types/index.mjs";
 export * from "./payments/client/requests/index.mjs";
 export * as payments from "./payments/index.mjs";
 export * from "./payments/types/index.mjs";
+export * from "./realtime/client/requests/index.mjs";
+export * as realtime from "./realtime/index.mjs";
+export * from "./realtime/types/index.mjs";
 export * from "./simulations/client/requests/index.mjs";
 export * as simulations from "./simulations/index.mjs";
 export * from "./simulations/types/index.mjs";

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.d.mts

@@ -16,5 +16,6 @@ export declare const CreateInvitationLinksRequestProposedAgentsItemPermissionsIt
     readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
+    readonly PaymentIntentsCreate: "payment_intents.create";
 };
 export type CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = (typeof CreateInvitationLinksRequestProposedAgentsItemPermissionsItem)[keyof typeof CreateInvitationLinksRequestProposedAgentsItemPermissionsItem];

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksRequestProposedAgentsItemPermissionsItem.mjs

@@ -17,4 +17,5 @@ export const CreateInvitationLinksRequestProposedAgentsItemPermissionsItem = {
     WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
+    PaymentIntentsCreate: "payment_intents.create",
 };

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -16,5 +16,6 @@ export declare const CreateInvitationLinksResponseDataAttributesProposedAgentsIt
     readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
+    readonly PaymentIntentsCreate: "payment_intents.create";
 };
 export type CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem = (typeof CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem)[keyof typeof CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem];

package/dist/esm/api/resources/invitationLinks/types/CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -17,4 +17,5 @@ export const CreateInvitationLinksResponseDataAttributesProposedAgentsItemPermis
     WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
+    PaymentIntentsCreate: "payment_intents.create",
 };

package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -16,5 +16,6 @@ export declare const GetInvitationLinksResponseDataAttributesProposedAgentsItemP
     readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
+    readonly PaymentIntentsCreate: "payment_intents.create";
 };
 export type GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem = (typeof GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem)[keyof typeof GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem];

package/dist/esm/api/resources/invitationLinks/types/GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -17,4 +17,5 @@ export const GetInvitationLinksResponseDataAttributesProposedAgentsItemPermissio
     WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
+    PaymentIntentsCreate: "payment_intents.create",
 };

package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -16,5 +16,6 @@ export declare const ListInvitationLinksResponseDataItemAttributesProposedAgents
     readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
+    readonly PaymentIntentsCreate: "payment_intents.create";
 };
 export type ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem = (typeof ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem)[keyof typeof ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem];

package/dist/esm/api/resources/invitationLinks/types/ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPermissionsItem.mjs

@@ -17,4 +17,5 @@ export const ListInvitationLinksResponseDataItemAttributesProposedAgentsItemPerm
     WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
+    PaymentIntentsCreate: "payment_intents.create",
 };

package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.d.mts

@@ -16,5 +16,6 @@ export declare const RevokeInvitationLinksResponseDataAttributesProposedAgentsIt
     readonly WalletsWithdraw: "wallets.withdraw";
     readonly PartyRead: "party.read";
     readonly PartyUpdate: "party.update";
+    readonly PaymentIntentsCreate: "payment_intents.create";
 };
 export type RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem = (typeof RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem)[keyof typeof RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem];

package/dist/esm/api/resources/invitationLinks/types/RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermissionsItem.mjs

@@ -17,4 +17,5 @@ export const RevokeInvitationLinksResponseDataAttributesProposedAgentsItemPermis
     WalletsWithdraw: "wallets.withdraw",
     PartyRead: "party.read",
     PartyUpdate: "party.update",
+    PaymentIntentsCreate: "payment_intents.create",
 };

package/dist/esm/api/resources/realtime/client/Client.d.mts

@@ -0,0 +1,132 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Natural from "../../../index.mjs";
+export declare namespace RealtimeClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Make realtime payments to external party accounts
+ */
+export declare class RealtimeClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<RealtimeClient.Options>;
+    constructor(options?: RealtimeClient.Options);
+    /**
+     * List your realtime payments
+     *
+     * @param {Natural.ListRealtimeRequest} request
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.realtime.list()
+     */
+    list(request?: Natural.ListRealtimeRequest, requestOptions?: RealtimeClient.RequestOptions): core.HttpResponsePromise<Natural.ListRealtimeResponse>;
+    private __list;
+    /**
+     * Create a realtime payment to an external party account
+     *
+     * @param {Natural.CreateRealtimeRequest} request
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.realtime.create({
+     *         idempotencyKey: "Idempotency-Key",
+     *         amount: 25000,
+     *         currency: "USD",
+     *         externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
+     *         description: "Invoice 1042 settlement"
+     *     })
+     */
+    create(request: Natural.CreateRealtimeRequest, requestOptions?: RealtimeClient.RequestOptions): core.HttpResponsePromise<Natural.CreateRealtimeResponse>;
+    private __create;
+    /**
+     * Get a realtime payment
+     *
+     * @param {Natural.GetRealtimeRequest} request
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.realtime.get({
+     *         realtimeId: "realtimeId"
+     *     })
+     */
+    get(request: Natural.GetRealtimeRequest, requestOptions?: RealtimeClient.RequestOptions): core.HttpResponsePromise<Natural.GetRealtimeResponse>;
+    private __get;
+    /**
+     * Cancel a realtime payment before submission
+     *
+     * @param {Natural.CancelRealtimeRequest} request
+     * @param {RealtimeClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Natural.BadRequestError}
+     * @throws {@link Natural.UnauthorizedError}
+     * @throws {@link Natural.ForbiddenError}
+     * @throws {@link Natural.NotFoundError}
+     * @throws {@link Natural.ConflictError}
+     * @throws {@link Natural.UnprocessableEntityError}
+     * @throws {@link Natural.PreconditionError}
+     * @throws {@link Natural.TooManyRequestsError}
+     * @throws {@link Natural.InternalServerError}
+     * @throws {@link Natural.NotImplementedError}
+     * @throws {@link Natural.BadGatewayError}
+     * @throws {@link Natural.ServiceUnavailableError}
+     * @throws {@link errors.NaturalError}
+     * @throws {@link errors.NaturalTimeoutError}
+     *
+     * @example
+     *     await client.realtime.cancel({
+     *         idempotencyKey: "Idempotency-Key",
+     *         realtimeId: "realtimeId",
+     *         reason: "Duplicate payment"
+     *     })
+     */
+    cancel(request: Natural.CancelRealtimeRequest, requestOptions?: RealtimeClient.RequestOptions): core.HttpResponsePromise<Natural.CancelRealtimeResponse>;
+    private __cancel;
+}