unb-api 1.4.0 → 1.5.1

package/README.md

@@ -89,7 +89,7 @@ Returns: `Promise<{ page: number, totalPages: number, items: InventoryItem[] }>`
 `getInventoryItem(guildId: string, userId: string, itemId: string)`  
 Returns: `Promise<InventoryItem>`
 
-`addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string })`  
+`addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string, ignoreMaxQuantity?: boolean })`  
 Returns: `Promise<InventoryItem>`
 
 `removeInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number)`  
@@ -138,6 +138,7 @@ Returns: `Promise<any>`
 | Number  | `price`          | Price of the item.                                                        |
 | Number  | `stockRemaining` | Amount of stock remaining for the item.                                   |
 | Boolean | `unlimitedStock` | Whether the item has unlimited stock.                                     |
+| Number  | `maxQuantity?`   | Max a user can own, or buy at once if not an inventory item.              |
 | Boolean | `isInventory`    | Indicates if the item will be added to a user’s inventory when purchased. |
 | Date    | `expiresAt?`     | Expiration date of the item.                                              |
 | Boolean | `isUsable`       | Whether the item can be used by the user.                                 |

package/index.d.ts

@@ -37,7 +37,7 @@ declare module 'unb-api' {
 
         public getInventoryItem(guildId: string, userId: string, itemId: string): Promise<InventoryItem>
 
-        public addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string }): Promise<InventoryItem>
+        public addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string, ignoreMaxQuantity?: boolean }): Promise<InventoryItem>
 
         public removeInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number): Promise<any>
 
@@ -111,6 +111,7 @@ declare module 'unb-api' {
         public price: number;
         public stockRemaining: number;
         public unlimitedStock: boolean;
+        public maxQuantity: number | null;
         public isInventory: boolean;
         public expiresAt?: Date;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unb-api",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "API wrapper for UnbelievaBoat Discord Bot API",
   "main": "src/index.js",
   "types": "index.d.ts",
@@ -22,6 +22,6 @@
     "typescript": "^2.6.2"
   },
   "dependencies": {
-    "axios": "1.6.0"
+    "axios": "^1.20.0"
   }
 }

package/src/lib/Client.js

@@ -336,6 +336,7 @@ class Client {
      * @param {number|string} [quantity=1] - Quantity to add
      * @param {object} [options]
      * @param {string} [options.inventoryUserId] - User ID of the inventory to add the item from (can be used if the item no longer exists in the store or the item settings differ)
+     * @param {boolean} [options.ignoreMaxQuantity=false] - Add the item even if the user would own more than the item's max quantity
      * @returns {Promise<InventoryItem>}
      * 
      * @see {@link https://unbelievaboat-api.readme.io/reference/add-inventory-item|Add Inventory Item}

package/src/lib/structures/items/StoreItem.js

@@ -8,6 +8,7 @@ class StoreItem extends BaseItem {
     this.isInventory = data.is_inventory;
     this.stockRemaining = data.stock_remaining;
     this.unlimitedStock = data.unlimited_stock;
+    this.maxQuantity = data.max_quantity ?? null;
     if (data.expires_at) {
       this.expiresAt = new Date(data.expires_at);
     }