Merge branch 'main' of github.com:infobloxopen/bloxone-python-client …

…into revamp_docs_and_tests

src/.openapi-generator/FILES

@@ -1,63 +1,76 @@
-cloud_discovery/README.md
-cloud_discovery/__init__.py
-cloud_discovery/api/__init__.py
-cloud_discovery/api/accounts_api.py
-cloud_discovery/api/providers_api.py
-cloud_discovery/api/sub_accounts_api.py
-cloud_discovery/docs/Account.md
-cloud_discovery/docs/AccountListResponse.md
-cloud_discovery/docs/AccountsApi.md
-cloud_discovery/docs/AdditionalConfig.md
-cloud_discovery/docs/ApiPageInfo.md
-cloud_discovery/docs/Category.md
-cloud_discovery/docs/CredentialConfig.md
-cloud_discovery/docs/CredentialPreference.md
-cloud_discovery/docs/DNSConfig.md
-cloud_discovery/docs/Destination.md
-cloud_discovery/docs/DestinationConfig.md
-cloud_discovery/docs/DiscoveryConfig.md
-cloud_discovery/docs/IPAMConfig.md
-cloud_discovery/docs/Object.md
-cloud_discovery/docs/ObjectType.md
-cloud_discovery/docs/ProviderCreateResponse.md
-cloud_discovery/docs/ProviderListResponse.md
-cloud_discovery/docs/ProviderReadResponse.md
-cloud_discovery/docs/ProviderUpdateResponse.md
-cloud_discovery/docs/ProvidersApi.md
-cloud_discovery/docs/Resource.md
-cloud_discovery/docs/SourceConfig.md
-cloud_discovery/docs/SubAccountListRequestV2.md
-cloud_discovery/docs/SubAccountListResponseV2.md
-cloud_discovery/docs/SubAccountProvCredConfig.md
-cloud_discovery/docs/SubAccountV2.md
-cloud_discovery/docs/SubAccountsApi.md
-cloud_discovery/models/__init__.py
-cloud_discovery/models/account.py
-cloud_discovery/models/account_list_response.py
-cloud_discovery/models/additional_config.py
-cloud_discovery/models/api_page_info.py
-cloud_discovery/models/category.py
-cloud_discovery/models/credential_config.py
-cloud_discovery/models/credential_preference.py
-cloud_discovery/models/destination.py
-cloud_discovery/models/destination_config.py
-cloud_discovery/models/discovery_config.py
-cloud_discovery/models/dns_config.py
-cloud_discovery/models/ipam_config.py
-cloud_discovery/models/object.py
-cloud_discovery/models/object_type.py
-cloud_discovery/models/provider_create_response.py
-cloud_discovery/models/provider_list_response.py
-cloud_discovery/models/provider_read_response.py
-cloud_discovery/models/provider_update_response.py
-cloud_discovery/models/resource.py
-cloud_discovery/models/source_config.py
-cloud_discovery/models/sub_account_list_request_v2.py
-cloud_discovery/models/sub_account_list_response_v2.py
-cloud_discovery/models/sub_account_prov_cred_config.py
-cloud_discovery/models/sub_account_v2.py
-cloud_discovery/py.typed
-cloud_discovery/test/__init__.py
-cloud_discovery/test/test_accounts_api.py
-cloud_discovery/test/test_providers_api.py
-cloud_discovery/test/test_sub_accounts_api.py
+ipam_federation/README.md
+ipam_federation/__init__.py
+ipam_federation/api/__init__.py
+ipam_federation/api/federated_block_api.py
+ipam_federation/api/federated_realm_api.py
+ipam_federation/api/next_available_federated_block_api.py
+ipam_federation/api/next_available_overlapping_block_api.py
+ipam_federation/api/next_available_reserved_block_api.py
+ipam_federation/api/overlapping_block_api.py
+ipam_federation/api/reserved_block_api.py
+ipam_federation/docs/Allocation.md
+ipam_federation/docs/CreateFederatedBlockResponse.md
+ipam_federation/docs/CreateFederatedRealmResponse.md
+ipam_federation/docs/CreateNextAvailableFederatedBlockResponse.md
+ipam_federation/docs/CreateNextAvailableOverlappingBlockResponse.md
+ipam_federation/docs/CreateNextAvailableReservedBlockResponse.md
+ipam_federation/docs/CreateOverlappingBlockResponse.md
+ipam_federation/docs/CreateReservedBlockResponse.md
+ipam_federation/docs/FederatedBlock.md
+ipam_federation/docs/FederatedBlockApi.md
+ipam_federation/docs/FederatedRealm.md
+ipam_federation/docs/FederatedRealmApi.md
+ipam_federation/docs/ListFederatedBlockResponse.md
+ipam_federation/docs/ListFederatedRealmResponse.md
+ipam_federation/docs/ListNextAvailableFederatedBlockResponse.md
+ipam_federation/docs/ListNextAvailableOverlappingBlockResponse.md
+ipam_federation/docs/ListNextAvailableReservedBlockResponse.md
+ipam_federation/docs/ListOverlappingBlockResponse.md
+ipam_federation/docs/ListReservedBlockResponse.md
+ipam_federation/docs/NextAvailableBlockRequest.md
+ipam_federation/docs/NextAvailableFederatedBlockApi.md
+ipam_federation/docs/NextAvailableOverlappingBlockApi.md
+ipam_federation/docs/NextAvailableReservedBlockApi.md
+ipam_federation/docs/OverlappingBlock.md
+ipam_federation/docs/OverlappingBlockApi.md
+ipam_federation/docs/ReadFederatedBlockResponse.md
+ipam_federation/docs/ReadFederatedRealmResponse.md
+ipam_federation/docs/ReadOverlappingBlockResponse.md
+ipam_federation/docs/ReadReservedBlockResponse.md
+ipam_federation/docs/ReservedBlock.md
+ipam_federation/docs/ReservedBlockApi.md
+ipam_federation/docs/UpdateFederatedBlockResponse.md
+ipam_federation/docs/UpdateFederatedRealmResponse.md
+ipam_federation/docs/UpdateOverlappingBlockResponse.md
+ipam_federation/docs/UpdateReservedBlockResponse.md
+ipam_federation/models/__init__.py
+ipam_federation/models/allocation.py
+ipam_federation/models/create_federated_block_response.py
+ipam_federation/models/create_federated_realm_response.py
+ipam_federation/models/create_next_available_federated_block_response.py
+ipam_federation/models/create_next_available_overlapping_block_response.py
+ipam_federation/models/create_next_available_reserved_block_response.py
+ipam_federation/models/create_overlapping_block_response.py
+ipam_federation/models/create_reserved_block_response.py
+ipam_federation/models/federated_block.py
+ipam_federation/models/federated_realm.py
+ipam_federation/models/list_federated_block_response.py
+ipam_federation/models/list_federated_realm_response.py
+ipam_federation/models/list_next_available_federated_block_response.py
+ipam_federation/models/list_next_available_overlapping_block_response.py
+ipam_federation/models/list_next_available_reserved_block_response.py
+ipam_federation/models/list_overlapping_block_response.py
+ipam_federation/models/list_reserved_block_response.py
+ipam_federation/models/next_available_block_request.py
+ipam_federation/models/overlapping_block.py
+ipam_federation/models/read_federated_block_response.py
+ipam_federation/models/read_federated_realm_response.py
+ipam_federation/models/read_overlapping_block_response.py
+ipam_federation/models/read_reserved_block_response.py
+ipam_federation/models/reserved_block.py
+ipam_federation/models/update_federated_block_response.py
+ipam_federation/models/update_federated_realm_response.py
+ipam_federation/models/update_overlapping_block_response.py
+ipam_federation/models/update_reserved_block_response.py
+ipam_federation/py.typed
+ipam_federation/test/__init__.py

src/ipam_federation/README.md

@@ -0,0 +1,148 @@
+# ipam-federation
+The DDI IPAM Federation application enables a SaaS administrator to manage multiple IPAM systems from one central control point CSP.    
+
+The `ipam_federation` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v1
+- Package version: 0.1.0
+- Generator version: 7.5.0
+- Build package: com.infoblox.codegen.BloxonePythonClientCodegen
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+
+This python library package is generated without supporting files like setup.py or requirements files
+
+To be able to use it, you will need these dependencies in your own package that uses this library:
+
+* urllib3 >= 1.25.3
+* python-dateutil
+* pydantic
+
+## Getting Started
+
+In your own code, to use this library to connect and interact with ipam-federation,
+you can run the following:
+
+```python
+
+import ipam_federation
+from ipam_federation.rest import ApiException
+from pprint import pprint
+
+# Defining the CSP URL is optional and defaults to "https://csp.infoblox.com"
+# See configuration.py for a list of all supported configuration parameters.
+configuration = Configuration(
+    csp_url = os.getenv('BLOXONE_CSP_URL'),
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key = os.getenv("BLOXONE_API_KEY")
+
+
+# Enter a context with an instance of the API client
+with ipam_federation.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = ipam_federation.FederatedBlockApi(api_client)
+    body = ipam_federation.FederatedBlock() # FederatedBlock | 
+
+    try:
+        # Create the federated block.
+        api_response = api_instance.create(body)
+        print("The response of FederatedBlockApi->create:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling FederatedBlockApi->create: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://csp.infoblox.com/api/ddi/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*FederatedBlockApi* | [**create**](ipam_federation/docs/FederatedBlockApi.md#create) | **POST** /federation/federated_block | Create the federated block.
+*FederatedBlockApi* | [**delete**](ipam_federation/docs/FederatedBlockApi.md#delete) | **DELETE** /federation/federated_block/{id} | Delete the federated block.
+*FederatedBlockApi* | [**list**](ipam_federation/docs/FederatedBlockApi.md#list) | **GET** /federation/federated_block | Retrieve the federated blocks.
+*FederatedBlockApi* | [**read**](ipam_federation/docs/FederatedBlockApi.md#read) | **GET** /federation/federated_block/{id} | Retrieve the federated block.
+*FederatedBlockApi* | [**update**](ipam_federation/docs/FederatedBlockApi.md#update) | **PATCH** /federation/federated_block/{id} | Update the federated block.
+*FederatedRealmApi* | [**create**](ipam_federation/docs/FederatedRealmApi.md#create) | **POST** /federation/federated_realm | Create the federated realm.
+*FederatedRealmApi* | [**delete**](ipam_federation/docs/FederatedRealmApi.md#delete) | **DELETE** /federation/federated_realm/{id} | Delete federated realm.
+*FederatedRealmApi* | [**list**](ipam_federation/docs/FederatedRealmApi.md#list) | **GET** /federation/federated_realm | Retrieve federated realms.
+*FederatedRealmApi* | [**read**](ipam_federation/docs/FederatedRealmApi.md#read) | **GET** /federation/federated_realm/{id} | Retrieve the federated realm.
+*FederatedRealmApi* | [**update**](ipam_federation/docs/FederatedRealmApi.md#update) | **PATCH** /federation/federated_realm/{id} | Update the federated realm.
+*NextAvailableFederatedBlockApi* | [**create_next_available_federated_blocks**](ipam_federation/docs/NextAvailableFederatedBlockApi.md#create_next_available_federated_blocks) | **POST** /federation/federated_block/{id}/next_available_federated_block | Retrieve the next available federated block.
+*NextAvailableFederatedBlockApi* | [**create_next_available_overlapping_blocks**](ipam_federation/docs/NextAvailableFederatedBlockApi.md#create_next_available_overlapping_blocks) | **POST** /federation/federated_block/{id}/next_available_overlapping_block | Retrieve the next available overlapping block.
+*NextAvailableFederatedBlockApi* | [**create_next_available_reserved_blocks**](ipam_federation/docs/NextAvailableFederatedBlockApi.md#create_next_available_reserved_blocks) | **POST** /federation/federated_block/{id}/next_available_reserved_block | Retrieve the next available reserved block.
+*NextAvailableFederatedBlockApi* | [**list_next_available_federated_blocks**](ipam_federation/docs/NextAvailableFederatedBlockApi.md#list_next_available_federated_blocks) | **GET** /federation/federated_block/{id}/next_available_federated_block | List the next available federated block.
+*NextAvailableOverlappingBlockApi* | [**list_next_available_overlapping_blocks**](ipam_federation/docs/NextAvailableOverlappingBlockApi.md#list_next_available_overlapping_blocks) | **GET** /federation/federated_block/{id}/next_available_overlapping_block | List the next available overlapping block.
+*NextAvailableReservedBlockApi* | [**list_next_available_reserved_blocks**](ipam_federation/docs/NextAvailableReservedBlockApi.md#list_next_available_reserved_blocks) | **GET** /federation/federated_block/{id}/next_available_reserved_block | List the next available reserved block.
+*OverlappingBlockApi* | [**create**](ipam_federation/docs/OverlappingBlockApi.md#create) | **POST** /federation/overlapping_block | Create the overlapping block.
+*OverlappingBlockApi* | [**delete**](ipam_federation/docs/OverlappingBlockApi.md#delete) | **DELETE** /federation/overlapping_block/{id} | Delete the overlapping block.
+*OverlappingBlockApi* | [**list**](ipam_federation/docs/OverlappingBlockApi.md#list) | **GET** /federation/overlapping_block | Retrieve the overlapping block.
+*OverlappingBlockApi* | [**read**](ipam_federation/docs/OverlappingBlockApi.md#read) | **GET** /federation/overlapping_block/{id} | Retrieve the overlapping block.
+*OverlappingBlockApi* | [**update**](ipam_federation/docs/OverlappingBlockApi.md#update) | **PATCH** /federation/overlapping_block/{id} | Update the overlapping block.
+*ReservedBlockApi* | [**create**](ipam_federation/docs/ReservedBlockApi.md#create) | **POST** /federation/reserved_block | Create the reserved block.
+*ReservedBlockApi* | [**delete**](ipam_federation/docs/ReservedBlockApi.md#delete) | **DELETE** /federation/reserved_block/{id} | Delete the reserved block.
+*ReservedBlockApi* | [**list**](ipam_federation/docs/ReservedBlockApi.md#list) | **GET** /federation/reserved_block | Retrieve the reserved block.
+*ReservedBlockApi* | [**read**](ipam_federation/docs/ReservedBlockApi.md#read) | **GET** /federation/reserved_block/{id} | Retrieve the reserved block.
+*ReservedBlockApi* | [**update**](ipam_federation/docs/ReservedBlockApi.md#update) | **PATCH** /federation/reserved_block/{id} | Update the reserved block.
+
+
+## Documentation For Models
+
+ - [Allocation](ipam_federation/docs/Allocation.md)
+ - [CreateFederatedBlockResponse](ipam_federation/docs/CreateFederatedBlockResponse.md)
+ - [CreateFederatedRealmResponse](ipam_federation/docs/CreateFederatedRealmResponse.md)
+ - [CreateNextAvailableFederatedBlockResponse](ipam_federation/docs/CreateNextAvailableFederatedBlockResponse.md)
+ - [CreateNextAvailableOverlappingBlockResponse](ipam_federation/docs/CreateNextAvailableOverlappingBlockResponse.md)
+ - [CreateNextAvailableReservedBlockResponse](ipam_federation/docs/CreateNextAvailableReservedBlockResponse.md)
+ - [CreateOverlappingBlockResponse](ipam_federation/docs/CreateOverlappingBlockResponse.md)
+ - [CreateReservedBlockResponse](ipam_federation/docs/CreateReservedBlockResponse.md)
+ - [FederatedBlock](ipam_federation/docs/FederatedBlock.md)
+ - [FederatedRealm](ipam_federation/docs/FederatedRealm.md)
+ - [ListFederatedBlockResponse](ipam_federation/docs/ListFederatedBlockResponse.md)
+ - [ListFederatedRealmResponse](ipam_federation/docs/ListFederatedRealmResponse.md)
+ - [ListNextAvailableFederatedBlockResponse](ipam_federation/docs/ListNextAvailableFederatedBlockResponse.md)
+ - [ListNextAvailableOverlappingBlockResponse](ipam_federation/docs/ListNextAvailableOverlappingBlockResponse.md)
+ - [ListNextAvailableReservedBlockResponse](ipam_federation/docs/ListNextAvailableReservedBlockResponse.md)
+ - [ListOverlappingBlockResponse](ipam_federation/docs/ListOverlappingBlockResponse.md)
+ - [ListReservedBlockResponse](ipam_federation/docs/ListReservedBlockResponse.md)
+ - [NextAvailableBlockRequest](ipam_federation/docs/NextAvailableBlockRequest.md)
+ - [OverlappingBlock](ipam_federation/docs/OverlappingBlock.md)
+ - [ReadFederatedBlockResponse](ipam_federation/docs/ReadFederatedBlockResponse.md)
+ - [ReadFederatedRealmResponse](ipam_federation/docs/ReadFederatedRealmResponse.md)
+ - [ReadOverlappingBlockResponse](ipam_federation/docs/ReadOverlappingBlockResponse.md)
+ - [ReadReservedBlockResponse](ipam_federation/docs/ReadReservedBlockResponse.md)
+ - [ReservedBlock](ipam_federation/docs/ReservedBlock.md)
+ - [UpdateFederatedBlockResponse](ipam_federation/docs/UpdateFederatedBlockResponse.md)
+ - [UpdateFederatedRealmResponse](ipam_federation/docs/UpdateFederatedRealmResponse.md)
+ - [UpdateOverlappingBlockResponse](ipam_federation/docs/UpdateOverlappingBlockResponse.md)
+ - [UpdateReservedBlockResponse](ipam_federation/docs/UpdateReservedBlockResponse.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="ApiKeyAuth"></a>
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+
+## Author
+
+
+
+

src/ipam_federation/__init__.py

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    IPAM Federation API
+
+    The DDI IPAM Federation application enables a SaaS administrator to manage multiple IPAM systems from one central control point CSP.    
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+__version__ = "0.1.0"
+
+# import apis into sdk package
+from ipam_federation.api.federated_block_api import FederatedBlockApi
+from ipam_federation.api.federated_realm_api import FederatedRealmApi
+from ipam_federation.api.next_available_federated_block_api import NextAvailableFederatedBlockApi
+from ipam_federation.api.next_available_overlapping_block_api import NextAvailableOverlappingBlockApi
+from ipam_federation.api.next_available_reserved_block_api import NextAvailableReservedBlockApi
+from ipam_federation.api.overlapping_block_api import OverlappingBlockApi
+from ipam_federation.api.reserved_block_api import ReservedBlockApi
+
+# import models into sdk package
+from ipam_federation.models.allocation import Allocation
+from ipam_federation.models.create_federated_block_response import CreateFederatedBlockResponse
+from ipam_federation.models.create_federated_realm_response import CreateFederatedRealmResponse
+from ipam_federation.models.create_next_available_federated_block_response import CreateNextAvailableFederatedBlockResponse
+from ipam_federation.models.create_next_available_overlapping_block_response import CreateNextAvailableOverlappingBlockResponse
+from ipam_federation.models.create_next_available_reserved_block_response import CreateNextAvailableReservedBlockResponse
+from ipam_federation.models.create_overlapping_block_response import CreateOverlappingBlockResponse
+from ipam_federation.models.create_reserved_block_response import CreateReservedBlockResponse
+from ipam_federation.models.federated_block import FederatedBlock
+from ipam_federation.models.federated_realm import FederatedRealm
+from ipam_federation.models.list_federated_block_response import ListFederatedBlockResponse
+from ipam_federation.models.list_federated_realm_response import ListFederatedRealmResponse
+from ipam_federation.models.list_next_available_federated_block_response import ListNextAvailableFederatedBlockResponse
+from ipam_federation.models.list_next_available_overlapping_block_response import ListNextAvailableOverlappingBlockResponse
+from ipam_federation.models.list_next_available_reserved_block_response import ListNextAvailableReservedBlockResponse
+from ipam_federation.models.list_overlapping_block_response import ListOverlappingBlockResponse
+from ipam_federation.models.list_reserved_block_response import ListReservedBlockResponse
+from ipam_federation.models.next_available_block_request import NextAvailableBlockRequest
+from ipam_federation.models.overlapping_block import OverlappingBlock
+from ipam_federation.models.read_federated_block_response import ReadFederatedBlockResponse
+from ipam_federation.models.read_federated_realm_response import ReadFederatedRealmResponse
+from ipam_federation.models.read_overlapping_block_response import ReadOverlappingBlockResponse
+from ipam_federation.models.read_reserved_block_response import ReadReservedBlockResponse
+from ipam_federation.models.reserved_block import ReservedBlock
+from ipam_federation.models.update_federated_block_response import UpdateFederatedBlockResponse
+from ipam_federation.models.update_federated_realm_response import UpdateFederatedRealmResponse
+from ipam_federation.models.update_overlapping_block_response import UpdateOverlappingBlockResponse
+from ipam_federation.models.update_reserved_block_response import UpdateReservedBlockResponse