@shipengine/js-api 0.43.0 → 0.44.0

package/account-settings/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { AccountSettings } from "./types";
+import { AccountImage, AccountImageResponse, AccountImagesResponse, AccountSettings, UpdateAccountImage } from "./types";
 /**
  * # Account Settings API module - /v1/account/settings
  */
@@ -16,4 +16,20 @@ export declare class AccountSettingsAPI {
      * @params Partial<AccountSettings> The account settings to update.
      */
     update: (settings: Partial<AccountSettings>) => Promise<import("axios").AxiosResponse<AccountSettings, any>>;
+    /**
+     * The `createImage` method creates an image that can be used in your printed labels.
+     */
+    createImage: (data: AccountImage) => Promise<import("axios").AxiosResponse<AccountImageResponse, any>>;
+    /**
+     * The `updateImage` method updates specific image data for a given image id.
+     */
+    updateImage: ({ labelImageId, ...data }: UpdateAccountImage) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `getImages` method retrieves a list of images for a given user.
+     */
+    getImages: () => Promise<import("axios").AxiosResponse<AccountImagesResponse, any>>;
+    /**
+     * The `deleteAccountImage` method deletes an image by id.
+     */
+    deleteImage: (labelImageId: string) => Promise<import("axios").AxiosResponse<void, any>>;
 }

package/account-settings/types.d.ts

@@ -1,8 +1,24 @@
 import { DimensionUnit } from "../dimensions";
 import { LabelLayout } from "../labels";
+import { PageableResult } from "../resources";
 import { WeightUnit } from "../weight";
 export interface AccountSettings {
     defaultLabelLayout: LabelLayout;
     dimensionsUnit: DimensionUnit;
     weightUnit: WeightUnit;
 }
+export type AccountImage = {
+    imageContentType: string;
+    imageData: string;
+    isDefault: boolean;
+    name: string;
+};
+export type AccountImageResponse = AccountImage & {
+    createdAt: string;
+    labelImageId: string;
+    modifiedAt: string;
+};
+export type AccountImagesResponse = {
+    images: AccountImageResponse[];
+} & PageableResult;
+export type UpdateAccountImage = Partial<Omit<AccountImageResponse, "isDefault" | "createdAt" | "modifiedAt">> & Pick<AccountImageResponse, "isDefault">;

package/index.js

@@ -10,17 +10,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
-var __objRest$1 = (source, exclude) => {
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __objRest$2 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+  if (source != null && __getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -34,7 +34,7 @@ class CodedError {
     this.message = message;
   }
   static fromObject(_a) {
-    var _b = _a, { message } = _b, options = __objRest$1(_b, ["message"]);
+    var _b = _a, { message } = _b, options = __objRest$2(_b, ["message"]);
     return new CodedError(message, options);
   }
 }
@@ -142,6 +142,21 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
+var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
+var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
+var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __objRest$1 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 class AccountSettingsAPI {
   constructor(client) {
     this.client = client;
@@ -159,6 +174,31 @@ class AccountSettingsAPI {
     this.update = (settings) => {
       return this.client.put("/v1/account/settings", settings);
     };
+    /**
+     * The `createImage` method creates an image that can be used in your printed labels.
+     */
+    this.createImage = (data) => {
+      return this.client.post("/v1/account/settings/images", data);
+    };
+    /**
+     * The `updateImage` method updates specific image data for a given image id.
+     */
+    this.updateImage = (_a) => {
+      var _b = _a, { labelImageId } = _b, data = __objRest$1(_b, ["labelImageId"]);
+      return this.client.put(`/v1/account/settings/images/${labelImageId}`, data);
+    };
+    /**
+     * The `getImages` method retrieves a list of images for a given user.
+     */
+    this.getImages = () => {
+      return this.client.get("/v1/account/settings/images");
+    };
+    /**
+     * The `deleteAccountImage` method deletes an image by id.
+     */
+    this.deleteImage = (labelImageId) => {
+      return this.client.delete(`/v1/account/settings/images/${labelImageId}`);
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -6,17 +6,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
-var __objRest$1 = (source, exclude) => {
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __objRest$2 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+  if (source != null && __getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -30,7 +30,7 @@ class CodedError {
     this.message = message;
   }
   static fromObject(_a) {
-    var _b = _a, { message } = _b, options = __objRest$1(_b, ["message"]);
+    var _b = _a, { message } = _b, options = __objRest$2(_b, ["message"]);
     return new CodedError(message, options);
   }
 }
@@ -138,6 +138,21 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
+var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
+var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
+var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __objRest$1 = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 class AccountSettingsAPI {
   constructor(client) {
     this.client = client;
@@ -155,6 +170,31 @@ class AccountSettingsAPI {
     this.update = (settings) => {
       return this.client.put("/v1/account/settings", settings);
     };
+    /**
+     * The `createImage` method creates an image that can be used in your printed labels.
+     */
+    this.createImage = (data) => {
+      return this.client.post("/v1/account/settings/images", data);
+    };
+    /**
+     * The `updateImage` method updates specific image data for a given image id.
+     */
+    this.updateImage = (_a) => {
+      var _b = _a, { labelImageId } = _b, data = __objRest$1(_b, ["labelImageId"]);
+      return this.client.put(`/v1/account/settings/images/${labelImageId}`, data);
+    };
+    /**
+     * The `getImages` method retrieves a list of images for a given user.
+     */
+    this.getImages = () => {
+      return this.client.get("/v1/account/settings/images");
+    };
+    /**
+     * The `deleteAccountImage` method deletes an image by id.
+     */
+    this.deleteImage = (labelImageId) => {
+      return this.client.delete(`/v1/account/settings/images/${labelImageId}`);
+    };
     this.client = client;
   }
 }

package/package.json

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