@shipengine/js-api 4.6.1 → 4.7.0

package/auctane-pay/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { ConfigResponse, CreateSessionRequest, CreateSessionResponse } from "./types";
+import { ConfigResponse, CreateSessionRequest, CreateSessionResponse, PreviewTransactionRequest, PreviewTransactionResponse } from "./types";
 /**
  * # Auctane Pay API module - /v1/payments
  *
@@ -21,4 +21,11 @@ export declare class AuctanePayAPI {
      * @returns a promise that returns the AuctanePay config
      */
     getConfig: () => Promise<import("axios").AxiosResponse<ConfigResponse, any>>;
+    /**
+     * The `previewTransaction` method previews transaction costs including fees and surcharges
+     * @docs https://auctane-pay-dev.kubedev.sslocal.com/swagger/index.html#tag/Transactions
+     * @param request - The request object containing amount and transaction category
+     * @returns a promise that resolves to the transaction preview with fees
+     */
+    previewTransaction: (request: PreviewTransactionRequest) => Promise<import("axios").AxiosResponse<PreviewTransactionResponse, any>>;
 }

package/auctane-pay/types.d.ts

@@ -1,13 +1,19 @@
 /**
  * @category Entities
- * Auctane Pay Session can return a lot of metadata, but will always returns the same 5 keys.
+ * Auctane Pay Session can return a lot of metadata,
+ * but will always returns the same 5 keys.
  */
 export interface AuctanePaySessionMetadata {
     [key: string]: string;
+    /** Adyen client key */
     adyenClientKey: string;
+    /** Adyen expiration */
     adyenExpiration: string;
+    /** Adyen session data */
     adyenSessionData: string;
+    /** Adyen session ID */
     adyenSessionId: string;
+    /** Client key */
     clientKey: string;
 }
 /**
@@ -39,9 +45,7 @@ export interface CreateSessionRequest {
  * @category Entities
  */
 export interface PaymentMethodHolderAddress {
-    /**
-     * Account holder address
-     */
+    /** Account holder address */
     accountHolderAddress: {
         addressLine1: string;
         addressLine2: string | null;
@@ -50,55 +54,44 @@ export interface PaymentMethodHolderAddress {
         postalCode: string;
         stateProvince: string;
     } | null;
-    /**
-     * Account holder name
-     */
+    /** Account holder name */
     accountHolderName: string | null;
-    /**
-     * The last four of the account number, this is only provided for bank accounts and card schemes.
+    /** The last four of the account number, this is only
+     * provided for bank accounts and card schemes.
      */
     accountNumberLastFour: string;
-    /**
-     * An account number preview, for a CC this is the last 4 digits, but shown like 1234.
+    /** An account number preview, for a CC this is the last 4 digits, but shown like 1234.
      * For an e-mail account it might be ay@auctane.com, etc.
      */
     accountNumberPreview: string;
-    /**
-     * If applicable/available, the current expiration we have on file for the payment method.
+    /** If applicable/available, the current expiration
+     * we have on file for the payment method.
      */
     assignedPreferences: AuctanePayTransactionCategory[];
-    /**
-     * Date the payment method was last used. If the date it was last used is unavailable,
+    /** Date the payment method was last used.
+     * If the date it was last used is unavailable,
      * this will be the date created/updated.
      */
     dateLastUsed: string;
-    /**
-     * List of processes or payment gateways in which this Payment Method is registered
+    /** List of processes or payment gateways
+     * in which this Payment Method is registered
      */
     enrolledProcessors: string[];
-    /**
-     * If applicable/available, the current expiration we have on file for the payment method.
+    /** If applicable/available, the current expiration
+     * we have on file for the payment method.
      */
     expiration: string;
-    /**
-     * The Payment Method ID
-     */
+    /** The Payment Method ID */
     id: string;
-    /**
-     * The nickname of the payment method
-     */
+    /** The nickname of the payment method */
     nickname: string;
-    /**
-     * Enumeration of supported payment methods.
-     */
+    /** Enumeration of supported payment methods. */
     paymentMethod: "unknown" | "visa" | "mastercard" | "amex" | "discover" | "maestro" | "dinersclub" | "ach" | "jcb" | "pulse" | "star" | "unionpay";
-    /**
-     * The Display Name to show in any text based UI/context for the Logo.
+    /** The Display Name to show in any text
+     * based UI/context for the Logo.
      */
     paymentMethodDisplayName: string;
-    /**
-     * Source account ID
-     */
+    /** Source account ID */
     sourceAccountId: string;
 }
 /**
@@ -111,33 +104,71 @@ export interface ConfigResponse {
  * @category Entities
  */
 export interface CreateSessionResponse {
-    /**
-     * Active payment methods
-     */
+    /** Active payment methods */
     activePaymentMethods: PaymentMethodHolderAddress[];
-    /**
-     * Client key
-     */
+    /** Client key */
     clientKey: string;
-    /**
-     * Eligible payment method types
-     */
+    /** Eligible payment method types */
     eligiblePaymentMethodTypes: AuctanePayPaymentMethod[];
-    /**
-     * The Auctane Pay Internal Session ID, use this ID to request the result of this session
+    /** The Auctane Pay Internal Session ID,
+     * use this ID to request the result of this session
      * and payment methods created from it.
      */
     id: string;
-    /**
-     * Metadata
-     */
+    /** Metadata */
     metadata: AuctanePaySessionMetadata;
-    /**
-     * Recent payment methods
-     */
+    /** Recent payment methods */
     recentPaymentMethods: PaymentMethodHolderAddress[];
     /** @deprecated */
     sessionData: string;
     /** @deprecated */
     sessionId: string;
 }
+/**
+ * @category Entities
+ * Request body for preview transaction endpoint
+ */
+export interface PreviewTransactionRequest {
+    /** Transaction amount */
+    amount: number;
+    /** Category of the transaction */
+    transactionCategory: AuctanePayTransactionCategory;
+}
+/**
+ * @category Entities
+ * Money amount with currency
+ */
+export interface MoneyAmount {
+    /** Amount value */
+    amount: number;
+    /** Currency code */
+    currencyCode: string;
+}
+/**
+ * @category Entities
+ * Fee information for a transaction
+ */
+export interface TransactionFee {
+    /** Fee amount */
+    amount: number;
+    /** Fee percentage */
+    percentage: number;
+    /** Fee type */
+    type: string;
+}
+/**
+ * @category Entities
+ * Response from preview transaction endpoint
+ */
+export interface PreviewTransactionResponse {
+    /** Total transaction amount */
+    amount: MoneyAmount;
+    /** Base amount before fees */
+    baseAmount: MoneyAmount;
+    /** Array of fee details */
+    fees: TransactionFee[];
+    /** Total transaction fee */
+    totalTransactionFee: MoneyAmount;
+    /** Transaction currency code */
+    transactionCurrencyCode: string;
+}

package/index.js

@@ -260,6 +260,18 @@ class AuctanePayAPI {
     this.getConfig = () => {
       return this.client.get("/v1/payments/config");
     };
+    /**
+     * The `previewTransaction` method previews transaction costs including fees and surcharges
+     * @docs https://auctane-pay-dev.kubedev.sslocal.com/swagger/index.html#tag/Transactions
+     * @param request - The request object containing amount and transaction category
+     * @returns a promise that resolves to the transaction preview with fees
+     */
+    this.previewTransaction = (request) => {
+      return this.client.post(
+        "/v1/payments/transaction/preview",
+        request
+      );
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -256,6 +256,18 @@ class AuctanePayAPI {
     this.getConfig = () => {
       return this.client.get("/v1/payments/config");
     };
+    /**
+     * The `previewTransaction` method previews transaction costs including fees and surcharges
+     * @docs https://auctane-pay-dev.kubedev.sslocal.com/swagger/index.html#tag/Transactions
+     * @param request - The request object containing amount and transaction category
+     * @returns a promise that resolves to the transaction preview with fees
+     */
+    this.previewTransaction = (request) => {
+      return this.client.post(
+        "/v1/payments/transaction/preview",
+        request
+      );
+    };
     this.client = client;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {