feat: add new account management v4 api

Author: PureMathematics

examples/test_account_management_v4_examples.py

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+# (C) Copyright IBM Corp. 2021, 2022.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""
+Examples for AccountManagementV4
+"""
+
+import os
+import pytest
+from ibm_cloud_sdk_core import ApiException, read_external_sources
+from ibm_platform_services.account_management_v4 import *
+
+#
+# This file provides an example of how to use the Account Management service.
+#
+# The following configuration properties are assumed to be defined:
+#
+# ACCOUNT_MANAGEMENT_URL=<service url>
+# ACCOUNT_MANAGEMENT_AUTHTYPE=iam
+# ACCOUNT_MANAGEMENT_AUTH_URL=<IAM token service URL - omit this if using the production environment>
+# ACCOUNT_MANAGEMENT_APIKEY=<IAM apikey>
+# ACCOUNT_MANAGEMENT_ACCOUNT_ID=<account ID>
+
+# These configuration properties can be exported as environment variables, or stored
+# in a configuration file and then:
+# export IBM_CREDENTIALS_FILE=<name of configuration file>
+#
+
+config_file = 'account_management.env'
+
+account_management_service = None
+
+
+config = None
+
+account_id = None
+
+##############################################################################
+# Start of Examples for Service: AccountManagementV4
+##############################################################################
+# region
+class TestAccountManagementV4Examples:
+    """
+    Example Test Class for AccountManagementV4
+    """
+
+    @classmethod
+    def setup_class(cls):
+        global account_management_service
+        if os.path.exists(config_file):
+            os.environ['IBM_CREDENTIALS_FILE'] = config_file
+            # begin-common
+
+            account_management_service = AccountManagementV4.new_instance(
+                service_name='ACCOUNT_MANAGEMENT',
+            )
+            # end-common
+            assert account_management_service is not None
+
+            # Load the configuration
+            global config
+            config = read_external_sources(AccountManagementV4.DEFAULT_SERVICE_NAME)
+
+            global account_id
+            account_id = config['ACCOUNT_ID']
+        print('Setup complete.')
+
+    needscredentials = pytest.mark.skipif(
+        not os.path.exists(config_file), reason="External configuration not available, skipping..."
+    )
+
+    @needscredentials
+    def test_get_account_info_example(self):
+        """
+        test_get_account_info_example
+        """
+        assert account_id is not None
+
+        try:
+            print('\nget_account_info() result:')
+            # begin-get_account_info
+
+            account_info = account_management_service.get_account_info(
+                account_id=account_id,
+            ).get_result()
+
+            print(json.dumps(account_info, indent=2))
+
+            # end-get_account_info
+
+        except ApiException as e:
+            pytest.fail(str(e))
+

ibm_platform_services/account_management_v4.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+# (C) Copyright IBM Corp. 2026.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# IBM OpenAPI SDK Code Generator Version: 3.70.0-7df966bf-20230419-195904
+
+"""
+Manage the lifecycle of your users using Account Management APIs.
+
+API Version: 1.0
+"""
+
+from typing import Dict, List
+import json
+
+from ibm_cloud_sdk_core import BaseService, DetailedResponse, get_query_param
+from ibm_cloud_sdk_core.authenticators.authenticator import Authenticator
+from ibm_cloud_sdk_core.get_authenticator import get_authenticator_from_environment
+from ibm_cloud_sdk_core.utils import convert_model
+
+from .common import get_sdk_headers
+
+class AccountManagementV4(BaseService):
+    """The Account Management V4 service."""
+
+    DEFAULT_SERVICE_URL = 'https://accounts.cloud.ibm.com'
+    DEFAULT_SERVICE_NAME = 'account_management'
+
+    @classmethod
+    def new_instance(
+        cls,
+        service_name: str = DEFAULT_SERVICE_NAME,
+    ) -> 'AccountManagementV4':
+        """
+        Return a new client for the account management service using the specified
+               parameters and external configuration.
+        """
+        authenticator = get_authenticator_from_environment(service_name)
+        service = cls(authenticator)
+        service.configure_service(service_name)
+        return service
+
+    def __init__(
+        self,
+        authenticator: Authenticator = None,
+    ) -> None:
+        """
+        Construct a new client for the Account Management service.
+
+        :param Authenticator authenticator: The authenticator specifies the authentication mechanism.
+               Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
+               about initializing the authenticator of your choice.
+        """
+        BaseService.__init__(self, service_url=self.DEFAULT_SERVICE_URL, authenticator=authenticator)
+
+    #########################
+    # Accounts
+    #########################
+    def get_account_info(
+        self,
+        account_id: str,
+        **kwargs,
+    ) -> DetailedResponse:
+        """
+        Get account info.
+
+        Retrieve an account info by the account id in your account. You can use the
+        IAM service token or an account user token for authorization. To use this method, the
+        requesting user or service ID must have at least the viewer, editor, or
+        administrator role on the Account management service.
+
+        :param str account_id: The account ID of the specified account.
+        :param dict headers: A `dict` containing the request headers
+        :return: A `DetailedResponse` containing the result, headers and HTTP status code.
+        :rtype: DetailedResponse with `dict` result representing a `accountInfo` object
+        """
+
+        if not account_id:
+            raise ValueError('account_id must be provided')
+        headers = {}
+        sdk_headers = get_sdk_headers(
+            service_name=self.DEFAULT_SERVICE_NAME,
+            service_version='V4',
+            operation_id='get_account_info',
+        )
+        headers.update(sdk_headers)
+
+        if 'headers' in kwargs:
+            headers.update(kwargs.get('headers'))
+            del kwargs['headers']
+        headers['Accept'] = 'application/json'
+
+        path_param_keys = ['account_id']
+        path_param_values = self.encode_path_vars(account_id)
+        path_param_dict = dict(zip(path_param_keys, path_param_values))
+        url = '/v4/accounts/{account_id}'.format(**path_param_dict)
+        request = self.prepare_request(
+            method='GET',
+            url=url,
+            headers=headers,
+        )
+
+        response = self.send(request, **kwargs)
+        return response