Merge pull request #226 from cisco-en-programmability/develop

Develop

Author: bvargasre

.gitignore

@@ -129,6 +129,7 @@ dmypy.json
 # Custom
 test.py
 sdkdiffgeneratorforreview.py
+verify_function_and_alias.py
 
 # Code
 .vscode/

CHANGELOG.md

@@ -6,6 +6,95 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.10.4] - 2025-07-30
+### Added
+- **Ansible Compatibility Aliases (v3.1.3.0)**: Added 46 backward compatibility alias functions to support Ansible modules and legacy code. These aliases map old function names to their current implementations:
+  - **application_policy.py** (4 alias):
+    - `create_application_sets_v2` → `create_application_sets`
+    - `create_applications_v2` → `create_applications`
+    - `edit_applications_v2` → `edit_applications`
+    - `get_application_count_v2` → `get_application_count`
+  - **site_design.py** (19 alias):
+    - `add_planned_access_points_positions_v2` → `add_planned_access_points_positions`
+    - `assign_planned_access_points_to_operations_ones_v2` → `assign_planned_access_points_to_operations_ones`
+    - `creates_a_building_v2` → `creates_a_building`
+    - `creates_a_floor_v2` → `creates_a_floor`
+    - `delete_planned_access_points_position_v2` → `delete_planned_access_points_position`
+    - `deletes_a_building_v2` → `deletes_a_building`
+    - `deletes_a_floor_v2` → `deletes_a_floor`
+    - `edit_planned_access_points_positions_v2` → `edit_planned_access_points_positions`
+    - `edit_the_access_points_positions_v2` → `edit_the_access_points_positions`
+    - `get_access_points_positions_count_v2` → `get_access_points_positions_count`
+    - `get_access_points_positions_v2` → `get_access_points_positions`
+    - `get_floor_settings_v2` → `get_floor_settings`
+    - `get_planned_access_points_positions_count_v2` → `get_planned_access_points_positions_count`
+    - `get_planned_access_points_positions_v2` → `get_planned_access_points_positions`
+    - `gets_a_building_v2` → `gets_a_building`
+    - `gets_a_floor_v2` → `gets_a_floor`
+    - `updates_a_building_v2` → `updates_a_building`
+    - `updates_a_floor_v2` → `updates_a_floor`
+    - `uploads_floor_image_v2` → `uploads_floor_image`
+  - **discovery.py** (3 alias):
+    - `create_global_credentials_v2` → `create_global_credentials`
+    - `get_all_global_credentials_v2` → `get_all_global_credentials`
+    - `delete_global_credential_v2` → `delete_global_credential`
+  - **devices.py** (4 alias):
+    - `get_device_interface_stats_info_v2` → `get_device_interface_stats_info`
+    - `the_total_interfaces_count_across_the_network_devices` → `get_total_interfaces_count_across_the_network_devices`
+    - `the_trend_analytcis_data_for_the_interfaces_in_the_specified_time_range` → `get_trend_analytics_data_for_the_interfaces_in_the_specified_time_range`
+    - `the_trend_analytics_data_for_the_network_device_in_the_specified_time_range` → `get_trend_analytics_data_for_the_network_device_in_the_specified_time_range`
+  - **configuration_templates.py** (1 alias):
+    - `get_projects_details_v2` → `get_projects_details`
+  - **sda.py** (3 alias):
+    - `the_trend_analytics_data_for_a_fabric_site_in_the_specified_time_range` → `get_trend_analytics_data_for_a_fabric_site_in_the_specified_time_range`
+    - `the_trend_analytics_data_for_a_transit_network_in_the_specified_time_range` → `get_trend_analytics_data_for_a_transit_network_in_the_specified_time_range`
+    - `the_trend_analytics_data_for_a_virtual_network_in_the_specified_time_range` → `get_trend_analytics_data_for_a_virtual_network_in_the_specified_time_range`
+  - **industrial_configuration.py** (11 alias):
+    - `configure_a_r_e_p_ring_on_f_a_b_r_i_c_deployment` → `configure_rep_ring_on_fabric_deployment`
+    - `configure_a_r_e_p_ring_on_n_o_n_f_a_b_r_i_c_deployment` → `configure_rep_ring_on_non_fabric_deployment`
+    - `delete_r_e_p_ring_configured_in_the_f_a_b_r_i_c_deployment` → `delete_rep_ring_configured_in_the_fabric_deployment`
+    - `delete_r_e_p_ring_configured_in_the_n_o_n_f_a_b_r_i_c_deployment` → `delete_rep_ring_configured_in_the_non_fabric_deployment`
+    - `get_the_r_e_p_ring_based_on_the_ring_id` → `get_the_rep_ring_based_on_the_ring_id`
+    - `retrieves_the_count_of_m_r_p_ring_members` → `retrieves_the_count_of_mrp_ring_members`
+    - `retrieves_the_count_of_r_e_p_rings` → `retrieves_the_count_of_rep_rings`
+    - `retrieves_the_list_of_m_r_p_rings` → `retrieves_the_list_of_mrp_rings`
+    - `retrieves_the_list_of_network_devices_part_of_m_r_p_ring` → `retrieves_the_list_of_network_devices_part_of_mrp_ring`
+    - `retrieves_the_list_of_r_e_p_rings` → `retrieves_the_list_of_rep_rings`
+  - **device_onboarding_pnp.py** (1 alias):
+    - `un_claim_device` → `unclaim_device`
+  - **applications.py** (1 alias):
+    - `the_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range` → `get_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range`
+
+### Fixed
+- **Function Name Corrections (v3.1.3.0)**: Fixed multiple incorrectly named functions across several API modules to follow proper Python naming conventions and match their actual functionality:
+  - **industrial_configuration.py**: Corrected REP (Resilient Ethernet Protocol) ring function names:
+    - `configure_are_p_ring_on_fabric_deployment` → `configure_rep_ring_on_fabric_deployment`
+    - `configure_are_p_ring_on_non_fabric_deployment` → `configure_rep_ring_on_non_fabric_deployment`
+    - `delete_are_p_ring_configured_in_the_fabric_deployment` → `delete_rep_ring_configured_in_the_fabric_deployment`
+    - `delete_are_p_ring_configured_in_the_non_fabric_deployment` → `delete_rep_ring_configured_in_the_non_fabric_deployment`
+    - `retrieves_the_list_of_are_p_rings` → `retrieves_the_list_of_rep_rings`
+    - `retrieves_the_count_of_are_p_rings` → `retrieves_the_count_of_rep_rings`
+    - `get_the_are_p_ring_based_on_the_ring_id` → `get_the_rep_ring_based_on_the_ring_id`
+  - **user_and_roles.py**: Corrected class name:
+    - `UserandRoles` → `UserAndRoles` (improved word separation)
+  - **device_onboarding_pnp.py**: Fixed function naming:
+    - `un_claim_device` → `unclaim_device` (removed unnecessary underscore)
+  - **sda.py**: Corrected trend analytics function names:
+    - `the_trend_analytics_data_for_a_fabric_site_in_the_specified_time_range` → `get_trend_analytics_data_for_a_fabric_site_in_the_specified_time_range`
+    - `the_trend_analytics_data_for_a_transit_network_in_the_specified_time_range` → `get_trend_analytics_data_for_a_transit_network_in_the_specified_time_range`
+    - `the_trend_analytics_data_for_a_virtual_network_in_the_specified_time_range` → `get_trend_analytics_data_for_a_virtual_network_in_the_specified_time_range`
+  - **devices.py**: Fixed trend analytics and interface functions:
+    - `the_total_interfaces_count_across_the_network_devices` → `get_total_interfaces_count_across_the_network_devices`
+    - `the_trend_analytcis_data_for_the_interfaces_in_the_specified_time_range` → `get_trend_analytics_data_for_the_interfaces_in_the_specified_time_range` (also fixed typo "analytcis" → "analytics")
+    - `the_trend_analytics_data_for_the_network_device_in_the_specified_time_range` → `get_trend_analytics_data_for_the_network_device_in_the_specified_time_range`
+  - **applications.py**: Fixed trend analytics function:
+    - `the_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range` → `get_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range`
+
+### Changed
+- **Backward Compatibility**: Added alias functions for all corrected function and class names to maintain backward compatibility. Existing code using the old function names will continue to work without modification.
+- **Naming Conventions**: All corrected functions now follow proper Python naming conventions with clear, descriptive names that better reflect their functionality.
+- **Documentation Consistency**: Function names now properly align with their respective API documentation and operation IDs.
+
 ## [2.10.3] - 2025-07-29
 ### Fixed
 - Fixed `download_masked_device_configuration` function in both v2.3.7.9 and v3.1.3.0 by adding `stream=True` parameter and additional download parameters (`dirpath`, `save_file`, `filename`) to properly handle file downloads, prevent JSONDecodeError, and maintain consistency with other download functions in the SDK
@@ -723,4 +812,5 @@ respond with a binary.
 [2.10.1]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.10.0...v2.10.1
 [2.10.2]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.10.1...v2.10.2
 [2.10.3]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.10.2...v2.10.3
-[Unreleased]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.10.3...develop
+[2.10.4]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.10.3...v2.10.4
+[Unreleased]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.10.4...develop

README.rst

@@ -175,7 +175,7 @@ Compatibility Matrix
    * - 2.3.7.9
      - 2.8.14
    * - 3.1.3.0
-     - 2.10.3
+     - 2.10.4
 
 Documentation
 -------------

dnacentersdk/api/v3_1_3_0/application_policy.py

@@ -2636,3 +2636,8 @@ def delete_application_v2(self, id, headers=None, **request_parameters):
 
 
 # Alias Functions
+# Aliases for v2 functions that were renamed without v2 suffix when v1 doesn't exist Ansible
+ApplicationPolicy.create_application_sets_v2 = ApplicationPolicy.create_application_sets
+ApplicationPolicy.create_applications_v2 = ApplicationPolicy.create_applications
+ApplicationPolicy.edit_applications_v2 = ApplicationPolicy.edit_applications
+ApplicationPolicy.get_application_count_v2 = ApplicationPolicy.get_application_count

dnacentersdk/api/v3_1_3_0/applications.py

@@ -849,7 +849,7 @@ def retrieves_the_total_count_of_thousand_eyes_test_results(
             "bpm_ef366ca484355d15937dd851a67c88e3_v3_1_3_0", json_data
         )
 
-    def the_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range(
+    def get_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range(
         self,
         agent_id=None,
         end_time=None,
@@ -1078,3 +1078,5 @@ def applications(
 
 
 # Alias Functions
+# Alias for backward compatibility with incorrect function name
+Applications.the_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range = Applications.get_trend_analytics_data_for_thousand_eyes_test_results_in_the_specified_time_range

dnacentersdk/api/v3_1_3_0/configuration_templates.py

@@ -3127,3 +3127,5 @@ def deploy_template_v2(
 
 
 # Alias Functions
+# Aliases for v2 functions that were renamed without v2 suffix when v1 doesn't exist Ansible
+ConfigurationTemplates.get_projects_details_v2 = ConfigurationTemplates.get_projects_details

dnacentersdk/api/v3_1_3_0/device_onboarding_pnp.py

@@ -1026,7 +1026,7 @@ def preview_config(
             "bpm_fc416739f3c655ed911884aec0130e83_v3_1_3_0", json_data
         )
 
-    def un_claim_device(
+    def unclaim_device(
         self,
         deviceIdList=None,
         headers=None,
@@ -2421,3 +2421,5 @@ def update_workflow(
 
 
 # Alias Functions
+# Alias for backward compatibility with incorrect function name
+DeviceOnboardingPnp.un_claim_device = DeviceOnboardingPnp.unclaim_device

dnacentersdk/api/v3_1_3_0/devices.py

@@ -4461,7 +4461,7 @@ def gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided
             "bpm_f667322836d5527482ad2100bec7feb4_v3_1_3_0", json_data
         )
 
-    def the_total_interfaces_count_across_the_network_devices(
+    def get_total_interfaces_count_across_the_network_devices(
         self,
         aggregateAttributes=None,
         attributes=None,
@@ -4656,7 +4656,7 @@ def get_the_interface_data_for_the_given_interface_idinstance_uuid_along_with_th
             "bpm_adcdf890505770af113b18b30c1b5f_v3_1_3_0", json_data
         )
 
-    def the_trend_analytcis_data_for_the_interfaces_in_the_specified_time_range(
+    def get_trend_analytics_data_for_the_interfaces_in_the_specified_time_range(
         self,
         id,
         aggregateAttributes=None,
@@ -5771,7 +5771,7 @@ def get_the_device_data_for_the_given_device_id_uuid(
             "bpm_f89c7ee84a615469b754add8feeabb5a_v3_1_3_0", json_data
         )
 
-    def the_trend_analytics_data_for_the_network_device_in_the_specified_time_range(
+    def get_trend_analytics_data_for_the_network_device_in_the_specified_time_range(
         self,
         id,
         aggregateAttributes=None,
@@ -13663,3 +13663,11 @@ def gets_interfaces_along_with_statistics_data_from_all_network_devices(
             headers=headers,
             **request_parameters
         )
+
+
+# Aliases for backward compatibility with incorrect function names
+Devices.the_total_interfaces_count_across_the_network_devices = Devices.get_total_interfaces_count_across_the_network_devices
+Devices.the_trend_analytcis_data_for_the_interfaces_in_the_specified_time_range = Devices.get_trend_analytics_data_for_the_interfaces_in_the_specified_time_range
+Devices.the_trend_analytics_data_for_the_network_device_in_the_specified_time_range = Devices.get_trend_analytics_data_for_the_network_device_in_the_specified_time_range
+# Ansible
+Devices.get_device_interface_stats_info_v2 = Devices.get_device_interface_stats_info

dnacentersdk/api/v3_1_3_0/discovery.py

@@ -3001,3 +3001,7 @@ def delete_global_credential(self, id, headers=None, **request_parameters):
 
 
 # Alias Functions
+# Aliases for v2 functions that were renamed without v2 suffix when v1 doesn't exist Ansible
+Discovery.create_global_credentials_v2 = Discovery.create_global_credentials
+Discovery.get_all_global_credentials_v2 = Discovery.get_all_global_credentials
+Discovery.delete_global_credential_v2 = Discovery.delete_global_credential

dnacentersdk/api/v3_1_3_0/industrial_configuration.py

@@ -64,7 +64,7 @@ def __init__(self, session, object_factory, request_validator):
         self._object_factory = object_factory
         self._request_validator = request_validator
 
-    def configure_are_p_ring_on_fabric_deployment(
+    def configure_rep_ring_on_fabric_deployment(
         self,
         deploymentMode=None,
         ringName=None,
@@ -161,7 +161,7 @@ def configure_are_p_ring_on_fabric_deployment(
             "bpm_f200dc9a10d25beab1243a5b29f99c7d_v3_1_3_0", json_data
         )
 
-    def delete_are_p_ring_configured_in_the_fabric_deployment(
+    def delete_rep_ring_configured_in_the_fabric_deployment(
         self, id, headers=None, **request_parameters
     ):
         """This API deletes the REP ring configured in the FABRIC deployment for the given id. The id of configured REP
@@ -507,7 +507,7 @@ def retrieves_the_count_of_mrp_ring_members(
             "bpm_bc1b3345f259e9859ac21a1ec694fe_v3_1_3_0", json_data
         )
 
-    def configure_are_p_ring_on_non_fabric_deployment(
+    def configure_rep_ring_on_non_fabric_deployment(
         self,
         deploymentMode=None,
         ringName=None,
@@ -604,7 +604,7 @@ def configure_are_p_ring_on_non_fabric_deployment(
             "bpm_bbc4dab8193c546ab116e19863dff621_v3_1_3_0", json_data
         )
 
-    def delete_are_p_ring_configured_in_the_non_fabric_deployment(
+    def delete_rep_ring_configured_in_the_non_fabric_deployment(
         self, id, headers=None, **request_parameters
     ):
         """This API deletes the REP ring configured in the NON-FABRIC deployment for the given id. The id of configured REP
@@ -663,7 +663,7 @@ def delete_are_p_ring_configured_in_the_non_fabric_deployment(
             "bpm_dcf9b8fecdd57f0bb7a33d358e6be37_v3_1_3_0", json_data
         )
 
-    def retrieves_the_list_of_are_p_rings(
+    def retrieves_the_list_of_rep_rings(
         self,
         deploymentMode=None,
         limit=None,
@@ -757,7 +757,7 @@ def retrieves_the_list_of_are_p_rings(
             "bpm_fa2127b55124a3a00b2991b77db6_v3_1_3_0", json_data
         )
 
-    def retrieves_the_count_of_are_p_rings(
+    def retrieves_the_count_of_rep_rings(
         self,
         deploymentMode=None,
         networkDeviceId=None,
@@ -842,7 +842,7 @@ def retrieves_the_count_of_are_p_rings(
             "bpm_d9f276a532e5eeb86bb591f8537fcc7_v3_1_3_0", json_data
         )
 
-    def get_the_are_p_ring_based_on_the_ring_id(
+    def get_the_rep_ring_based_on_the_ring_id(
         self, id, headers=None, **request_parameters
     ):
         """This API returns REP ring for the given id (The id of configured REP ring can be retrieved using the API
@@ -903,3 +903,23 @@ def get_the_are_p_ring_based_on_the_ring_id(
 
 
 # Alias Functions
+# Aliases for backward compatibility with incorrect function names
+IndustrialConfiguration.configure_are_p_ring_on_fabric_deployment = IndustrialConfiguration.configure_rep_ring_on_fabric_deployment
+IndustrialConfiguration.delete_are_p_ring_configured_in_the_fabric_deployment = IndustrialConfiguration.delete_rep_ring_configured_in_the_fabric_deployment
+IndustrialConfiguration.configure_are_p_ring_on_non_fabric_deployment = IndustrialConfiguration.configure_rep_ring_on_non_fabric_deployment
+IndustrialConfiguration.delete_are_p_ring_configured_in_the_non_fabric_deployment = IndustrialConfiguration.delete_rep_ring_configured_in_the_non_fabric_deployment
+IndustrialConfiguration.retrieves_the_list_of_are_p_rings = IndustrialConfiguration.retrieves_the_list_of_rep_rings
+IndustrialConfiguration.retrieves_the_count_of_are_p_rings = IndustrialConfiguration.retrieves_the_count_of_rep_rings
+IndustrialConfiguration.get_the_are_p_ring_based_on_the_ring_id = IndustrialConfiguration.get_the_rep_ring_based_on_the_ring_id
+
+# Additional aliases for missing_list variants Ansible
+IndustrialConfiguration.configure_a_r_e_p_ring_on_f_a_b_r_i_c_deployment = IndustrialConfiguration.configure_rep_ring_on_fabric_deployment
+IndustrialConfiguration.configure_a_r_e_p_ring_on_n_o_n_f_a_b_r_i_c_deployment = IndustrialConfiguration.configure_rep_ring_on_non_fabric_deployment
+IndustrialConfiguration.delete_r_e_p_ring_configured_in_the_f_a_b_r_i_c_deployment = IndustrialConfiguration.delete_rep_ring_configured_in_the_fabric_deployment
+IndustrialConfiguration.delete_r_e_p_ring_configured_in_the_n_o_n_f_a_b_r_i_c_deployment = IndustrialConfiguration.delete_rep_ring_configured_in_the_non_fabric_deployment
+IndustrialConfiguration.retrieves_the_list_of_r_e_p_rings = IndustrialConfiguration.retrieves_the_list_of_rep_rings
+IndustrialConfiguration.retrieves_the_count_of_r_e_p_rings = IndustrialConfiguration.retrieves_the_count_of_rep_rings
+IndustrialConfiguration.get_the_r_e_p_ring_based_on_the_ring_id = IndustrialConfiguration.get_the_rep_ring_based_on_the_ring_id
+IndustrialConfiguration.retrieves_the_list_of_m_r_p_rings = IndustrialConfiguration.retrieves_the_list_of_mrp_rings
+IndustrialConfiguration.retrieves_the_count_of_m_r_p_ring_members = IndustrialConfiguration.retrieves_the_count_of_mrp_ring_members
+IndustrialConfiguration.retrieves_the_list_of_network_devices_part_of_m_r_p_ring = IndustrialConfiguration.retrieves_the_list_of_network_devices_part_of_mrp_ring