@shipengine/js-api 4.13.0 → 4.15.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/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/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;
@@ -21891,6 +21905,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 +22114,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;
@@ -21887,6 +21901,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 +22110,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.13.0",
+  "version": "4.15.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";