@shipengine/js-api 4.17.1 → 4.18.2-next.0

package/account-features/api.d.ts

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

package/account-features/index.d.ts

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

package/account-features/types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Feature ID is always a numeric value, to help identify the value (and avoid magic numbers)
+ * we will use an enum
+ */
+export declare enum FeatureId {
+    SSApiAnalytics = 182
+}
+export type Feature = {
+    active: boolean;
+    featureId: FeatureId;
+    isAvailableToConnect: boolean;
+    name: string;
+};

package/auctane-pay/types.d.ts

@@ -55,22 +55,22 @@ export interface CreateSessionRequest {
 }
 export interface UpdatePaymentMethodRequest {
     /** Billing Address associated with the Payment Method */
-    billingAddress: {
-        addressLine1: string;
-        addressLine2: string;
-        cityLocality: string;
-        countryCode: string;
-        postalCode: string;
-        stateProvince: string;
+    billingAddress?: {
+        addressLine1?: string;
+        addressLine2?: string;
+        cityLocality?: string;
+        countryCode?: string;
+        postalCode?: string;
+        stateProvince?: string;
     };
     /** Transaction categories for this Payment Method */
-    defaultPaymentMethodCategories: AuctanePayTransactionCategory[];
+    defaultPaymentMethodCategories?: AuctanePayTransactionCategory[];
     /** Expiration Date for the Payment Method (Format: MM/YYYY) */
-    expirationDate: string;
+    expirationDate?: string;
     /** Holder name for the payment method */
-    holderName: string;
+    holderName?: string;
     /** Nickname used for this Payment Method */
-    nickname: string;
+    nickname?: string;
 }
 /**
  * @category Entities

package/client.d.ts

@@ -2,6 +2,7 @@ import { AxiosError, AxiosRequestHeaders } from "axios";
 import { AccountAddonsAPI } from "./account-addons";
 import { AccountBillingAPI } from "./account-billing";
 import { AccountBillingPlanAPI } from "./account-billing-plan";
+import { AccountFeaturesAPI } from "./account-features";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
 import { AuctanePayAPI } from "./auctane-pay";
@@ -116,6 +117,11 @@ export declare class ShipEngineAPI {
      * in ShipEngine API.
      */
     get accountAddons(): AccountAddonsAPI;
+    /**
+     * The `accountFeatures` method provides access to the Account Features endpoints
+     * in ShipEngine API.
+     */
+    get accountFeatures(): AccountFeaturesAPI;
     /**
      * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
      * in ShipEngine API.

package/index.d.ts

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

package/index.js

@@ -10,6 +10,11 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
+var FeatureId = /* @__PURE__ */ ((FeatureId2) => {
+  FeatureId2[FeatureId2["SSApiAnalytics"] = 182] = "SSApiAnalytics";
+  return FeatureId2;
+})(FeatureId || {});
+
 var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
 var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
 var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
@@ -147,6 +152,7 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   Currency,
   CustomsContentsType,
   CustomsNonDeliveryType,
+  FeatureId,
   InsuranceProviderType,
   MetadataCapability,
   MetadataRequirement,
@@ -236,6 +242,20 @@ class AccountAddonsAPI {
   }
 }
 
+class AccountFeaturesAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` method retrieves a list of all available features, also includes
+     * if its avaiable for the current user
+     */
+    this.list = () => {
+      return this.client.get("/v1/account/features");
+    };
+    this.client = client;
+  }
+}
+
 class AddressesAPI {
   constructor(client) {
     this.client = client;
@@ -21936,6 +21956,13 @@ class ShipEngineAPI {
   get accountAddons() {
     return new AccountAddonsAPI(this.client);
   }
+  /**
+   * The `accountFeatures` method provides access to the Account Features endpoints
+   * in ShipEngine API.
+   */
+  get accountFeatures() {
+    return new AccountFeaturesAPI(this.client);
+  }
   /**
    * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
    * in ShipEngine API.
@@ -22142,6 +22169,7 @@ exports.AccountAddonsAPI = AccountAddonsAPI;
 exports.AccountBillingAPI = AccountBillingAPI;
 exports.AccountBillingPlanAPI = AccountBillingPlanAPI;
 exports.AccountBillingPlanChangeType = AccountBillingPlanChangeType;
+exports.AccountFeaturesAPI = AccountFeaturesAPI;
 exports.AccountSettingsAPI = AccountSettingsAPI;
 exports.AddressesAPI = AddressesAPI;
 exports.AuctanePayAPI = AuctanePayAPI;
@@ -22154,6 +22182,7 @@ exports.Currency = Currency;
 exports.CustomPackagesAPI = CustomPackagesAPI;
 exports.CustomsContentsType = CustomsContentsType;
 exports.CustomsNonDeliveryType = CustomsNonDeliveryType;
+exports.FeatureId = FeatureId;
 exports.FundingSourcesAPI = FundingSourcesAPI;
 exports.InsuranceAPI = InsuranceAPI;
 exports.InsuranceProviderType = InsuranceProviderType;

package/index.mjs

@@ -6,6 +6,11 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
+var FeatureId = /* @__PURE__ */ ((FeatureId2) => {
+  FeatureId2[FeatureId2["SSApiAnalytics"] = 182] = "SSApiAnalytics";
+  return FeatureId2;
+})(FeatureId || {});
+
 var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
 var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
 var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
@@ -143,6 +148,7 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   Currency,
   CustomsContentsType,
   CustomsNonDeliveryType,
+  FeatureId,
   InsuranceProviderType,
   MetadataCapability,
   MetadataRequirement,
@@ -232,6 +238,20 @@ class AccountAddonsAPI {
   }
 }
 
+class AccountFeaturesAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `list` method retrieves a list of all available features, also includes
+     * if its avaiable for the current user
+     */
+    this.list = () => {
+      return this.client.get("/v1/account/features");
+    };
+    this.client = client;
+  }
+}
+
 class AddressesAPI {
   constructor(client) {
     this.client = client;
@@ -21932,6 +21952,13 @@ class ShipEngineAPI {
   get accountAddons() {
     return new AccountAddonsAPI(this.client);
   }
+  /**
+   * The `accountFeatures` method provides access to the Account Features endpoints
+   * in ShipEngine API.
+   */
+  get accountFeatures() {
+    return new AccountFeaturesAPI(this.client);
+  }
   /**
    * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
    * in ShipEngine API.
@@ -22134,4 +22161,4 @@ class ShipEngineAPI {
   }
 }
 
-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 };
+export { AccountAddonsAPI, AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountFeaturesAPI, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FeatureId, 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.17.1",
+  "version": "4.18.2-next.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/types.d.ts

@@ -3,6 +3,7 @@ export * from "./account-settings/types";
 export * from "./account-billing-plan/types";
 export * from "./account-billing/types";
 export * from "./account-addons/types";
+export * from "./account-features/types";
 export * from "./addresses/types";
 export * from "./auctane-pay/types";
 export * from "./carriers/types";