@shipengine/js-api 0.35.0 → 0.37.0

package/account-billing-plan/api.d.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from "axios";
+import { AccountBillingPlanResponse } from "./types";
+/**
+ * # Account Billing Plan API module - /v1/account/billing_plan
+ */
+export declare class AccountBillingPlanAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    get: () => Promise<import("axios").AxiosResponse<AccountBillingPlanResponse, any>>;
+}

package/account-billing-plan/index.d.ts

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

package/account-billing-plan/types.d.ts

@@ -0,0 +1,30 @@
+export declare enum AccountBillingPlanChangeType {
+    Downgrade = 0,
+    Cancellation = 1
+}
+export type AccountBillingPlan = {
+    code: string;
+    name: string;
+};
+/**
+ * Responses
+ */
+/**
+ * "cancelledAt", "pendingChange" and "trialEndAt" are only available when applies
+ * won't be on the response otherwise
+ */
+export type AccountBillingPlanResponse = {
+    billingPlan: AccountBillingPlan;
+    cancelledAt?: string;
+    currentBillingCycle: {
+        endsAt: string;
+        startedAt: string;
+    };
+    pendingChange?: {
+        changeTo: AccountBillingPlan;
+        effectiveAt: string;
+        requestedAt: string;
+        type: AccountBillingPlanChangeType;
+    };
+    trialEndAt?: string;
+};

package/client.d.ts

@@ -1,4 +1,5 @@
 import { AxiosRequestHeaders } from "axios";
+import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
 import { CarriersAPI } from "./carriers";
@@ -54,6 +55,11 @@ export declare class ShipEngineAPI {
      * @see {@link AccountSettingsAPI | The Account Settings API module}
      */
     get accountSettings(): AccountSettingsAPI;
+    /**
+     * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
+     * in ShipEngine API.
+     */
+    get accountBillingPlan(): AccountBillingPlanAPI;
     /**
      * The `addresses` method provides access to the Address Validation endpoints
      * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.

package/errors/types.d.ts

@@ -1,7 +1,7 @@
 /**
  * @category Entities
  */
-export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "duplicated_rate_card" | "empty_file" | "field_conflict" | "field_value_required" | "forbidden" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "insufficient_rate_card_data" | "invalid_address" | "invalid_billing_plan" | "invalid_currency" | "invalid_field_value" | "invalid_file_type" | "invalid_file_size" | "invalid_identifier" | "invalid_status" | "invalid_string_length" | "invalid_zones" | "invalid_packages" | "invalid_weight_bands" | "invalid_rates" | "label_images_not_supported" | "meter_failure" | "not_found" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict";
+export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "duplicated_rate_card" | "empty_file" | "field_conflict" | "field_value_required" | "forbidden" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "insufficient_rate_card_data" | "invalid_address" | "invalid_billing_plan" | "invalid_currency" | "invalid_field_value" | "invalid_file_type" | "invalid_file_size" | "invalid_identifier" | "invalid_status" | "invalid_string_length" | "invalid_zones" | "invalid_packages" | "invalid_weight_bands" | "invalid_weight_bands_rates" | "invalid_rates" | "label_images_not_supported" | "meter_failure" | "not_found" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "repeated_surcharges_in_rate_card" | "repeated_surcharges_in_services" | "repeated_surcharges_in_zone" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict";
 /**
  * @category Entities
  */

package/index.js

@@ -3227,6 +3227,19 @@ var lib = {
     stringify: stringify
 };
 
+class AccountBillingPlanAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing_plan");
+    };
+    this.client = client;
+  }
+}
+
 class CustomPackagesAPI {
   constructor(client) {
     this.client = client;
@@ -3825,6 +3838,13 @@ class ShipEngineAPI {
   get accountSettings() {
     return new AccountSettingsAPI(this.client);
   }
+  /**
+   * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
+   * in ShipEngine API.
+   */
+  get accountBillingPlan() {
+    return new AccountBillingPlanAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.

package/index.mjs

@@ -3223,6 +3223,19 @@ var lib = {
     stringify: stringify
 };
 
+class AccountBillingPlanAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing_plan");
+    };
+    this.client = client;
+  }
+}
+
 class CustomPackagesAPI {
   constructor(client) {
     this.client = client;
@@ -3821,6 +3834,13 @@ class ShipEngineAPI {
   get accountSettings() {
     return new AccountSettingsAPI(this.client);
   }
+  /**
+   * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
+   * in ShipEngine API.
+   */
+  get accountBillingPlan() {
+    return new AccountBillingPlanAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.

package/package.json

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