@naturalpay/sdk 1.6.10 → 1.6.12

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWireCounterpartyAccount.d.mts

@@ -0,0 +1,14 @@
+import type * as Natural from "../../../index.mjs";
+/**
+ * Masked bank account the payment credits.
+ */
+export interface ListApprovalsResponseDataItemAttributesWireCounterpartyAccount {
+    /** External party account (epa_*). */
+    id: string;
+    /** Bank account type. */
+    accountType: Natural.ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType;
+    /** Last four account number digits. */
+    last4: string;
+    /** Masked account number. */
+    mask: string;
+}

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWireCounterpartyAccount.mjs

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

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType.d.mts

@@ -0,0 +1,6 @@
+/** Bank account type. */
+export declare const ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType: {
+    readonly Checking: "checking";
+    readonly Savings: "savings";
+};
+export type ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType = (typeof ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType)[keyof typeof ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType];

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Bank account type. */
+export const ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType = {
+    Checking: "checking",
+    Savings: "savings",
+};

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWireCounterpartyKind.d.mts

@@ -0,0 +1,6 @@
+/** External party type. */
+export declare const ListApprovalsResponseDataItemAttributesWireCounterpartyKind: {
+    readonly Individual: "individual";
+    readonly Business: "business";
+};
+export type ListApprovalsResponseDataItemAttributesWireCounterpartyKind = (typeof ListApprovalsResponseDataItemAttributesWireCounterpartyKind)[keyof typeof ListApprovalsResponseDataItemAttributesWireCounterpartyKind];

package/dist/esm/api/resources/approvals/types/ListApprovalsResponseDataItemAttributesWireCounterpartyKind.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** External party type. */
+export const ListApprovalsResponseDataItemAttributesWireCounterpartyKind = {
+    Individual: "individual",
+    Business: "business",
+};

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

@@ -36,6 +36,11 @@ export * from "./ApproveApprovalsResponseDataAttributesReasonsItem.mjs";
 export * from "./ApproveApprovalsResponseDataAttributesReasonsItemLimitType.mjs";
 export * from "./ApproveApprovalsResponseDataAttributesReasonsItemType.mjs";
 export * from "./ApproveApprovalsResponseDataAttributesTargetType.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWire.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterparty.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterpartyAccount.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterpartyKind.mjs";
 export * from "./ApproveResult.mjs";
 export * from "./ApproveResultAttrs.mjs";
 export * from "./ApproveResultData.mjs";
@@ -67,6 +72,11 @@ export * from "./DenyApprovalsResponseDataAttributesReasonsItem.mjs";
 export * from "./DenyApprovalsResponseDataAttributesReasonsItemLimitType.mjs";
 export * from "./DenyApprovalsResponseDataAttributesReasonsItemType.mjs";
 export * from "./DenyApprovalsResponseDataAttributesTargetType.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWire.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterparty.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterpartyAccount.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterpartyKind.mjs";
 export * from "./DenyResult.mjs";
 export * from "./DenyResultAttrs.mjs";
 export * from "./DenyResultData.mjs";
@@ -98,6 +108,11 @@ export * from "./GetApprovalsResponseDataAttributesReasonsItem.mjs";
 export * from "./GetApprovalsResponseDataAttributesReasonsItemLimitType.mjs";
 export * from "./GetApprovalsResponseDataAttributesReasonsItemType.mjs";
 export * from "./GetApprovalsResponseDataAttributesTargetType.mjs";
+export * from "./GetApprovalsResponseDataAttributesWire.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterparty.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterpartyAccount.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterpartyKind.mjs";
 export * from "./ListApprovalsRequestStatus.mjs";
 export * from "./ListApprovalsResponseDataItem.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesAch.mjs";
@@ -125,3 +140,8 @@ export * from "./ListApprovalsResponseDataItemAttributesReasonsItem.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesReasonsItemLimitType.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesReasonsItemType.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesTargetType.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWire.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterparty.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterpartyAccount.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterpartyKind.mjs";

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

@@ -36,6 +36,11 @@ export * from "./ApproveApprovalsResponseDataAttributesReasonsItem.mjs";
 export * from "./ApproveApprovalsResponseDataAttributesReasonsItemLimitType.mjs";
 export * from "./ApproveApprovalsResponseDataAttributesReasonsItemType.mjs";
 export * from "./ApproveApprovalsResponseDataAttributesTargetType.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWire.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterparty.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterpartyAccount.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./ApproveApprovalsResponseDataAttributesWireCounterpartyKind.mjs";
 export * from "./ApproveResult.mjs";
 export * from "./ApproveResultAttrs.mjs";
 export * from "./ApproveResultData.mjs";
@@ -67,6 +72,11 @@ export * from "./DenyApprovalsResponseDataAttributesReasonsItem.mjs";
 export * from "./DenyApprovalsResponseDataAttributesReasonsItemLimitType.mjs";
 export * from "./DenyApprovalsResponseDataAttributesReasonsItemType.mjs";
 export * from "./DenyApprovalsResponseDataAttributesTargetType.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWire.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterparty.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterpartyAccount.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./DenyApprovalsResponseDataAttributesWireCounterpartyKind.mjs";
 export * from "./DenyResult.mjs";
 export * from "./DenyResultAttrs.mjs";
 export * from "./DenyResultData.mjs";
@@ -98,6 +108,11 @@ export * from "./GetApprovalsResponseDataAttributesReasonsItem.mjs";
 export * from "./GetApprovalsResponseDataAttributesReasonsItemLimitType.mjs";
 export * from "./GetApprovalsResponseDataAttributesReasonsItemType.mjs";
 export * from "./GetApprovalsResponseDataAttributesTargetType.mjs";
+export * from "./GetApprovalsResponseDataAttributesWire.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterparty.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterpartyAccount.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./GetApprovalsResponseDataAttributesWireCounterpartyKind.mjs";
 export * from "./ListApprovalsRequestStatus.mjs";
 export * from "./ListApprovalsResponseDataItem.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesAch.mjs";
@@ -125,3 +140,8 @@ export * from "./ListApprovalsResponseDataItemAttributesReasonsItem.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesReasonsItemLimitType.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesReasonsItemType.mjs";
 export * from "./ListApprovalsResponseDataItemAttributesTargetType.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWire.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterparty.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterpartyAccount.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterpartyAccountAccountType.mjs";
+export * from "./ListApprovalsResponseDataItemAttributesWireCounterpartyKind.mjs";

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

@@ -43,6 +43,11 @@ export declare const GetEventsResponseDataAttributesEventType: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

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

@@ -44,6 +44,11 @@ export const GetEventsResponseDataAttributesEventType = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

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

@@ -43,6 +43,11 @@ export declare const ListEventsRequestEventType: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

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

@@ -44,6 +44,11 @@ export const ListEventsRequestEventType = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

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

@@ -43,6 +43,11 @@ export declare const ListEventsResponseDataItemAttributesEventType: {
     readonly RealtimeProcessing: "realtime.processing";
     readonly RealtimeSettled: "realtime.settled";
     readonly RealtimeFailed: "realtime.failed";
+    readonly WireCreated: "wire.created";
+    readonly WireProcessing: "wire.processing";
+    readonly WireCompleted: "wire.completed";
+    readonly WireRejected: "wire.rejected";
+    readonly WireFailed: "wire.failed";
     readonly ExternalPartyAccountValidated: "external_party_account.validated";
     readonly ApprovalRequired: "approval.required";
     readonly ApprovalApproved: "approval.approved";

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

@@ -44,6 +44,11 @@ export const ListEventsResponseDataItemAttributesEventType = {
     RealtimeProcessing: "realtime.processing",
     RealtimeSettled: "realtime.settled",
     RealtimeFailed: "realtime.failed",
+    WireCreated: "wire.created",
+    WireProcessing: "wire.processing",
+    WireCompleted: "wire.completed",
+    WireRejected: "wire.rejected",
+    WireFailed: "wire.failed",
     ExternalPartyAccountValidated: "external_party_account.validated",
     ApprovalRequired: "approval.required",
     ApprovalApproved: "approval.approved",

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

@@ -105,4 +105,40 @@ export declare class ExternalPartiesClient {
      */
     get(request: Natural.GetExternalPartiesRequest, requestOptions?: ExternalPartiesClient.RequestOptions): core.HttpResponsePromise<Natural.ExtPartyDetail>;
     private __get;
+    /**
+     * Correct a beneficiary address and synchronize existing bank accounts. Retry the same address after an incomplete synchronization.
+     *
+     * @param {Natural.CorrectAddressExternalPartiesRequest} request
+     * @param {ExternalPartiesClient.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.externalParties.correctAddress({
+     *         externalPartyId: "externalPartyId",
+     *         expectedAddressVersion: 0,
+     *         address: {
+     *             line1: "456 Market St",
+     *             city: "San Francisco",
+     *             state: "CA",
+     *             postalCode: "94105",
+     *             countryCode: "US"
+     *         }
+     *     })
+     */
+    correctAddress(request: Natural.CorrectAddressExternalPartiesRequest, requestOptions?: ExternalPartiesClient.RequestOptions): core.HttpResponsePromise<Natural.CorrectAddressExternalPartiesResponse>;
+    private __correctAddress;
 }

package/dist/esm/api/resources/externalParties/client/Client.mjs

@@ -367,4 +367,113 @@ export class ExternalPartiesClient {
             return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/external-parties/{externalPartyId}");
         });
     }
+    /**
+     * Correct a beneficiary address and synchronize existing bank accounts. Retry the same address after an incomplete synchronization.
+     *
+     * @param {Natural.CorrectAddressExternalPartiesRequest} request
+     * @param {ExternalPartiesClient.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.externalParties.correctAddress({
+     *         externalPartyId: "externalPartyId",
+     *         expectedAddressVersion: 0,
+     *         address: {
+     *             line1: "456 Market St",
+     *             city: "San Francisco",
+     *             state: "CA",
+     *             postalCode: "94105",
+     *             countryCode: "US"
+     *         }
+     *     })
+     */
+    correctAddress(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__correctAddress(request, requestOptions));
+    }
+    __correctAddress(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { externalPartyId } = request, _body = __rest(request, ["externalPartyId"]);
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "X-Instance-ID": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.instanceId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.instanceId }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.NaturalEnvironment.Production, `external-parties/${core.url.encodePathParam(externalPartyId)}/address`),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/json",
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "json",
+                body: mergeAdditionalBodyParameters(serializers.CorrectAddressExternalPartiesRequest.jsonOrThrow(_body, {
+                    unrecognizedObjectKeys: "strip",
+                    omitUndefined: true,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.additionalBodyParameters),
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 60) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.CorrectAddressExternalPartiesResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Natural.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Natural.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Natural.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Natural.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Natural.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Natural.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 428:
+                        throw new Natural.PreconditionError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Natural.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Natural.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Natural.NotImplementedError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new Natural.BadGatewayError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new Natural.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.NaturalError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/external-parties/{externalPartyId}/address");
+        });
+    }
 }

package/dist/esm/api/resources/externalParties/client/requests/CorrectAddressExternalPartiesRequest.d.mts

@@ -0,0 +1,21 @@
+import type * as Natural from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         externalPartyId: "externalPartyId",
+ *         expectedAddressVersion: 0,
+ *         address: {
+ *             line1: "456 Market St",
+ *             city: "San Francisco",
+ *             state: "CA",
+ *             postalCode: "94105",
+ *             countryCode: "US"
+ *         }
+ *     }
+ */
+export interface CorrectAddressExternalPartiesRequest {
+    externalPartyId: string;
+    customerPartyId?: string;
+    expectedAddressVersion: number;
+    address: Natural.CorrectAddressExternalPartiesRequestAddress;
+}

package/dist/esm/api/resources/externalParties/client/requests/CorrectAddressExternalPartiesRequest.mjs

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

package/dist/esm/api/resources/externalParties/client/requests/NewExtPartyParams.d.mts

@@ -29,6 +29,6 @@ export interface NewExtPartyParams {
     email?: string;
     /** External party phone number. It is normalized to E.164. */
     phone?: string;
-    /** External party address. */
+    /** Optional external party address. When supplied, it must be complete and valid. US addresses require state and postalCode. */
     address?: Natural.NewExtPartyParamsAddress;
 }

package/dist/esm/api/resources/externalParties/client/requests/index.d.mts

@@ -1,3 +1,4 @@
+export type { CorrectAddressExternalPartiesRequest } from "./CorrectAddressExternalPartiesRequest.mjs";
 export type { GetExternalPartiesRequest } from "./GetExternalPartiesRequest.mjs";
 export type { ListExternalPartiesRequest } from "./ListExternalPartiesRequest.mjs";
 export type { NewExtPartyParams } from "./NewExtPartyParams.mjs";

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesRequestAddress.d.mts

@@ -0,0 +1,11 @@
+export interface CorrectAddressExternalPartiesRequestAddress {
+    line1: string;
+    line2?: string;
+    city: string;
+    /** State or province. Required for US addresses. */
+    state?: string;
+    /** Postal or ZIP code. Required for US addresses. */
+    postalCode?: string;
+    /** ISO 3166-1 alpha-2 country code. */
+    countryCode: string;
+}

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesRequestAddress.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponse.d.mts

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponse.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseData.d.mts

@@ -0,0 +1,8 @@
+import type * as Natural from "../../../index.mjs";
+export interface CorrectAddressExternalPartiesResponseData {
+    id: string;
+    /** Resource type. */
+    type: Natural.CorrectAddressExternalPartiesResponseDataType;
+    attributes: Natural.CorrectAddressExternalPartiesResponseDataAttributes;
+    relationships: Natural.CorrectAddressExternalPartiesResponseDataRelationships;
+}

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseData.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributes.d.mts

@@ -0,0 +1,23 @@
+import type * as Natural from "../../../index.mjs";
+export interface CorrectAddressExternalPartiesResponseDataAttributes {
+    /** External party type. */
+    kind: Natural.CorrectAddressExternalPartiesResponseDataAttributesKind;
+    /** External party display or legal name. */
+    name: string;
+    /** Normalized email address, if supplied. */
+    email: string | null;
+    /** Normalized E.164 phone number, if supplied. */
+    phone: string | null;
+    /** External party address. */
+    address: Natural.CorrectAddressExternalPartiesResponseDataAttributesAddress | null;
+    /** Address revision for concurrent correction checks. Null on older cached create responses; get the external party before correction. */
+    addressVersion: number | null;
+    /** Sanctions screening disposition. */
+    screeningStatus: Natural.CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus;
+    /** ISO archive timestamp, or null when active. */
+    archivedAt: string | null;
+    /** ISO creation timestamp. */
+    createdAt: string;
+    /** ISO update timestamp. */
+    updatedAt: string;
+}

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributes.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributesAddress.d.mts

@@ -0,0 +1,8 @@
+export interface CorrectAddressExternalPartiesResponseDataAttributesAddress {
+    line1: string | null;
+    line2: string | null;
+    city: string | null;
+    state: string | null;
+    postalCode: string | null;
+    countryCode: string | null;
+}

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributesAddress.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributesKind.d.mts

@@ -0,0 +1,6 @@
+/** External party type. */
+export declare const CorrectAddressExternalPartiesResponseDataAttributesKind: {
+    readonly Individual: "individual";
+    readonly Business: "business";
+};
+export type CorrectAddressExternalPartiesResponseDataAttributesKind = (typeof CorrectAddressExternalPartiesResponseDataAttributesKind)[keyof typeof CorrectAddressExternalPartiesResponseDataAttributesKind];

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributesKind.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** External party type. */
+export const CorrectAddressExternalPartiesResponseDataAttributesKind = {
+    Individual: "individual",
+    Business: "business",
+};

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus.d.mts

@@ -0,0 +1,7 @@
+/** Sanctions screening disposition. */
+export declare const CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus: {
+    readonly Clear: "clear";
+    readonly UnderReview: "under_review";
+    readonly Rejected: "rejected";
+};
+export type CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus = (typeof CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus)[keyof typeof CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus];

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Sanctions screening disposition. */
+export const CorrectAddressExternalPartiesResponseDataAttributesScreeningStatus = {
+    Clear: "clear",
+    UnderReview: "under_review",
+    Rejected: "rejected",
+};

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationships.d.mts

@@ -0,0 +1,5 @@
+import type * as Natural from "../../../index.mjs";
+export interface CorrectAddressExternalPartiesResponseDataRelationships {
+    /** Customer party. */
+    customer: Natural.CorrectAddressExternalPartiesResponseDataRelationshipsCustomer;
+}

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationships.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationshipsCustomer.d.mts

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationshipsCustomer.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationshipsCustomerData.d.mts

@@ -0,0 +1,8 @@
+import type * as Natural from "../../../index.mjs";
+/**
+ * Related resource identifier.
+ */
+export interface CorrectAddressExternalPartiesResponseDataRelationshipsCustomerData {
+    type: Natural.CorrectAddressExternalPartiesResponseDataRelationshipsCustomerDataType;
+    id: string;
+}

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationshipsCustomerData.mjs

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationshipsCustomerDataType.d.mts

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataRelationshipsCustomerDataType.mjs

@@ -0,0 +1,4 @@
+// This file was auto-generated by Fern from our API Definition.
+export const CorrectAddressExternalPartiesResponseDataRelationshipsCustomerDataType = {
+    Party: "party",
+};

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataType.d.mts

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

package/dist/esm/api/resources/externalParties/types/CorrectAddressExternalPartiesResponseDataType.mjs

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

package/dist/esm/api/resources/externalParties/types/ExtPartyAttrs.d.mts

@@ -10,6 +10,8 @@ export interface ExtPartyAttrs {
     phone: string | null;
     /** External party address. */
     address: Natural.ListExternalPartiesResponseDataItemAttributesAddress | null;
+    /** Address revision for concurrent correction checks. Null on older cached create responses; get the external party before correction. */
+    addressVersion: number | null;
     /** Sanctions screening disposition. */
     screeningStatus: Natural.ExtPartyScreeningStatus;
     /** ISO archive timestamp, or null when active. */