From cf09f12b6e1e0725ca52c4746aa2bb066b331782 Mon Sep 17 00:00:00 2001 From: Anurag Sharma Date: Sat, 27 Jan 2024 23:33:02 +0530 Subject: [PATCH] Documentation Update and Version Bump (#153) Supplemental changes to previous PR merged to v2 branch. --- CHANGELOG.md | 6 +++ docs/clients/admin/admin_client.md | 45 +++++++++++++++++++ docs/clients/mrscaler/mrscaler_aws_client.md | 1 + docs/clients/ocean/ocean_aws_client.md | 1 + .../subscription/subscription_client.md | 1 + spotinst_sdk2/version.py | 2 +- 6 files changed, 55 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4dd26d1..54a301ee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [2.4.0] - 2024-01-27 +### Added +- Added new functions in admin client. +### Fixed +- Typos. + ## [2.3.2] - 2024-01-12 ### Added - Added `caching` field in Azure Stateful Node `OsDisk` and `DataDisk` model. diff --git a/docs/clients/admin/admin_client.md b/docs/clients/admin/admin_client.md index c5bb72e8..1ca8e501 100644 --- a/docs/clients/admin/admin_client.md +++ b/docs/clients/admin/admin_client.md @@ -222,3 +222,48 @@ __Arguments__ __Returns__ `(Object)`: Spotinst API response + +

get_users

+ +```python +AdminClient.get_users() +``` + +Retrieves all users from an organization. + +__Returns__ + +`(Object)`: Spotinst API response + +

get_user_details

+ +```python +AdminClient.get_user_details(user_id) +``` + +Retrieves an individual user details. + +__Arguments__ + +- __user_id (String)__: User ID + +__Returns__ + +`(Object)`: Spotinst API response + +

delete_user

+ +```python +AdminClient.delete_user(user_id) +``` + +Deletes a user from an organization. + +__Arguments__ + +- __user_id (String)__: User ID + +__Returns__ + +`(Object)`: Spotinst API response + diff --git a/docs/clients/mrscaler/mrscaler_aws_client.md b/docs/clients/mrscaler/mrscaler_aws_client.md index 666d16eb..a22cb420 100644 --- a/docs/clients/mrscaler/mrscaler_aws_client.md +++ b/docs/clients/mrscaler/mrscaler_aws_client.md @@ -169,3 +169,4 @@ __Arguments__ __Returns__ `(Object)`: Elastigroup API response + diff --git a/docs/clients/ocean/ocean_aws_client.md b/docs/clients/ocean/ocean_aws_client.md index 1f275883..c6cfb306 100644 --- a/docs/clients/ocean/ocean_aws_client.md +++ b/docs/clients/ocean/ocean_aws_client.md @@ -745,3 +745,4 @@ __Arguments__ __Returns__ `(Object)`: Ocean Delete Extended Resource Definition response + diff --git a/docs/clients/subscription/subscription_client.md b/docs/clients/subscription/subscription_client.md index 59977a7e..89ac75e1 100644 --- a/docs/clients/subscription/subscription_client.md +++ b/docs/clients/subscription/subscription_client.md @@ -86,3 +86,4 @@ __Arguments__ __Returns__ `(Object)`: subscription response + diff --git a/spotinst_sdk2/version.py b/spotinst_sdk2/version.py index 96deb04f..ba9b9133 100644 --- a/spotinst_sdk2/version.py +++ b/spotinst_sdk2/version.py @@ -1 +1 @@ -__version__ = '2.3.2' +__version__ = '2.4.0'