sound-tank 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# sound-tank
+
+## 1.1.0
+
+### Minor Changes
+
+- additional typing, expose more methods

package/README.md

@@ -1,19 +1,37 @@
-# Library Template
+<h1 align="center">
+ Sound Tank
+</h1>
 
-This is a template for a typescript library.
+<p align="center">
+ A library to interface with <a href="https://www.reverb.com/" target="_blank">Reverb's</a> API programmatically.
+</p>
 
-## Usage
+<p align="center">
+ To get started, just run <code>npm install sound-tank</code> in your project's directory, or <code>yarn add sound-tank</code> if you prefer Yarn.
+</p>
 
-- Use this template to create a new repository
-- Clone the repository
-- Run `yarn install`
-- Add a NPM token to your github environment variables as "NPM_TOKEN"
-- Delete this README.md and replace it with your own
-- Update the package.json with your own information
-- Update the LICENSE file with your own information
+<h2>
+  Example Usage
+</h2>
 
-## Links
+```typescript
+import Reverb from 'sound-tank';
 
-- [Github](https://github.com/ZacharyEggert/library-template)
+const { REVERB_API_KEY } = process.env;
 
-- [NPM](https://www.npmjs.com/package/@zacharyeggert/library-template)
+(async () => {
+  const reverb = new Reverb({ apiKey: REVERB_API_KEY });
+
+  const response = await reverb.getMyListings({
+    perPage: 10,
+    page: 1,
+    state: 'all',
+  });
+
+  const { listings } = response.data;
+
+  listings.forEach((listing) => {
+    console.log(listing.title);
+  });
+})();
+```

package/dist/index.d.ts

@@ -97,6 +97,101 @@ type Listing = {
     }[];
     _links: ListingLinks;
 };
+type OrderStatus = 'unpaid' | 'awaiting_shipment' | 'shipped' | Exclude<string, 'unpaid' | 'awaiting_shipment' | 'shipped'>;
+type ShippingProvider = 'UPS' | 'USPS' | 'FedEx' | 'DHL Deutschland' | 'DHLExpress' | 'DHLGlobalMail' | 'DHL' | 'Canada Post' | 'CanPar' | 'Royal Mail' | 'PostNL' | 'Australia Post' | 'EMS' | 'La Poste - Colissimo' | 'China Post' | 'GLS' | 'Parcelforce' | 'Purolator' | 'Interlogistica' | 'Correos España' | 'Ukraine Post' | 'DPD Germany' | 'DPD UK' | 'DPD France' | 'Hermes' | 'TNT' | 'Other';
+type OrderTaxResponsibleParty = 'reverb' | Exclude<string, 'reverb'>;
+type OrderShippingMethod = 'shipped' | Exclude<string, 'shipped'>;
+type OrderShipmentStatus = 'in_transit' | Exclude<string, 'in_transit'>;
+type OrderType = 'offer' | Exclude<string, 'offer'>;
+type OrderSource = 'reverb' | Exclude<string, 'reverb'>;
+type Order = {
+    amount_product: Price;
+    presentment_amount_product: Price;
+    amount_product_subtotal: Price;
+    presentment_amount_product_subtotal: Price;
+    shipping: Price;
+    presentment_amount_shipping: Price;
+    amount_tax: Price;
+    presentment_amount_tax: Price;
+    total: Price;
+    presentment_amount_total: Price;
+    shipping_taxed: boolean;
+    buyer_name: string;
+    buyer_first_name: string;
+    buyer_email: string;
+    buyer_last_name: string;
+    buyer_id: number | string;
+    created_at: ReturnType<typeof Date.toString>;
+    order_number: number | string;
+    tax_rate: number;
+    order_source: OrderSource;
+    needs_feedback_for_buyer: boolean;
+    needs_feedback_for_seller: boolean;
+    order_type: OrderType;
+    paid_at: ReturnType<typeof Date.toString>;
+    quantity: number;
+    shipping_address: ShippingAddress;
+    shipping_date: ReturnType<typeof Date.toString>;
+    shipped_at: ReturnType<typeof Date.toString>;
+    shipping_provider: ShippingProvider;
+    shipping_code: string;
+    shipping_method: OrderShippingMethod;
+    shipment_status: OrderShipmentStatus;
+    local_pickup: boolean;
+    shop_name: string;
+    status: OrderStatus;
+    title: string;
+    updated_at: ReturnType<typeof Date.toString>;
+    payment_method: string;
+    order_bundle_id: number | string;
+    product_id: number | string;
+    uuid: string;
+    photos: {
+        _links: PhotoLinks;
+    }[];
+    selling_fee: Price;
+    bump_fee: Price;
+    direct_checkout_fee: Price;
+    tax_on_fees: Price;
+    tax_responsible_party: OrderTaxResponsibleParty;
+    direct_checkout_payout: Price;
+    order_notes: any[];
+    _links: OrderLinks;
+};
+type OrderLinks = {
+    photo: Link;
+    feedback_for_buyer: Link;
+    feedback_for_seller: Link;
+    listing: Link;
+    start_conversation: Link;
+    web_tracking: Link;
+    web: Link;
+    web_listing: Link;
+    self: Link;
+    mark_picked_up: Link;
+    payments: Link;
+    contact_buyer: {
+        web: Link;
+    };
+};
+type ShippingAddress = {
+    region: string;
+    locality: string;
+    country_code: string;
+    display_location: string;
+    id: number | string;
+    primary: boolean;
+    name: string;
+    street_address: string;
+    extended_address: string;
+    postal_code: string;
+    phone: string;
+    unformatted_phone: string;
+    complete_shipping_address: boolean;
+    _links: {
+        self: Link;
+    };
+};
 
 interface GetMyListingsOptions {
     page?: number;
@@ -106,6 +201,12 @@ interface GetMyListingsOptions {
     state?: string;
 }
 
+interface GetMyOrdersOptions {
+    page?: number;
+    perPage?: number;
+    status?: Order['status'] | 'all';
+}
+
 type PaginatedReverbResponse<T> = T & {
     total: number;
     current_page: number;
@@ -115,6 +216,12 @@ type PaginatedReverbResponse<T> = T & {
         prev?: Link;
     };
 };
+type GetArbitraryEndpointOptions = {
+    url: string;
+    params?: {
+        [key: string]: string;
+    };
+};
 
 type ApiVersion = string;
 type ApiKey = string;
@@ -168,6 +275,10 @@ declare class Reverb {
     getMyListings(options?: GetMyListingsOptions): Promise<axios.AxiosResponse<PaginatedReverbResponse<{
         listings: Listing[];
     }>, any>>;
+    getMyOrders(options?: GetMyOrdersOptions): Promise<axios.AxiosResponse<PaginatedReverbResponse<{
+        orders: Order[];
+    }>, any>>;
+    getArbitraryEndpoint(options: GetArbitraryEndpointOptions): Promise<axios.AxiosResponse<any, any>>;
 }
 
 export { ApiKey, ApiVersion, AuthReverbHeaders, DisplayCurrency, Locale, ReverbHeaders, ReverbOptions, RootEndpoint, ShippingRegion, Reverb as default };

package/dist/index.js

@@ -88,8 +88,30 @@ var getMyListings = (reverb, options) => __async(void 0, null, function* () {
   return response;
 });
 
-// src/methods/index.ts
+// src/methods/orders/getOrders.ts
 var import_axios2 = __toESM(require("axios"));
+var getMyOrders = (reverb, options) => __async(void 0, null, function* () {
+  const { page, perPage, status } = options;
+  const baseUrl = `${reverb.rootEndpoint}/my/orders/selling/${status || "all"}`;
+  const pageString = page ? `&page=${page}` : "";
+  const perPageString = perPage ? `&per_page=${perPage}` : "";
+  const url = `${baseUrl}?${pageString}${perPageString}`;
+  const response = yield import_axios2.default.get(url, {
+    headers: reverb.headers
+  });
+  return response;
+});
+
+// src/methods/index.ts
+var import_axios3 = __toESM(require("axios"));
+var getArbitraryEndpoint = (reverb, options) => __async(void 0, null, function* () {
+  const { url, params } = options;
+  const response = yield import_axios3.default.get(url, {
+    headers: reverb.headers,
+    params
+  });
+  return response;
+});
 
 // src/Reverb.ts
 var _Reverb = class {
@@ -183,6 +205,16 @@ var _Reverb = class {
       return yield getMyListings(this, options != null ? options : {});
     });
   }
+  getMyOrders(options) {
+    return __async(this, null, function* () {
+      return yield getMyOrders(this, options != null ? options : {});
+    });
+  }
+  getArbitraryEndpoint(options) {
+    return __async(this, null, function* () {
+      return yield getArbitraryEndpoint(this, options);
+    });
+  }
 };
 var Reverb = _Reverb;
 Reverb.defaultHeaders = {

package/dist/index.mjs

@@ -55,8 +55,30 @@ var getMyListings = (reverb, options) => __async(void 0, null, function* () {
   return response;
 });
 
-// src/methods/index.ts
+// src/methods/orders/getOrders.ts
 import axios2 from "axios";
+var getMyOrders = (reverb, options) => __async(void 0, null, function* () {
+  const { page, perPage, status } = options;
+  const baseUrl = `${reverb.rootEndpoint}/my/orders/selling/${status || "all"}`;
+  const pageString = page ? `&page=${page}` : "";
+  const perPageString = perPage ? `&per_page=${perPage}` : "";
+  const url = `${baseUrl}?${pageString}${perPageString}`;
+  const response = yield axios2.get(url, {
+    headers: reverb.headers
+  });
+  return response;
+});
+
+// src/methods/index.ts
+import axios3 from "axios";
+var getArbitraryEndpoint = (reverb, options) => __async(void 0, null, function* () {
+  const { url, params } = options;
+  const response = yield axios3.get(url, {
+    headers: reverb.headers,
+    params
+  });
+  return response;
+});
 
 // src/Reverb.ts
 var _Reverb = class {
@@ -150,6 +172,16 @@ var _Reverb = class {
       return yield getMyListings(this, options != null ? options : {});
     });
   }
+  getMyOrders(options) {
+    return __async(this, null, function* () {
+      return yield getMyOrders(this, options != null ? options : {});
+    });
+  }
+  getArbitraryEndpoint(options) {
+    return __async(this, null, function* () {
+      return yield getArbitraryEndpoint(this, options);
+    });
+  }
 };
 var Reverb = _Reverb;
 Reverb.defaultHeaders = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sound-tank",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A library for interacting with the Reverb Marketplace API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -8,6 +8,10 @@
   "types": "dist/index.d.ts",
   "author": "Zachary Eggert <Eggert.Zachary@gmail.com>",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ZacharyEggert/sound-tank.git"
+  },
   "scripts": {
     "dev": "vitest",
     "test": "vitest run",