@shipengine/js-api 4.15.0 → 4.16.0

package/auctane-pay/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { ConfigResponse, CreateSessionRequest, CreateSessionResponse, PaymentMethodsResponse, PreviewTransactionRequest, PreviewTransactionResponse, UpdatePaymentMethodRequest, UpdatePaymentMethodResponse } from "./types";
+import { ConfigResponse, CreateSessionRequest, CreateSessionResponse, IdentityVerificationResponse, PaymentAccountResponse, PaymentMethodsResponse, PreviewTransactionRequest, PreviewTransactionResponse, UpdatePaymentMethodRequest, UpdatePaymentMethodResponse } from "./types";
 /**
  * # Auctane Pay API module - /v1/payments
  *
@@ -43,4 +43,14 @@ export declare class AuctanePayAPI {
      * @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>>;
+    /**
+     * The `identityVerification` method returns a Plaid IDV verification URL for a given user
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Identity-verification
+     */
+    identityVerification: () => Promise<import("axios").AxiosResponse<IdentityVerificationResponse, any>>;
+    /**
+     * The `getPaymentAccount` method returns the Payment Account data for a given user
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API
+     */
+    getPaymentAccount: () => Promise<import("axios").AxiosResponse<PaymentAccountResponse, any>>;
 }

package/auctane-pay/types.d.ts

@@ -144,6 +144,30 @@ export interface PaymentMethod {
  * The PaymentMethod from the Update response
  */
 export type UpdatePaymentMethodResponse = Omit<PaymentMethod, "sourceAccountId" | "paymentMethodType" | "institutionName">;
+export type IdentityProvider = "Plaid";
+export type IdentityVerificationResponse = {
+    /** Provider used for the identity verification */
+    identityProvider: IdentityProvider;
+    plaidLinkToken: string;
+    /** URL of the provider to start the identity verification */
+    verificationUrl: string;
+};
+export type PaymentAccountTrustLevel = "New" | "Trusted" | "Restricted" | "Grandfathered";
+export type PaymentAccountEnrollmentStatus = "NotSet" | "Enrolled" | "Prohibited" | "OptedOut";
+export type PaymentAccountResponse = {
+    /** Boolean to know if there is a IDV in progress */
+    isVerificationRequested: boolean;
+    /** Determine if the Wallet was created with Auctane Pay */
+    isWalletCreatedAfterAuctanePayLaunch: boolean;
+    /** Max amount of money the user can use */
+    limit: number;
+    /** Remaining amount of money */
+    limitRemaining: number;
+    /** Represents the surcharge enrollment status for an account. */
+    surchargeEnrollmentStatus: PaymentAccountEnrollmentStatus;
+    /** Auctane Pay's trust level for a particular customer. */
+    trustLevel: PaymentAccountTrustLevel;
+};
 /**
  * @category Entities
  */

package/index.js

@@ -310,6 +310,20 @@ class AuctanePayAPI {
         payload
       );
     };
+    /**
+     * The `identityVerification` method returns a Plaid IDV verification URL for a given user
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Identity-verification
+     */
+    this.identityVerification = () => {
+      return this.client.post("/v1/payments/identity_verification");
+    };
+    /**
+     * The `getPaymentAccount` method returns the Payment Account data for a given user
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API
+     */
+    this.getPaymentAccount = () => {
+      return this.client.get("/v1/payments/account");
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -306,6 +306,20 @@ class AuctanePayAPI {
         payload
       );
     };
+    /**
+     * The `identityVerification` method returns a Plaid IDV verification URL for a given user
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API#Identity-verification
+     */
+    this.identityVerification = () => {
+      return this.client.post("/v1/payments/identity_verification");
+    };
+    /**
+     * The `getPaymentAccount` method returns the Payment Account data for a given user
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5906662077/AUCTANE+PAY+ENDPOINTS+FOR+SHIPSTATION+API
+     */
+    this.getPaymentAccount = () => {
+      return this.client.get("/v1/payments/account");
+    };
     this.client = client;
   }
 }

package/package.json

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