@shipengine/js-api 4.14.0 → 4.16.0

package/account-addons/api.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from "axios";
+import { Addon } from "./types";
+/**
+ * # Account Addons API module - /v1/account/addons
+ * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6364332064/Add-ons+New+endpoints+definition
+ */
+export declare class AccountAddonsAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of all available addons, also includes
+     * if its avaiable for the current user
+     */
+    list: () => Promise<import("axios").AxiosResponse<Addon[], any>>;
+}

package/account-addons/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api";
+export * from "./types";

package/account-addons/types.d.ts

@@ -0,0 +1,7 @@
+export type AddonTypes = "ss_api_analytics";
+export type Addon = {
+    code: AddonTypes;
+    isActive: boolean;
+    isAvailableToConnect: boolean;
+    name: string;
+};

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/client.d.ts

@@ -1,4 +1,5 @@
 import { AxiosError, AxiosRequestHeaders } from "axios";
+import { AccountAddonsAPI } from "./account-addons";
 import { AccountBillingAPI } from "./account-billing";
 import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
@@ -105,6 +106,11 @@ export declare class ShipEngineAPI {
      * in ShipEngine API.
      */
     get accountBillingPlan(): AccountBillingPlanAPI;
+    /**
+     * The `accountAddons` method provides access to the Account Addons endpoints
+     * in ShipEngine API.
+     */
+    get accountAddons(): AccountAddonsAPI;
     /**
      * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
      * in ShipEngine API.

package/index.d.ts

@@ -1,5 +1,6 @@
 export * as SE from "./types";
 export * from "./account-settings";
+export * from "./account-addons";
 export * from "./addresses";
 export * from "./auctane-pay";
 export * from "./account-billing-plan";

package/index.js

@@ -216,6 +216,20 @@ class AccountSettingsAPI {
   }
 }
 
+class AccountAddonsAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` method retrieves a list of all available addons, also includes
+     * if its avaiable for the current user
+     */
+    this.list = () => {
+      return this.client.get("/v1/account/addons");
+    };
+    this.client = client;
+  }
+}
+
 class AddressesAPI {
   constructor(client) {
     this.client = client;
@@ -296,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;
   }
 }
@@ -21891,6 +21919,13 @@ class ShipEngineAPI {
   get accountBillingPlan() {
     return new AccountBillingPlanAPI(this.client);
   }
+  /**
+   * The `accountAddons` method provides access to the Account Addons endpoints
+   * in ShipEngine API.
+   */
+  get accountAddons() {
+    return new AccountAddonsAPI(this.client);
+  }
   /**
    * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
    * in ShipEngine API.
@@ -22093,6 +22128,7 @@ class ShipEngineAPI {
   }
 }
 
+exports.AccountAddonsAPI = AccountAddonsAPI;
 exports.AccountBillingAPI = AccountBillingAPI;
 exports.AccountBillingPlanAPI = AccountBillingPlanAPI;
 exports.AccountBillingPlanChangeType = AccountBillingPlanChangeType;

package/index.mjs

@@ -212,6 +212,20 @@ class AccountSettingsAPI {
   }
 }
 
+class AccountAddonsAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` method retrieves a list of all available addons, also includes
+     * if its avaiable for the current user
+     */
+    this.list = () => {
+      return this.client.get("/v1/account/addons");
+    };
+    this.client = client;
+  }
+}
+
 class AddressesAPI {
   constructor(client) {
     this.client = client;
@@ -292,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;
   }
 }
@@ -21887,6 +21915,13 @@ class ShipEngineAPI {
   get accountBillingPlan() {
     return new AccountBillingPlanAPI(this.client);
   }
+  /**
+   * The `accountAddons` method provides access to the Account Addons endpoints
+   * in ShipEngine API.
+   */
+  get accountAddons() {
+    return new AccountAddonsAPI(this.client);
+  }
   /**
    * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
    * in ShipEngine API.
@@ -22089,4 +22124,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, UsersApi, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountAddonsAPI, AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, UsersApi, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/package.json

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

package/types.d.ts

@@ -2,6 +2,7 @@ export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
 export * from "./account-settings/types";
 export * from "./account-billing-plan/types";
 export * from "./account-billing/types";
+export * from "./account-addons/types";
 export * from "./addresses/types";
 export * from "./auctane-pay/types";
 export * from "./carriers/types";