shipstation-node/dist/v2/resources/Warehouses.js

Unofficial Node.js wrapper for the ShipStation API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Warehouses = void 0;
const BaseResource_1 = require("../../BaseResource");
/**
 * [Official Documentation](https://docs.shipstation.com/openapi/warehouses)
 *
 * Get warehouse details like warehouse ID and related addresses using the warehouses endpoint.
 */
class Warehouses extends BaseResource_1.BaseResource {
    constructor(shipstation) {
        super(shipstation, 'warehouses');
    }
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/warehouses/get_warehouse_by_id)
     *
     * Retrieve warehouse data based on the warehouse ID
     *
     * @param warehouseId [1-25] characters `^se(-[a-z0-9]+)+$`
     *
     * @returns Warehouse details
     */
    async getById(warehouseId) {
        return this.shipstation.request({
            url: `${this.baseUrl}/${warehouseId}`,
            method: 'GET'
        });
    }
    /**
     * [Official Documentation](https://docs.shipstation.com/openapi/warehouses/list_warehouses)
     *
     * Retrieve a list of warehouses associated with this account.
     *
     * @returns A list of warehouses
     */
    async list() {
        return this.shipstation.request({
            url: this.baseUrl,
            method: 'GET'
        });
    }
}
exports.Warehouses = Warehouses;