New documentation 📖

Author: KaseyCantu

README.md

@@ -52,13 +52,18 @@ shipengine = ShipEngine(
 
 Methods
 -------
-- [validate_address](./docs/addresses_validate_example.md "Validate Address method documentation") - Indicates whether the provided address is valid. If the
+- [addresses_validate](./docs/addresses_validate_example.md) - Indicates whether the provided address is valid. If the
   address is valid, the method returns a normalized version of the address based on the standards of the country in
   which the address resides.
-- [normalize_address](./docs/normalize_address_example.md "Normalize Address method documentation") - Returns a normalized, or standardized, version of the
-  address. If the address cannot be normalized, an error is returned.
-- [track_package](./docs/track_package_example.md "Track Package method documentation") - Track a package by `packageId` or by `carrierCode` and `trackingNumber`. This method returns
+- [create_label_from_rate_id](./docs/create_label_from_rate_id_example.md) - Purchase a label by `rate_id`. When using the `get_rates_from_shipment` method, you can use one of the returned `rate_id` values with this method to purchase a label against a given rate.
+- [create_label_from_shipment](./docs/create_label_from_shipment.md) - Purchase a label created from shipment details.
+- [get_rates_from_shipment](./docs/get_rates_from_shipment_example.md) - Fetch rates from shipment details to shop the best shipping rate for your package.
+- [list_carriers](./docs/list_carriers_example.md) - Lists the carrier accounts connected to your SHipEngine account.
+- [track_package_by_label_id](./docs/track_package_by_label_id_example.md) - Track a package by `label_id`, the preferred way to track shipments if you crate shipping labels using ShipEngine. This method returns
 the all tracking events for a given shipment.
+- [track_package_by_carrier_code_and_tracking_number](./docs/track_package_by_carrier_code_and_tracking_number_example.md) - Track a package by `carrier_code` and `tracking_number`. This method returns
+the all tracking events for a given shipment.
+- [void_label_by_label_id](./docs/void_label_by_label_id_example.md) - Void a shipping label you created using ShipEngine by its `label_id`. This method returns an object that indicates the status of the void label request.
 
 Class Objects
 -------------

docs/create_label_from_rate_example.md docs/create_label_from_rate_id_example.mddocs/create_label_from_rate_example.md renamed to docs/create_label_from_rate_id_example.md

@@ -1,5 +1,5 @@
-Create Label From Rate Documentation
-====================================
+Create Label From Rate ID Documentation
+=======================================
 When retrieving rates for shipments using the `get_rates_from_shipment` method, the returned information contains a `rate_id` property that can be used to purchase a label without having to refill in the shipment information repeatedly.
 
 Please see [our docs](https://www.shipengine.com/docs/labels/create-from-rate/) to learn more about creating shipping labels from rates.
@@ -25,6 +25,7 @@ shipping and rate details encapsulated in the `rate_id` passed in.
 
 Example:
 ========
+
 ```python
 import os
 
@@ -47,7 +48,7 @@ def create_label_from_rate_demo():
             "label_download_type": "url",
             "display_scheme": "label",
         }
-        result = shipengine.create_label_from_rate(
+        result = shipengine.create_label_from_rate_id(
             rate_id="se-799373193", params=params
         )
         print("::SUCCESS::")

shipengine/shipengine.py

@@ -29,7 +29,7 @@ def __init__(self, config: Union[str, Dict[str, Any], ShipEngineConfig]) -> None
         elif type(config) is dict:
             self.config = ShipEngineConfig(config)
 
-    def create_label_from_rate(
+    def create_label_from_rate_id(
         self, rate_id: str, params: Dict[str, Any], config: Union[str, Dict[str, Any]] = None
     ) -> Dict[str, Any]:
         """