@shipengine/js-api 4.12.0 → 4.14.0

package/account-billing/types.d.ts

@@ -20,6 +20,14 @@ export type AccountBillingResponse = {
     stateProvince: string;
 };
 /** @internal */
+type PaymentMethodWithId = {
+    paymentMethodId: string;
+};
+/** @internal */
+type PaymentMethodWithSession = {
+    sessionId: string;
+};
+/** @internal */
 export type UpsertAccountBillingRequestBody = {
     addressLine1: string;
     addressLine2?: string;
@@ -28,9 +36,13 @@ export type UpsertAccountBillingRequestBody = {
     countryCode: string;
     email: string;
     fullName: string;
-    paymentMethod: {
-        sessionId: string;
-    };
+    /**
+     * In the request , payment method has to pass either a paymentMethodId or a sessionId
+     * Cases:
+     * 1. When we want to assign a newly created payment method where you don't yet know the payment method ID -> session ID.
+     * 2. If we already know the payment method ID because it was created previously -> payment method ID.
+     */
+    paymentMethod: PaymentMethodWithId | PaymentMethodWithSession;
     phone: string;
     postalCode: string;
     stateProvince: string;

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
  *
@@ -38,4 +38,9 @@ export declare class AuctanePayAPI {
      * @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

@@ -53,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
  */
@@ -92,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.
@@ -119,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

@@ -286,6 +286,16 @@ class AuctanePayAPI {
     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

@@ -282,6 +282,16 @@ class AuctanePayAPI {
     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.12.0",
+  "version": "4.14.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {