@shipengine/js-api 4.9.0 → 4.11.0

package/auctane-pay/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { ConfigResponse, CreateSessionRequest, CreateSessionResponse, PreviewTransactionRequest, PreviewTransactionResponse } from "./types";
+import { ConfigResponse, CreateSessionRequest, CreateSessionResponse, PaymentMethodsResponse, PreviewTransactionRequest, PreviewTransactionResponse } from "./types";
 /**
  * # Auctane Pay API module - /v1/payments
  *
@@ -28,4 +28,9 @@ export declare class AuctanePayAPI {
      * @returns a promise that resolves to the transaction preview with fees
      */
     previewTransaction: (request: PreviewTransactionRequest) => Promise<import("axios").AxiosResponse<PreviewTransactionResponse, any>>;
+    /**
+     * The `getPaymentMethods` method retrieve the list of Payment Methods for a given user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Get-payment-methods
+     */
+    getPaymentMethods: () => Promise<import("axios").AxiosResponse<PaymentMethodsResponse, any>>;
 }

package/auctane-pay/types.d.ts

@@ -51,7 +51,7 @@ export interface CreateSessionRequest {
 /**
  * @category Entities
  */
-export interface PaymentMethodHolderAddress {
+export interface PaymentMethod {
     /** Account holder address */
     accountHolderAddress: {
         addressLine1: string;
@@ -63,28 +63,34 @@ export interface PaymentMethodHolderAddress {
     } | null;
     /** Account holder name */
     accountHolderName: string | null;
-    /** The last four of the account number, this is only
+    /**
+     * 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
+    /**
+     * If applicable/available, the current expiration
      * we have on file for the payment method.
      */
     assignedPreferences: AuctanePayTransactionCategory[];
-    /** Date the payment method was last used.
+    /**
+     * 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
+    /**
+     * List of processes or payment gateways
      * in which this Payment Method is registered
      */
     enrolledProcessors: string[];
-    /** If applicable/available, the current expiration
+    /**
+     * If applicable/available, the current expiration
      * we have on file for the payment method.
      */
     expiration: string;
@@ -92,14 +98,19 @@ export interface PaymentMethodHolderAddress {
     fees: PaymentMethodDetailFee[];
     /** The Payment Method ID */
     id: string;
+    /** Usually the Bank name */
+    institutionName: string | null;
     /** The nickname of the payment method */
     nickname: string;
     /** 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
+    /**
+     * The Display Name to show in any text
      * based UI/context for the Logo.
      */
     paymentMethodDisplayName: string;
+    /** Payment method type */
+    paymentMethodType: AuctanePayPaymentMethod;
     /** Source account ID */
     sourceAccountId: string;
 }
@@ -114,12 +125,13 @@ export interface ConfigResponse {
  */
 export interface CreateSessionResponse {
     /** Active payment methods */
-    activePaymentMethods: PaymentMethodHolderAddress[];
+    activePaymentMethods: PaymentMethod[];
     /** Client key */
     clientKey: string;
     /** Eligible payment method types */
     eligiblePaymentMethodTypes: AuctanePayPaymentMethod[];
-    /** The Auctane Pay Internal Session ID,
+    /**
+     * The Auctane Pay Internal Session ID,
      * use this ID to request the result of this session
      * and payment methods created from it.
      */
@@ -129,7 +141,7 @@ export interface CreateSessionResponse {
     /** Payment Method Meta Type Details */
     paymentMethodMetaTypeDetails: Record<keyof AuctanePayPaymentMethod, AuctanePayPaymentMethodDetails> | null;
     /** Recent payment methods */
-    recentPaymentMethods: PaymentMethodHolderAddress[];
+    recentPaymentMethods: PaymentMethod[];
     /** @deprecated */
     sessionData: string;
     /** @deprecated */
@@ -137,6 +149,13 @@ export interface CreateSessionResponse {
     /** Category of the transaction */
     transactionCategory: AuctanePayTransactionCategory;
 }
+/**
+ * @category Entities
+ */
+export interface PaymentMethodsResponse {
+    activePaymentMethods: Array<PaymentMethod>;
+    recentPaymentMethods: Array<PaymentMethod>;
+}
 /**
  * @category Entities
  * Request body for preview transaction endpoint

package/index.js

@@ -272,6 +272,13 @@ class AuctanePayAPI {
         request
       );
     };
+    /**
+     * The `getPaymentMethods` method retrieve the list of Payment Methods for a given user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Get-payment-methods
+     */
+    this.getPaymentMethods = () => {
+      return this.client.get("/v1/payments/payment_methods");
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -268,6 +268,13 @@ class AuctanePayAPI {
         request
       );
     };
+    /**
+     * The `getPaymentMethods` method retrieve the list of Payment Methods for a given user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Get-payment-methods
+     */
+    this.getPaymentMethods = () => {
+      return this.client.get("/v1/payments/payment_methods");
+    };
     this.client = client;
   }
 }

package/package.json

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

package/shipping-rules/types.d.ts

@@ -4,7 +4,7 @@ import { WeightUnit } from "../weight";
 /**
  * @category Entities
  */
-export type RuleIdentifier = "MAX_DIMENSION" | "NUMBER_OF_PACKAGES" | "SHIP_FROM_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_FROM_COUNTRY_CODE" | "SHIP_TO_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_TO_COUNTRY_CODE" | "SHIP_TO_POSTAL_CODE" | "SHIP_FROM_POSTAL_CODE" | "SHIPMENT_VALUE" | "WAREHOUSE_ID" | "WEIGHT";
+export type RuleIdentifier = "MAX_DIMENSION" | "NUMBER_OF_PACKAGES" | "SHIP_FROM_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_FROM_COUNTRY_CODE" | "SHIP_TO_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_TO_COUNTRY_CODE" | "SHIP_TO_POSTAL_CODE" | "SHIP_FROM_POSTAL_CODE" | "SHIPMENT_VALUE" | "WAREHOUSE_ID" | "WEIGHT" | "LENGTH" | "WIDTH" | "HEIGHT" | "CUSTOM_FIELD1" | "CUSTOM_FIELD2" | "CUSTOM_FIELD3";
 /**
  * @category Entities
  */