@shipengine/js-api 4.11.1 → 4.13.0

package/auctane-pay/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { ConfigResponse, CreateSessionRequest, CreateSessionResponse, PaymentMethodsResponse, PreviewTransactionRequest, PreviewTransactionResponse } from "./types";
+import { ConfigResponse, CreateSessionRequest, CreateSessionResponse, PaymentMethodsResponse, PreviewTransactionRequest, PreviewTransactionResponse, UpdatePaymentMethodRequest, UpdatePaymentMethodResponse } from "./types";
 /**
  * # Auctane Pay API module - /v1/payments
  *
@@ -33,4 +33,14 @@ export declare class AuctanePayAPI {
      * @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>>;
+    /**
+     * The `deletePaymentMethod` method deletes a Payment Method for a given user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Delete-payment-method
+     */
+    deletePaymentMethod: (paymentMethodId: string) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `updatePaymentMethod` method allows to update a saved Payment Method
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Auctane-Pay-available-endpoints-in-Shipstation-API
+     */
+    updatePaymentMethod: (paymentMethodId: string, payload: UpdatePaymentMethodRequest) => Promise<import("axios").AxiosResponse<UpdatePaymentMethodResponse, any>>;
 }

package/auctane-pay/types.d.ts

@@ -21,6 +21,11 @@ export interface AuctanePaySessionMetadata {
  * Allowed Payment Method for AuctanePay
  */
 export type AuctanePayPaymentMethod = "credit_card" | "pay_pal" | "stamps" | "pay_by_bank_us" | "pay_by_bank_eu";
+/**
+ * @category Entities
+ * List of possible Payment Method types
+ */
+export type PaymentMethodType = "unknown" | "visa" | "mastercard" | "amex" | "discover" | "maestro" | "dinersclub" | "ach" | "jcb" | "pulse" | "star" | "unionpay";
 /**
  * @category Entities
  * Payment Method Details for AuctanePay
@@ -48,6 +53,25 @@ export interface CreateSessionRequest {
      */
     returnUrl?: string;
 }
+export interface UpdatePaymentMethodRequest {
+    /** Billing Address associated with the Payment Method */
+    billingAddress: {
+        addressLine1: string;
+        addressLine2: string;
+        cityLocality: string;
+        countryCode: string;
+        postalCode: string;
+        stateProvince: string;
+    };
+    /** Transaction categories for this Payment Method */
+    defaultPaymentMethodCategories: AuctanePayTransactionCategory[];
+    /** Expiration Date for the Payment Method (Format: MM/YYYY) */
+    expirationDate: string;
+    /** Holder name for the payment method */
+    holderName: string;
+    /** Nickname used for this Payment Method */
+    nickname: string;
+}
 /**
  * @category Entities
  */
@@ -87,8 +111,9 @@ export interface PaymentMethod {
     /**
      * List of processes or payment gateways
      * in which this Payment Method is registered
+     * Some endpoints, like GET Payment Methods does not return this value
      */
-    enrolledProcessors: string[];
+    enrolledProcessors?: string[];
     /**
      * If applicable/available, the current expiration
      * we have on file for the payment method.
@@ -103,7 +128,7 @@ export interface PaymentMethod {
     /** 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";
+    paymentMethod: PaymentMethodType;
     /**
      * The Display Name to show in any text
      * based UI/context for the Logo.
@@ -114,6 +139,11 @@ export interface PaymentMethod {
     /** Source account ID */
     sourceAccountId: string;
 }
+/**
+ * @category Entities
+ * The PaymentMethod from the Update response
+ */
+export type UpdatePaymentMethodResponse = Omit<PaymentMethod, "sourceAccountId" | "paymentMethodType" | "institutionName">;
 /**
  * @category Entities
  */

package/index.js

@@ -279,6 +279,23 @@ class AuctanePayAPI {
     this.getPaymentMethods = () => {
       return this.client.get("/v1/payments/payment_methods");
     };
+    /**
+     * The `deletePaymentMethod` method deletes a Payment Method for a given user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Delete-payment-method
+     */
+    this.deletePaymentMethod = (paymentMethodId) => {
+      return this.client.delete(`/v1/payments/payment_methods/${paymentMethodId}`);
+    };
+    /**
+     * The `updatePaymentMethod` method allows to update a saved Payment Method
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Auctane-Pay-available-endpoints-in-Shipstation-API
+     */
+    this.updatePaymentMethod = (paymentMethodId, payload) => {
+      return this.client.put(
+        `/v1/payments/payment_methods/${paymentMethodId}`,
+        payload
+      );
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -275,6 +275,23 @@ class AuctanePayAPI {
     this.getPaymentMethods = () => {
       return this.client.get("/v1/payments/payment_methods");
     };
+    /**
+     * The `deletePaymentMethod` method deletes a Payment Method for a given user.
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Delete-payment-method
+     */
+    this.deletePaymentMethod = (paymentMethodId) => {
+      return this.client.delete(`/v1/payments/payment_methods/${paymentMethodId}`);
+    };
+    /**
+     * The `updatePaymentMethod` method allows to update a saved Payment Method
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Auctane-Pay-available-endpoints-in-Shipstation-API
+     */
+    this.updatePaymentMethod = (paymentMethodId, payload) => {
+      return this.client.put(
+        `/v1/payments/payment_methods/${paymentMethodId}`,
+        payload
+      );
+    };
     this.client = client;
   }
 }

package/package.json

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