@shipengine/js-api 0.49.1 → 0.51.0

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

@@ -1,6 +1,6 @@
 export declare enum AccountBillingPlanChangeType {
-    Downgrade = 0,
-    Cancellation = 1
+    Downgrade = "Downgrade",
+    Cancellation = "Cancellation"
 }
 export type AccountBillingPlan = {
     code: string;

package/client.d.ts

@@ -14,6 +14,7 @@ import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
 import { ShipmentsAPI } from "./shipments";
 import { ShippingRulesAPI } from "./shipping-rules";
+import { ThemesAPI } from "./themes";
 import { WarehousesAPI } from "./warehouses";
 /**
  * # ShipEngine API Client Headers
@@ -145,6 +146,12 @@ export declare class ShipEngineAPI {
      * @see {@link ShipmentsAPI | The Shipments API module}
      */
     get shipments(): ShipmentsAPI;
+    /**
+     * The `themes` method provides access to the Themes endpoints in ShipEngine API.
+     *
+     * @see {@link ThemesAPI | The Themes API module}
+     */
+    get themes(): ThemesAPI;
     /**
      * The `warehouses` method provides access to the Warehouses endpoints in ShipEngine
      * API. e.g. List Warehouses, Get Warehouse, etc.

package/index.d.ts

@@ -20,6 +20,7 @@ export * from "./sales-orders";
 export * from "./shipments";
 export * from "./shipping-rules";
 export * from "./utilities";
+export * from "./themes";
 export * from "./warehouses";
 export * from "./weight";
 export * from "./zones";

package/index.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const axios = require('axios');
 
 var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeType2) => {
-  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Downgrade"] = 0] = "Downgrade";
-  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Cancellation"] = 1] = "Cancellation";
+  AccountBillingPlanChangeType2["Downgrade"] = "Downgrade";
+  AccountBillingPlanChangeType2["Cancellation"] = "Cancellation";
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
@@ -3789,6 +3789,19 @@ class ShippingRulesAPI {
   }
 }
 
+class ThemesAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves a specific theme by `themeId`.
+     */
+    this.get = (themeId) => {
+      return this.client.get(`/v1/themes/${themeId}`);
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -4107,6 +4120,14 @@ class ShipEngineAPI {
   get shipments() {
     return new ShipmentsAPI(this.client);
   }
+  /**
+   * The `themes` method provides access to the Themes endpoints in ShipEngine API.
+   *
+   * @see {@link ThemesAPI | The Themes API module}
+   */
+  get themes() {
+    return new ThemesAPI(this.client);
+  }
   /**
    * The `warehouses` method provides access to the Warehouses endpoints in ShipEngine
    * API. e.g. List Warehouses, Get Warehouse, etc.
@@ -4154,6 +4175,7 @@ exports.SalesOrdersAPI = SalesOrdersAPI;
 exports.ShipEngineAPI = ShipEngineAPI;
 exports.ShipmentsAPI = ShipmentsAPI;
 exports.ShippingRulesAPI = ShippingRulesAPI;
+exports.ThemesAPI = ThemesAPI;
 exports.WarehousesAPI = WarehousesAPI;
 exports.getEndUserIpAddress = getEndUserIpAddress;
 exports.isCodedError = isCodedError;

package/index.mjs

@@ -1,8 +1,8 @@
 import axios from 'axios';
 
 var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeType2) => {
-  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Downgrade"] = 0] = "Downgrade";
-  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Cancellation"] = 1] = "Cancellation";
+  AccountBillingPlanChangeType2["Downgrade"] = "Downgrade";
+  AccountBillingPlanChangeType2["Cancellation"] = "Cancellation";
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
@@ -3785,6 +3785,19 @@ class ShippingRulesAPI {
   }
 }
 
+class ThemesAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves a specific theme by `themeId`.
+     */
+    this.get = (themeId) => {
+      return this.client.get(`/v1/themes/${themeId}`);
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -4103,6 +4116,14 @@ class ShipEngineAPI {
   get shipments() {
     return new ShipmentsAPI(this.client);
   }
+  /**
+   * The `themes` method provides access to the Themes endpoints in ShipEngine API.
+   *
+   * @see {@link ThemesAPI | The Themes API module}
+   */
+  get themes() {
+    return new ThemesAPI(this.client);
+  }
   /**
    * The `warehouses` method provides access to the Warehouses endpoints in ShipEngine
    * API. e.g. List Warehouses, Get Warehouse, etc.
@@ -4123,4 +4144,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };

package/package.json

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

package/themes/api.d.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from "axios";
+import { PartnerTheme } from "./types";
+/**
+ * # Themes API module - /v1/themes
+ */
+export declare class ThemesAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves a specific theme by `themeId`.
+     */
+    get: (themeId: string) => Promise<import("axios").AxiosResponse<PartnerTheme, any>>;
+}

package/themes/index.d.ts

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

package/themes/types.d.ts

@@ -0,0 +1,21 @@
+export type PartnerThemeLogo = {
+    contentType: "image/jpeg" | "image/png";
+    imageData: string;
+};
+export type PartnerThemeOnboarding = {
+    completeButtonText?: string;
+    completeText?: string;
+    completeTitle?: string;
+    startText?: string;
+    startTitle?: string;
+};
+export type PartnerTheme = {
+    brand: string;
+    createdAt: string;
+    logo?: PartnerThemeLogo;
+    modifiedAt: string;
+    name: string;
+    onboarding?: PartnerThemeOnboarding;
+    returnUrl?: string;
+    themeId: string;
+};

package/types.d.ts

@@ -19,6 +19,7 @@ export * from "./sales-order-shipments/types";
 export * from "./sales-orders/types";
 export * from "./shipments/types";
 export * from "./shipping-rules/types";
+export * from "./themes/types";
 export * from "./warehouses/types";
 export * from "./weight/types";
 export * from "./weight-band/types";