shipbob-node-sdk 0.0.2 → 0.0.4

package/README.md

@@ -3,15 +3,23 @@ First of all there are no official SDKs for ShipBob.  I'm just dropping this her
 
 These is just a starting point for anybody looking to integrate ShipBob into a Node.js application.
 
-You could make it run in the browser by replacing `https` with `fetch` or `axios`.  I could have used fetch as well, but in case somebody is on Node < v18 (and it wasn't stable till v21 anyway).
+It uses the built-in node.js fetch.
 
-This is not an official or supported library.  If you extend or have any issues kindly open a PR.  Not really sure anybody will ever need this as most common platforms probably have built-in support.
+Not really sure anybody will ever need this as most common platforms probably have integrations.  There are a couple of other community SDKs.  They do not have 2.0 endpoints:
+ - [shipbob-sdk-python](https://github.com/community-phone-company/shipbob-sdk-python)
+ - [shipbob-go](https://github.com/stryd/shipbob-go) - generated from Open API
 
 NOTE: I did not notice until all this code was written that ShipBob had published an Open API spec :facepunch:.  You may have better luck generating your own client.
 ```bash
 $ yarn generate:client
 ```
-The included script using OpenAPI to generate clients in various languages.  It's generating TypeScript.  This SDK exposes some endpoints not available in the OpenAPI - the `2.0/receiving-extended` and `experimental/receiving` endpoints.
+The included script using OpenAPI can generate clients in various languages.
+
+This SDK exposes some endpoints not available in the OpenAPI including:
+- `/2.0/receiving-extended`
+- `/2.0/product`
+- `/experimental/product` :skull:
+- `/experimental/receiving` :skull:
 
 Have a look in the `/test` folder.  You might like more something like PostMan, but you can run and debug these "tests" in VS Code.  You need a `.env` file with a Personal Access Token:
 ```
@@ -21,68 +29,89 @@ SHIPBOB_API_TOKEN=<redacted>
 # API implementation progress
 
 ## Legend
-> [x] = I haven't needed this
+:x: = I haven't needed this
 
-> [✓] = implemented
+:heavy_check_mark: = implemented
 
-> [ ] = intend to add
+- [ ] = intend to add
 
-> [?] = might add support soon - under investigation
+:question: = might add support soon - under investigation
 
 ## Orders
-- [x] Estimate Fulfillment Cost For Order
-- [?] Get Order
-- [?] Get Orders
-- [✓] Create Order: api.placeOrder(...)
-- [✓] Cancel single Order by Order ID: api.cancelSingleOrderByOrderId()
-- [x] Get Order Store Json
-- [x] Save the Store Order Json (The JSON that represent the order on the Third Party Source)
-- [x] Get one Shipment by Order Id and Shipment Id
-- [x] Cancel one Shipment by Order Id and Shipment Id
-- [x] Get one Shipment's status timeline by Order Id and Shipment Id
-- [?] Get all Shipments for Order
-- [x] Get logs for one Shipment by Order Id and Shipment Id
+- :x: Estimate Fulfillment Cost For Order
+- :question: Get Order
+- :question: Get Orders
+- :heavy_check_mark: Create Order: api.placeOrder(...)
+- :heavy_check_mark: Cancel single Order by Order ID: api.cancelSingleOrderByOrderId()
+- :x: Get Order Store Json
+- :x: Save the Store Order Json (The JSON that represent the order on the Third Party Source)
+- :x: Get one Shipment by Order Id and Shipment Id
+- :x: Cancel one Shipment by Order Id and Shipment Id
+- :x: Get one Shipment's status timeline by Order Id and Shipment Id
+- :question: Get all Shipments for Order
+- :x: Get logs for one Shipment by Order Id and Shipment Id
+- :x: Get one Shipment by Shipment Id
+- :x: Update a Shipment
+- :x: Cancel one Shipment by Shipment Id
+- :x: Cancel multiple Shipments by Shipment Id
+- :x: Get one Shipment's status timeline by Shipment Id
+- :x: Get logs for one Shipment by Shipment Id
+- :heavy_check_mark: Get shipping methods: api.getShippingMethods()
 
 ## Shipments
-- [?] Get one Shipment by Shipment Id (webhooks are enough?)
-- [?] Update a Shipment (marked with tracking information uploaded to a third-party system where the order originated)
-- [?] Cancel one Shipment by Shipment Id
-- [x] Cancel multiple Shipments by Shipment Id
-- [x] Get one Shipment's status timeline by Shipment Id
-- [x] Get logs for one Shipment by Shipment Id
-- [?] Get shipping methods (hard-code shipping methods?)
-
-## Products
-- [✓] Get multiple products: api.getProducts(...)
-- [✓] Add a single product to the store: api.addProduct(...)
-- [ ] Modify a single product (we will need this to add multiple barcodes)
-- [x] Add multiple products to the store
+- :question: Get one Shipment by Shipment Id (webhooks are enough?)
+- :question: Update a Shipment (marked with tracking information uploaded to a third-party system where the order originated)
+- :question: Cancel one Shipment by Shipment Id
+- :x: Cancel multiple Shipments by Shipment Id
+- :x: Get one Shipment's status timeline by Shipment Id
+- :x: Get logs for one Shipment by Shipment Id
+- :question: Get shipping methods (hard-code shipping methods?)
+
+## Products 1.0
+- :heavy_check_mark: Get multiple products: api.getProducts1_0(...)
+- :heavy_check_mark: Add a single product to the store: api.createProduct1_0(...)
+- :x: Modify a single product (using 2.0 for additional properties)
+- :x: Add multiple products to the store
+
+## Products 2.0
+These are not documented on the site yet:
+- :heavy_check_mark: Get multiple products: api.getProducts2_0(...)
+- :heavy_check_mark: Add a single product to the store: api.createProduct2_0(...)
+- :heavy_check_mark: Modify a single product: api.updateProducts2_0(...)
+- :x: Add multiple products to the store
+
+## Products Experimental
+Kindly note as it's experimental subject to change/removal :skull:
+- :heavy_check_mark: Get multiple products: api.getProductsExperimental(...)
+- :heavy_check_mark: Add a single product to the store: api.createProductExperimental(...)
+- :heavy_check_mark: Modify a single product: api.updateProductsExperimental(...)
+- :x: Add multiple products to the store
 
 ## Inventory
 - [ ] Get an inventory item
-- [✓] List inventory items: api.listInventory(...)
-- [x] Get a list of inventory items by product id (we don't know product_id)
+- :heavy_check_mark: List inventory items: api.listInventory(...)
+- :x: Get a list of inventory items by product id (we don't know product_id)
 
 ## Channels
-- [✓] Get user-authorized channel info: not in api, but used on init
+- :heavy_check_mark: Get user-authorized channel info: not in api, but used on init
 
 ## Returns
-- [?] Get Return Order
-- [?] Modify Return Order
-- [?] Get Return Orders
-- [?] Create Return Order
-- [?] Cancel Return Order
-- [?] Get One Return's status history
+- :question: Get Return Order
+- :question: Modify Return Order
+- :question: Get Return Orders
+- :question: Create Return Order
+- :question: Cancel Return Order
+- :question: Get One Return's status history
 
 ## Receiving
-- [x] Get Fulfillment Centers
-- [✓] Get Warehouse Receiving Order
-- [✓] Get Warehouse Receiving Order Boxes
-- [ ] Get Multiple Warehouse Receiving Orders (we probably need this to filter by statuses)
-- [✓] Create Warehouse Receiving Order: api.createWarehouseReceivingOrder(...)
-- [x] Get Warehouse Receiving Order Box Labels
-- [x] Cancel Warehouse Receiving Order (could be done manually, if needed?)
-- [x] 5 x DEPRECATED '/1.0/receiving
+- :heavy_check_mark: Get Fulfillment Centers: api.getFulfillmentCenters()
+- :heavy_check_mark: Get Warehouse Receiving Order
+- :heavy_check_mark: Get Warehouse Receiving Order Boxes
+- [ ] Get Multiple Warehouse Receiving Orders (we will need this to filter by statuses - will include this in a recipe that uses SetExternalSync)
+- :heavy_check_mark: Create Warehouse Receiving Order: api.createWarehouseReceivingOrder(...)
+- :x: Get Warehouse Receiving Order Box Labels
+- :x: Cancel Warehouse Receiving Order (could be done manually, if needed?)
+- :x: 5 x DEPRECATED '/1.0/receiving
   - Get Warehouse Receiving Order
   - Get a Warehouse Receiving Order by Purchase Order Number
   - Create Warehouse Receiving Order
@@ -90,15 +119,20 @@ SHIPBOB_API_TOKEN=<redacted>
   - Cancel Warehouse Receiving Order
 
 ## Receiving-Extended (not in API docs)
-- [✓] Get Receiving Extended: api.getReceivingExtended(...)
+- :heavy_check_mark: Get Receiving Extended: api.getReceivingExtended(...)
+
+## Receiving Experimental
+Kindly note as it's experimental subject to change/removal :skull:
 
-## Experimental/receiving (not in API docs.  can change/be removed)
-- [✓] Receiving Set External Sync: api.experimentalReceivingSetExternalSync(...)
+I'll try to share a recipe for using this for marking completed WROs.
+- :heavy_check_mark: Receiving Set External Sync: api.experimentalReceivingSetExternalSync(...)
 
 ## Webhooks
-- [✓] Get Webhooks: api.getWebhooks()
-- [✓] Create a new webhook subscription: api.createWebhookSubscription(...)
-- [ ] Delete an existing webhook subscription
+- :heavy_check_mark: Get Webhooks: api.getWebhooks()
+- :heavy_check_mark: Create a new webhook subscription: api.registerWebhookSubscription(...)
+- :heavy_check_mark: Delete an existing webhook subscription: api.unregisterWebhookSubscription(...)
 
 ## Locations
-- [x] Get locations
+- :x: Get locations
+
+For making changes locally - use `yarn link` to test out the changes easily.