Py42

Removed

- The following methods from `py42.util`:
- `get_obj_from_response()`
- `filter_out_none()`
- `print_dict()`

- `py42.debug` module. Use `py42.settings.debug` instead.
- `py42.util` module. Use `py42.sdk.util` instead.
- `ArchiveModule.download_from_backup()`. Use `ArchiveModule.stream_from_backup()` instead.

Changed

All client methods now return a `Py42Response` object that simplifies accessing the most meaningful parts
of the returned JSON object.

Renamed methods to reduce redundancy:

- `SDK` > `SDKClient`
- `create_using_local_account()` > `from_local_account()`
- `administration` > `serveradmin`
- `legal_hold` > `legalhold`
- `storage` > `storageacess`
- `security` > `securitydata`
- `user_context` > `usercontext`
- `employee_case_management` > `detectionlists`

- `StorageClientFactory`
- `get_storage_client_from_device_guid()` > `from_device_guid()`
- `get_storage_client_from_plan_uid()` > `from_plan_info()`

- `StorageClient`
- `security` > `securitydata`

- `StorageSecurityClient`
- `get_security_detection_events_for_plan()` > `get_plan_security_events()`
- `get_security_detection_events_for_user()` > `get_user_security_events()`

- `FileEventClient`
- `search_file_events()` > `search()`

- `StorageArchiveClient`
- `search_archive()` > `search()`
- `get_archive_tree_node()` > `get_file_path_metadata()`
- `create_web_restore_session()` > `create_restore_session()`
- `submit_web_restore_job()` > `start_restore()`
- `get_web_restore_job()` > `get_restore_status()`
- `cancel_web_restore_job()` > `cancel_restore()`
- `get_web_restore_job_result()` > `stream_restore_result()`

- `DepartingEmployeeClient`
- `create_departing_employee()` > `create()`
- `resolve_departing_employee()` > `resolve()`
- `get_all_departing_employees()` > `get_all()`
- `get_case_by_username()` > `get_by_username()`
- `get_case_by_id()` > `get_by_id()`
- `update_case()` > `update()`

- `LegalHoldClient`
- `create_legal_hold()` > `create_matter()`
- `get_legal_hold_policy_by_uid()` > `get_policy_by_uid()`
- `get_all_legal_hold_policies()` > `get_all_policies()`
- `get_legal_hold_by_uid()` > `get_matter_by_uid()`
- `get_legal_holds()` > `get_all_matters()`
- `get_legal_hold_memberships()` > `get_all_matter_custodians()`
- `add_user_to_legal_hold()` > `add_to_matter()`
- `remove_user_from_legal_hold()` > `remove_from_matter()`
- `deactivate_legal_hold()` > `deactivate_matter()`
- `reactivate_legal_hold()` > `reactivate_matter()`
- `create_legal_hold_policy()` > `create_policy()`
- `create_legal_hold()` > `create_matter()`

- `AlertClient`
- `search_alerts()` > `search()`
- `resolve_alert()` > `resolve()`
- `reopen_alert()` > `reopen()`

- `OrgClient`
- `get_orgs()` > `get_all()`
- `get_org_by_id()` > `get_by_id()`
- `get_org_by_uid()` > `get_by_uid()`
- `block_org()` > `block()`
- `unblock_org()` > `unblock()`
- `deactivate_org()` > `deactivate()`
- `reactivate_org()` > `reactivate()`
- `get_current_user_org` > `get_current`

- `UserClient`
- `get_user_by_id()` > `get_by_id()`
- `get_user_by_uid()` > `get_by_uid()`
- `get_user_by_username()` > `get_by_username()`
- `get_current_user()` > `get_current()`
- `get_users()` > `get_all()`
- `block_user()` > `block()`
- `unblock_user()` > `unblock()`
- `deactivate_user()` > `deactivate()`
- `reactivate_user()` > `reactivate()`
- `change_user_org_assignment()` > `change_org_assignment()`

- `DeviceClient`
- `get_device_by_id()` > `get_by_id()`
- `get_device_by_guid()` > `get_by_guid()`
- `get_devices()` > `get_all()`
- `block_device()` > `block()`
- `unblock_device()` > `unblock()`
- `deactivate_device()` > `deactivate()`
- `reactivate_device()` > `reactivate()`
- `deauthorize_device()` > `deauthorize()`
- `get_device_settings()` > `get_settings()`

Fixed

Issue where large API responses were read very slowly.

Added

Support for querying file events by:
- DirectoryID
- EmailRecipients
- EmailSender
- FileCategory
- FileOwner
- ProcessOwner
- ProcessName
- RemovableMediaName
- Shared
- SharedWith
- SharingTypeAdded
- Source
- SyncDestination
- TabURL
- WindowTitle

Changed

- `py42.settings.items_per_page` no long affects `DepartingEmployeeClient.get_all_departing_employees()`, which is now always set at 100 items per page.
- `FileEventQuery` and `AlertQuery` objects will now return up to 10,000 results by default (the previous default value was 100).

Fixed

- Issue where `DepartingEmployeeClient.get_all_departing_employees()` always resulted in a 400 status code.

Added

- `py42.settings.items_per_page`. This effectively replaces `page_size` for the methods that were changed below.

Changed

The following resources no longer accept `page_num` and `page_size` parameters and no longer return a
`requests.Response` object:
- `UserClient.get_users()`
- `DeviceClient.get_devices()`
- `OrgClient.get_orgs()`
- `LegalHoldClient.get_legal_holds()`
- `LegalHoldClient.get_legal_hold_memberships()`
- `DepartingEmployeeClient.get_all_departing_employees()`

They instead return a generator object that is iterated over to retrieve all the pages, eliminating the need to
manually compose loops to retrieve each page. For example, the below snippet will retrieve all pages of users:

python
for page in users.get_users():
user_list = json.loads(page.text)["data"]["users"]

Added

- Support for querying file events by Actor.