@naturalpay/sdk 1.6.45 → 1.6.47

package/dist/esm/api/resources/merchantReports/types/CreateMerchantReportsResponseDataOutcome.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** What stopped the payment. host_not_allowed: the card request went to a host you couldn't put in allowedHosts. proxy_error: the proxy answered an error (put its code in proxyErrorCode). card_refused: the merchant or processor refused the card. three_ds_required: a 3DS challenge you couldn't complete. bot_wall: a CAPTCHA or bot check kept you from the card form. other: anything else; say what in notes. */
+export const CreateMerchantReportsResponseDataOutcome = {
+    HostNotAllowed: "host_not_allowed",
+    ProxyError: "proxy_error",
+    CardRefused: "card_refused",
+    ThreeDsRequired: "three_ds_required",
+    BotWall: "bot_wall",
+    Other: "other",
+};

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

@@ -0,0 +1,5 @@
+export * from "./CreateMerchantReportsRequestCheckout.mjs";
+export * from "./CreateMerchantReportsRequestOutcome.mjs";
+export * from "./CreateMerchantReportsResponse.mjs";
+export * from "./CreateMerchantReportsResponseData.mjs";
+export * from "./CreateMerchantReportsResponseDataOutcome.mjs";

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

@@ -0,0 +1,5 @@
+export * from "./CreateMerchantReportsRequestCheckout.mjs";
+export * from "./CreateMerchantReportsRequestOutcome.mjs";
+export * from "./CreateMerchantReportsResponse.mjs";
+export * from "./CreateMerchantReportsResponseData.mjs";
+export * from "./CreateMerchantReportsResponseDataOutcome.mjs";

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

@@ -105,7 +105,7 @@ export declare class PaymentsClient {
     get(request: Natural.GetPaymentsRequest, requestOptions?: PaymentsClient.RequestOptions): core.HttpResponsePromise<Natural.PaymentDetail>;
     private __get;
     /**
-     * Cancel a payment before the recipient begins claiming it
+     * Cancel a pending payment claim before the recipient claims it
      *
      * @param {Natural.CancelPaymentsRequest} request
      * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -367,7 +367,7 @@ export class PaymentsClient {
         });
     }
     /**
-     * Cancel a payment before the recipient begins claiming it
+     * Cancel a pending payment claim before the recipient claims it
      *
      * @param {Natural.CancelPaymentsRequest} request
      * @param {PaymentsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/esm/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.d.mts

@@ -1,6 +1,7 @@
 import type * as Natural from "../../../../api/index.mjs";
 import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
+import { ListCardsExternalAccountsResponseDataItemAttributesBillingAddress } from "./ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.mjs";
 import { ListCardsExternalAccountsResponseDataItemAttributesBrand } from "./ListCardsExternalAccountsResponseDataItemAttributesBrand.mjs";
 import { ListCardsExternalAccountsResponseDataItemAttributesStatus } from "./ListCardsExternalAccountsResponseDataItemAttributesStatus.mjs";
 export declare const ListCardsExternalAccountsResponseDataItemAttributes: core.serialization.ObjectSchema<serializers.ListCardsExternalAccountsResponseDataItemAttributes.Raw, Natural.ListCardsExternalAccountsResponseDataItemAttributes>;
@@ -8,6 +9,7 @@ export declare namespace ListCardsExternalAccountsResponseDataItemAttributes {
     interface Raw {
         brand: ListCardsExternalAccountsResponseDataItemAttributesBrand.Raw;
         lastFour: string;
+        billingAddress?: ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.Raw | null;
         status: ListCardsExternalAccountsResponseDataItemAttributesStatus.Raw;
         createdAt: string;
     }

package/dist/esm/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributes.mjs

@@ -1,10 +1,12 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
+import { ListCardsExternalAccountsResponseDataItemAttributesBillingAddress } from "./ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.mjs";
 import { ListCardsExternalAccountsResponseDataItemAttributesBrand } from "./ListCardsExternalAccountsResponseDataItemAttributesBrand.mjs";
 import { ListCardsExternalAccountsResponseDataItemAttributesStatus } from "./ListCardsExternalAccountsResponseDataItemAttributesStatus.mjs";
 export const ListCardsExternalAccountsResponseDataItemAttributes = core.serialization.object({
     brand: ListCardsExternalAccountsResponseDataItemAttributesBrand,
     lastFour: core.serialization.string(),
+    billingAddress: ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.nullable(),
     status: ListCardsExternalAccountsResponseDataItemAttributesStatus,
     createdAt: core.serialization.date(),
 });

package/dist/esm/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.d.mts

@@ -0,0 +1,14 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const ListCardsExternalAccountsResponseDataItemAttributesBillingAddress: core.serialization.ObjectSchema<serializers.ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.Raw, Natural.ListCardsExternalAccountsResponseDataItemAttributesBillingAddress>;
+export declare namespace ListCardsExternalAccountsResponseDataItemAttributesBillingAddress {
+    interface Raw {
+        line1?: string | null;
+        line2?: string | null;
+        city?: string | null;
+        state?: string | null;
+        postalCode?: string | null;
+        country?: string | null;
+    }
+}

package/dist/esm/serialization/resources/externalAccounts/types/ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const ListCardsExternalAccountsResponseDataItemAttributesBillingAddress = core.serialization.object({
+    line1: core.serialization.string().nullable(),
+    line2: core.serialization.string().nullable(),
+    city: core.serialization.string().nullable(),
+    state: core.serialization.string().nullable(),
+    postalCode: core.serialization.string().nullable(),
+    country: core.serialization.string().nullable(),
+});

package/dist/esm/serialization/resources/externalAccounts/types/index.d.mts

@@ -49,6 +49,7 @@ export * from "./GetExternalAccountsResponseDataType.mjs";
 export * from "./ListCardsExternalAccountsResponse.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItem.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemAttributes.mjs";
+export * from "./ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemAttributesBrand.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemAttributesStatus.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemRelationships.mjs";

package/dist/esm/serialization/resources/externalAccounts/types/index.mjs

@@ -49,6 +49,7 @@ export * from "./GetExternalAccountsResponseDataType.mjs";
 export * from "./ListCardsExternalAccountsResponse.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItem.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemAttributes.mjs";
+export * from "./ListCardsExternalAccountsResponseDataItemAttributesBillingAddress.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemAttributesBrand.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemAttributesStatus.mjs";
 export * from "./ListCardsExternalAccountsResponseDataItemRelationships.mjs";

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

@@ -47,6 +47,9 @@ export * from "./invitationLinks/types/index.mjs";
 export * from "./invitations/client/requests/index.mjs";
 export * as invitations from "./invitations/index.mjs";
 export * from "./invitations/types/index.mjs";
+export * from "./merchantReports/client/requests/index.mjs";
+export * as merchantReports from "./merchantReports/index.mjs";
+export * from "./merchantReports/types/index.mjs";
 export * from "./parties/client/requests/index.mjs";
 export * as parties from "./parties/index.mjs";
 export * from "./parties/types/index.mjs";

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

@@ -47,6 +47,9 @@ export * from "./invitationLinks/types/index.mjs";
 export * from "./invitations/client/requests/index.mjs";
 export * as invitations from "./invitations/index.mjs";
 export * from "./invitations/types/index.mjs";
+export * from "./merchantReports/client/requests/index.mjs";
+export * as merchantReports from "./merchantReports/index.mjs";
+export * from "./merchantReports/types/index.mjs";
 export * from "./parties/client/requests/index.mjs";
 export * as parties from "./parties/index.mjs";
 export * from "./parties/types/index.mjs";

package/dist/esm/serialization/resources/merchantReports/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/serialization/resources/merchantReports/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/serialization/resources/merchantReports/client/requests/CreateMerchantReportsRequest.d.mts

@@ -0,0 +1,17 @@
+import type * as Natural from "../../../../../api/index.mjs";
+import * as core from "../../../../../core/index.mjs";
+import type * as serializers from "../../../../index.mjs";
+import { CreateMerchantReportsRequestCheckout } from "../../types/CreateMerchantReportsRequestCheckout.mjs";
+import { CreateMerchantReportsRequestOutcome } from "../../types/CreateMerchantReportsRequestOutcome.mjs";
+export declare const CreateMerchantReportsRequest: core.serialization.Schema<serializers.CreateMerchantReportsRequest.Raw, Natural.CreateMerchantReportsRequest>;
+export declare namespace CreateMerchantReportsRequest {
+    interface Raw {
+        merchantUrl: string;
+        outcome: CreateMerchantReportsRequestOutcome.Raw;
+        cardSessionId?: string | null;
+        proxyErrorCode?: string | null;
+        checkout?: CreateMerchantReportsRequestCheckout.Raw | null;
+        notes?: string | null;
+        customerPartyId?: string | null;
+    }
+}

package/dist/esm/serialization/resources/merchantReports/client/requests/CreateMerchantReportsRequest.mjs

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../../core/index.mjs";
+import { CreateMerchantReportsRequestCheckout } from "../../types/CreateMerchantReportsRequestCheckout.mjs";
+import { CreateMerchantReportsRequestOutcome } from "../../types/CreateMerchantReportsRequestOutcome.mjs";
+export const CreateMerchantReportsRequest = core.serialization.object({
+    merchantUrl: core.serialization.string(),
+    outcome: CreateMerchantReportsRequestOutcome,
+    cardSessionId: core.serialization.string().optional(),
+    proxyErrorCode: core.serialization.string().optional(),
+    checkout: CreateMerchantReportsRequestCheckout.optional(),
+    notes: core.serialization.string().optional(),
+    customerPartyId: core.serialization.string().optional(),
+});

package/dist/esm/serialization/resources/merchantReports/client/requests/index.d.mts

@@ -0,0 +1 @@
+export { CreateMerchantReportsRequest } from "./CreateMerchantReportsRequest.mjs";

package/dist/esm/serialization/resources/merchantReports/client/requests/index.mjs

@@ -0,0 +1 @@
+export { CreateMerchantReportsRequest } from "./CreateMerchantReportsRequest.mjs";

package/dist/esm/serialization/resources/merchantReports/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/serialization/resources/merchantReports/index.mjs

@@ -0,0 +1,2 @@
+export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsRequestCheckout.d.mts

@@ -0,0 +1,15 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const CreateMerchantReportsRequestCheckout: core.serialization.ObjectSchema<serializers.CreateMerchantReportsRequestCheckout.Raw, Natural.CreateMerchantReportsRequestCheckout>;
+export declare namespace CreateMerchantReportsRequestCheckout {
+    interface Raw {
+        cardFieldOrigin?: string | null;
+        processorSdkUrl?: string | null;
+        processorSdkVersion?: string | null;
+        submitUrl?: string | null;
+        submitContentType?: string | null;
+        cardFieldNames?: string[] | null;
+        errorText?: string | null;
+    }
+}

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsRequestCheckout.mjs

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const CreateMerchantReportsRequestCheckout = core.serialization.object({
+    cardFieldOrigin: core.serialization.string().optional(),
+    processorSdkUrl: core.serialization.string().optional(),
+    processorSdkVersion: core.serialization.string().optional(),
+    submitUrl: core.serialization.string().optional(),
+    submitContentType: core.serialization.string().optional(),
+    cardFieldNames: core.serialization.list(core.serialization.string()).optional(),
+    errorText: core.serialization.string().optional(),
+});

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsRequestOutcome.d.mts

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const CreateMerchantReportsRequestOutcome: core.serialization.Schema<serializers.CreateMerchantReportsRequestOutcome.Raw, Natural.CreateMerchantReportsRequestOutcome>;
+export declare namespace CreateMerchantReportsRequestOutcome {
+    type Raw = "host_not_allowed" | "proxy_error" | "card_refused" | "three_ds_required" | "bot_wall" | "other";
+}

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsRequestOutcome.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const CreateMerchantReportsRequestOutcome = core.serialization.enum_([
+    "host_not_allowed",
+    "proxy_error",
+    "card_refused",
+    "three_ds_required",
+    "bot_wall",
+    "other",
+]);

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsResponse.d.mts

@@ -0,0 +1,10 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+import { CreateMerchantReportsResponseData } from "./CreateMerchantReportsResponseData.mjs";
+export declare const CreateMerchantReportsResponse: core.serialization.ObjectSchema<serializers.CreateMerchantReportsResponse.Raw, Natural.CreateMerchantReportsResponse>;
+export declare namespace CreateMerchantReportsResponse {
+    interface Raw {
+        data: CreateMerchantReportsResponseData.Raw;
+    }
+}

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsResponse.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+import { CreateMerchantReportsResponseData } from "./CreateMerchantReportsResponseData.mjs";
+export const CreateMerchantReportsResponse = core.serialization.object({
+    data: CreateMerchantReportsResponseData,
+});

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsResponseData.d.mts

@@ -0,0 +1,13 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+import { CreateMerchantReportsResponseDataOutcome } from "./CreateMerchantReportsResponseDataOutcome.mjs";
+export declare const CreateMerchantReportsResponseData: core.serialization.ObjectSchema<serializers.CreateMerchantReportsResponseData.Raw, Natural.CreateMerchantReportsResponseData>;
+export declare namespace CreateMerchantReportsResponseData {
+    interface Raw {
+        reportId: string;
+        merchantHost: string;
+        outcome: CreateMerchantReportsResponseDataOutcome.Raw;
+        createdAt: string;
+    }
+}

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsResponseData.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+import { CreateMerchantReportsResponseDataOutcome } from "./CreateMerchantReportsResponseDataOutcome.mjs";
+export const CreateMerchantReportsResponseData = core.serialization.object({
+    reportId: core.serialization.string(),
+    merchantHost: core.serialization.string(),
+    outcome: CreateMerchantReportsResponseDataOutcome,
+    createdAt: core.serialization.string(),
+});

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsResponseDataOutcome.d.mts

@@ -0,0 +1,7 @@
+import type * as Natural from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const CreateMerchantReportsResponseDataOutcome: core.serialization.Schema<serializers.CreateMerchantReportsResponseDataOutcome.Raw, Natural.CreateMerchantReportsResponseDataOutcome>;
+export declare namespace CreateMerchantReportsResponseDataOutcome {
+    type Raw = "host_not_allowed" | "proxy_error" | "card_refused" | "three_ds_required" | "bot_wall" | "other";
+}

package/dist/esm/serialization/resources/merchantReports/types/CreateMerchantReportsResponseDataOutcome.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const CreateMerchantReportsResponseDataOutcome = core.serialization.enum_([
+    "host_not_allowed",
+    "proxy_error",
+    "card_refused",
+    "three_ds_required",
+    "bot_wall",
+    "other",
+]);

package/dist/esm/serialization/resources/merchantReports/types/index.d.mts

@@ -0,0 +1,5 @@
+export * from "./CreateMerchantReportsRequestCheckout.mjs";
+export * from "./CreateMerchantReportsRequestOutcome.mjs";
+export * from "./CreateMerchantReportsResponse.mjs";
+export * from "./CreateMerchantReportsResponseData.mjs";
+export * from "./CreateMerchantReportsResponseDataOutcome.mjs";

package/dist/esm/serialization/resources/merchantReports/types/index.mjs

@@ -0,0 +1,5 @@
+export * from "./CreateMerchantReportsRequestCheckout.mjs";
+export * from "./CreateMerchantReportsRequestOutcome.mjs";
+export * from "./CreateMerchantReportsResponse.mjs";
+export * from "./CreateMerchantReportsResponseData.mjs";
+export * from "./CreateMerchantReportsResponseDataOutcome.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.6.45";
+export declare const SDK_VERSION = "1.6.47";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.6.45";
+export const SDK_VERSION = "1.6.47";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@naturalpay/sdk",
-    "version": "1.6.45",
+    "version": "1.6.47",
     "private": false,
     "repository": {
         "type": "git",
@@ -319,6 +319,17 @@
             },
             "default": "./dist/cjs/api/resources/cardSessions/exports.js"
         },
+        "./merchantReports": {
+            "import": {
+                "types": "./dist/esm/api/resources/merchantReports/exports.d.mts",
+                "default": "./dist/esm/api/resources/merchantReports/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/merchantReports/exports.d.ts",
+                "default": "./dist/cjs/api/resources/merchantReports/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/merchantReports/exports.js"
+        },
         "./agenticPayments": {
             "import": {
                 "types": "./dist/esm/api/resources/agenticPayments/exports.d.mts",

package/reference.md

@@ -1662,7 +1662,7 @@ await client.payments.get({
 <dl>
 <dd>
 
-Cancel a payment before the recipient begins claiming it
+Cancel a pending payment claim before the recipient claims it
 </dd>
 </dl>
 </dd>
@@ -8984,6 +8984,85 @@ await client.cardSessions.claim({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Merchant Reports
+<details><summary><code>client.merchantReports.<a href="/src/api/resources/merchantReports/client/Client.ts">create</a>({ ...params }) -> Natural.CreateMerchantReportsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Report a merchant checkout you couldn't pay with a browser token. Natural uses the details to add support for the merchant or its processor.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.merchantReports.create({
+    merchantUrl: "https://www.example-air.com/booking/payment",
+    outcome: "proxy_error",
+    cardSessionId: "csn_01a0e6466ba3713bba0f0d9d36803b92",
+    proxyErrorCode: "card_proxy_adyen_checkout_unknown",
+    checkout: {
+        cardFieldOrigin: "https://checkoutshopper-live.adyen.com",
+        processorSdkUrl: "https://checkoutshopper-live.cdn.adyen.com/checkoutshopper/sdk/6.35.0/adyen.js",
+        processorSdkVersion: "6.35.0",
+        submitUrl: "POST https://www.example-air.com/payments/v2/create_payment",
+        submitContentType: "application/json",
+        cardFieldNames: ["payment_method.encryptedCardNumber", "payment_method.encryptedSecurityCode"],
+        errorText: "Your payment has been refused. Please try again with a different payment method."
+    },
+    notes: "Card fields were on screen before the claim; the first Pay was refused, a reload fixed it."
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Natural.CreateMerchantReportsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MerchantReportsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>