Merge pull request #3 from mxenabled/bm/update_readme_and_categories

Update README and categories

Author: brettmortensen

README.md

@@ -14,12 +14,15 @@ Python >= 3.6
 
 ## Installation
 
-Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+Install the package using pip from PyPI by running:
+```shell
+pip install mx-platform-python
+```
 
+Or install it yourself with:
 ```shell
-python setup.py install --user
+python setup.py install
 ```
-(or `sudo python setup.py install` to install the package for all users)
 
 Then import the package:
 ```python

docs/MxPlatformApi.md

@@ -33,7 +33,8 @@ Method | HTTP request | Description
 [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member
 [**list_account_owners_by_member**](MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member
 [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories
-[**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories
+[**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /categories/default | List default categories
+[**list_default_categories_by_user**](MxPlatformApi.md#list_default_categories_by_user) | **GET** /users/{user_guid}/categories/default | List default categories by user
 [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions
 [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings
 [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member
@@ -58,7 +59,8 @@ Method | HTTP request | Description
 [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts
 [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users
 [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account
-[**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category
+[**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category
+[**read_default_category**](MxPlatformApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category
 [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding
 [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution
 [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account
@@ -2579,11 +2581,11 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **list_default_categories**
-> CategoriesResponseBody list_default_categories(user_guid)
+> CategoriesResponseBody list_default_categories()
 
 List default categories
 
-Use this endpoint to read the attributes of a specific user.
+Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
 
 ### Example
 
@@ -2616,26 +2618,107 @@ configuration = mx_platform_python.Configuration(
 with mx_platform_python.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = mx_platform_api.MxPlatformApi(api_client)
-    user_guid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54" # str | The unique id for a `user`.
     page = 1 # int | Specify current page. (optional)
     records_per_page = 10 # int | Specify records per page. (optional)
 
     # example passing only required values which don't have defaults set
+    # and optional values
     try:
         # List default categories
-        api_response = api_instance.list_default_categories(user_guid)
+        api_response = api_instance.list_default_categories(page=page, records_per_page=records_per_page)
         pprint(api_response)
     except mx_platform_python.ApiException as e:
         print("Exception when calling MxPlatformApi->list_default_categories: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **int**| Specify current page. | [optional]
+ **records_per_page** | **int**| Specify records per page. | [optional]
+
+### Return type
+
+[**CategoriesResponseBody**](CategoriesResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.mx.api.v1+json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **list_default_categories_by_user**
+> CategoriesResponseBody list_default_categories_by_user(user_guid)
+
+List default categories by user
+
+Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
+
+### Example
+
+* Basic Authentication (basicAuth):
+
+```python
+import time
+import mx_platform_python
+from mx_platform_python.api import mx_platform_api
+from mx_platform_python.model.categories_response_body import CategoriesResponseBody
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.mx.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = mx_platform_python.Configuration(
+    host = "https://api.mx.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: basicAuth
+configuration = mx_platform_python.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with mx_platform_python.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = mx_platform_api.MxPlatformApi(api_client)
+    user_guid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54" # str | The unique id for a `user`.
+    page = 1 # int | Specify current page. (optional)
+    records_per_page = 10 # int | Specify records per page. (optional)
+
+    # example passing only required values which don't have defaults set
+    try:
+        # List default categories by user
+        api_response = api_instance.list_default_categories_by_user(user_guid)
+        pprint(api_response)
+    except mx_platform_python.ApiException as e:
+        print("Exception when calling MxPlatformApi->list_default_categories_by_user: %s\n" % e)
 
     # example passing only required values which don't have defaults set
     # and optional values
     try:
-        # List default categories
-        api_response = api_instance.list_default_categories(user_guid, page=page, records_per_page=records_per_page)
+        # List default categories by user
+        api_response = api_instance.list_default_categories_by_user(user_guid, page=page, records_per_page=records_per_page)
         pprint(api_response)
     except mx_platform_python.ApiException as e:
-        print("Exception when calling MxPlatformApi->list_default_categories: %s\n" % e)
+        print("Exception when calling MxPlatformApi->list_default_categories_by_user: %s\n" % e)
 ```
 
 
@@ -4847,7 +4930,7 @@ Name | Type | Description  | Notes
 # **read_category**
 > CategoryResponseBody read_category(category_guid, user_guid)
 
-Read category
+Read a custom category
 
 Use this endpoint to read the attributes of either a default category or a custom category.
 
@@ -4887,14 +4970,94 @@ with mx_platform_python.ApiClient(configuration) as api_client:
 
     # example passing only required values which don't have defaults set
     try:
-        # Read category
+        # Read a custom category
         api_response = api_instance.read_category(category_guid, user_guid)
         pprint(api_response)
     except mx_platform_python.ApiException as e:
         print("Exception when calling MxPlatformApi->read_category: %s\n" % e)
 ```
 
 
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **category_guid** | **str**| The unique id for a `category`. |
+ **user_guid** | **str**| The unique id for a `user`. |
+
+### Return type
+
+[**CategoryResponseBody**](CategoryResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.mx.api.v1+json
+
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **read_default_category**
+> CategoryResponseBody read_default_category(category_guid, user_guid)
+
+Read a default category
+
+Use this endpoint to read the attributes of a default category.
+
+### Example
+
+* Basic Authentication (basicAuth):
+
+```python
+import time
+import mx_platform_python
+from mx_platform_python.api import mx_platform_api
+from mx_platform_python.model.category_response_body import CategoryResponseBody
+from pprint import pprint
+# Defining the host is optional and defaults to https://api.mx.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = mx_platform_python.Configuration(
+    host = "https://api.mx.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure HTTP basic authorization: basicAuth
+configuration = mx_platform_python.Configuration(
+    username = 'YOUR_USERNAME',
+    password = 'YOUR_PASSWORD'
+)
+
+# Enter a context with an instance of the API client
+with mx_platform_python.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = mx_platform_api.MxPlatformApi(api_client)
+    category_guid = "CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874" # str | The unique id for a `category`.
+    user_guid = "USR-fa7537f3-48aa-a683-a02a-b18940482f54" # str | The unique id for a `user`.
+
+    # example passing only required values which don't have defaults set
+    try:
+        # Read a default category
+        api_response = api_instance.read_default_category(category_guid, user_guid)
+        pprint(api_response)
+    except mx_platform_python.ApiException as e:
+        print("Exception when calling MxPlatformApi->read_default_category: %s\n" % e)
+```
+
+
 ### Parameters
 
 Name | Type | Description  | Notes

mx_platform_python/__init__.py

@@ -10,7 +10,7 @@
 """
 
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 
 # import ApiClient
 from mx_platform_python.api_client import ApiClient