Merge pull request #140 from purplship/purplship-sdk-2021.7

[release] purplship SDK 2021.7

Author: danh91

README.md

@@ -82,9 +82,10 @@ from purplship.mappers.canadapost.settings import Settings
 # Initialize a carrier gateway
 canadapost = purplship.gateway["canadapost"].create(
     Settings(
-        username="username",
-        password="password",
-        customer_number="123456789",
+        username="6e93d53968881714",
+        password="0bfa9fcb9853d1f51ee57a",
+        customer_number="2004381",
+        contract_id="42708517",
         test=True
     )
 )
@@ -125,6 +126,7 @@ rate_request = RateRequest(
     shipper=shipper,
     recipient=recipient,
     parcels=[parcel],
+    services=["canadapost_xpresspost"],
 )
 
 # Send a rate request using a carrier gateway
@@ -159,15 +161,16 @@ print(rates)
 
 - [**Documentation**](https://sdk.purplship.com)
 - [**Bug Tracker**](https://github.com/puprlship/purplship/issues)
-- [**Community on Discord**](https://discord.gg/gS88uE7sEx)
+- [**Github Community**](https://github.com/purplship/purplship-server/discussions)
 
 ## Contributing
 
 We encourage you to contribute to puprlship! Please check out the
 [Contributing to purplship guide](/docs/development/contributing.md) for guidelines about how to proceed.
-[Join the purplship Community!](https://github.com/purplship/purplship/discussions)
+[Join the purplship discord channel!](https://discord.gg/gS88uE7sEx)
 
-Do you want to extend purplship and integrate a custom carrier, check out [Extending purplship](https://sdk.purplship.com/development/extending/)
+Do you want to extend purplship and integrate a custom carrier, check out 
+[Extending purplship](https://sdk.purplship.com/development/extending/)
 
 ## License
 

docs/development/extending.md

@@ -84,6 +84,7 @@ import purplship.providers.[carrier_name].units as units
 
 
 METADATA = Metadata(
+    id="[carrier_name]",
     label="[Carrier Name]",
 
     # Integrations

docs/guide/gateways.md

@@ -70,6 +70,19 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
+
+
+#### BoxKnight Settings `[carrier_name = boxknight]`
+
+| Name | Type | Description 
+| --- | --- | --- |
+| `username` | `str` | **required**
+| `password` | `str` | **required**
+| `id` | `str` | 
+| `test` | `bool` | 
+| `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### Canada Post Settings `[carrier_name = canadapost]`
@@ -78,12 +91,13 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | --- | --- | --- |
 | `username` | `str` | **required**
 | `password` | `str` | **required**
-| `customer_number` | `str` | **required**
+| `customer_number` | `str` | 
 | `contract_id` | `str` | 
 | `language` | `str` | 
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### Canpar Settings `[carrier_name = canpar]`
@@ -92,9 +106,11 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | --- | --- | --- |
 | `username` | `str` | **required**
 | `password` | `str` | **required**
+| `language` | `str` | 
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### DHL Express Settings `[carrier_name = dhl_express]`
@@ -104,6 +120,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `site_id` | `str` | **required**
 | `password` | `str` | **required**
 | `account_number` | `str` | 
+| `account_country_code` | `str` | 
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
@@ -118,6 +135,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### Dicom Settings `[carrier_name = dicom]`
@@ -130,6 +148,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### FedEx Settings `[carrier_name = fedex]`
@@ -140,6 +159,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `password` | `str` | **required**
 | `meter_number` | `str` | **required**
 | `account_number` | `str` | **required**
+| `account_country_code` | `str` | 
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
@@ -157,6 +177,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### Royal Mail Settings `[carrier_name = royalmail]`
@@ -168,6 +189,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### Sendle Settings `[carrier_name = sendle]`
@@ -179,6 +201,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### SF-Express Settings `[carrier_name = sf_express]`
@@ -190,6 +213,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### TNT Settings `[carrier_name = tnt]`
@@ -213,6 +237,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `password` | `str` | **required**
 | `access_license_number` | `str` | **required**
 | `account_number` | `str` | 
+| `account_country_code` | `str` | 
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
@@ -230,6 +255,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### USPS International Settings `[carrier_name = usps_international]`
@@ -244,6 +270,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### Yanwen Settings `[carrier_name = yanwen]`
@@ -255,6 +282,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 #### Yunexpress Settings `[carrier_name = yunexpress]`
@@ -266,6 +294,7 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
 | `id` | `str` | 
 | `test` | `bool` | 
 | `carrier_id` | `str` | 
+| `account_country_code` | `str` | 
 
 
 !!! note ""
@@ -276,4 +305,4 @@ carrier_gateway = purplship.gateway["carrier_name"].create(...)
     | `carrier_name` | `str` | default: carrier name (eg: canadapost, purolator...)
     | `id` | `str` | 
     | `test` | `boolean` |
-
+    | `account_country_code` | `str` |