Update docs examples

Author: smialy

docs/source/refexamples/examples/basic.rst

@@ -5,9 +5,9 @@ Create client
 -------------
 
 .. code-block:: python
-    
+
     from catalystwan.core.client import create_client
-        
+
     with create_client(
         url=SDWAN_URL,
         port=SDWAN_PORT,
@@ -36,15 +36,18 @@ API calls and Models
 
 Sending requests is done through the ApiClient object.
 Wherever it is possible, we use dataclass objects for modelling payloads and responses.
-If one of the apis uses such model, it can be conveniently accessed by an ``m`` property of that api. 
+If one of the apis uses such model, it can be conveniently accessed by an ``m`` property of that api.
 
 .. code-block:: python
 
     def create_embedded_security_profile(client: ApiClient) -> str:
         es_api = client.v1.feature_profile.sdwan.embedded_security
         # Access models through m property.
-        es = es_api.m.EmbeddedSecurityDefault(name="NAME", description="DESC")
-        es_response = es_api.create_sdwan_embedded_security_feature_profile(es)
+        es = es_api.m.CreateSdwanEmbeddedSecurityFeatureProfilePostRequest(
+            name="NAME",
+            description="DESC"
+        )
+        es_response = es_api.post(es)
         return es_response.id
 
 Device
@@ -53,9 +56,9 @@ Device
 The easiest way of of finding a device/group of devices with a specific parameter (for example, a hostname or a personality) is to obtain a list of all devices and filter them out.
 
 .. code-block:: python
-    
+
     def get_device(client: ApiClient, personality="vedge") -> str:
-        devices = client.device.list_all_devices()
+        devices = client.device.get()
         filtered_devices = [device for device in devices if device.personality == personality]
 
         return filtered_devices

docs/source/refexamples/examples/ngfw.rst

@@ -9,12 +9,13 @@ Feature Profile (Policy Object)
 .. code-block:: python
 
     def get_feature_profile_id(client: ApiClient, feature_profile_name: str) -> str:
-        results = client.v1.feature_profile.sdwan.get_sdwan_feature_profile_by_sdwan_family()
+        results = client.v1.feature_profile.sdwan.get()
         for result in results:
             if result.profile_name == feature_profile_name:
                 profile_id = result.profile_id
                 return profile_id
 
+
 Group of Interest
 -----------------
 
@@ -38,17 +39,18 @@ In this example, we will create an Application List for Policy Object Feature Pr
             data=app_list.m.Data(entries=entries),
         )
         # Create AppList
-        parcel_id = app_list.create_data_prefix_profile_parcel_for_security_policy_object(
+        parcel_id = app_list.post(
             policy_object_profile_id, payload
         ).parcel_id
         return parcel_id
 
 
     def delete_app_list(client: ApiClient, policy_object_id: str, app_list_id: str):
-        client.v1.feature_profile.sdwan.policy_object.delete_data_prefix_profile_parcel_for_policy_object(
+        client.v1.feature_profile.sdwan.policy_object.delete(
             policy_object_id, policy_object_list_type="app-list", list_object_id=app_list_id
         )
 
+
 Embedded Security Profile
 -------------------------
 
@@ -58,28 +60,27 @@ Embedded Security Profile
         es_api = client.v1.feature_profile.sdwan.embedded_security
         # Define Embedded Security Profile
         es = es_api.m.CreateSdwanEmbeddedSecurityFeatureProfilePostRequest(
-            name="TEST_EMBEDDED_SECURITY", description="TEST_EMBEDDED_SECURITY"
+            name="DEMO_NGFW_EMBEDDED_SECURITY", description="EmbeddedSecurity_Test"
         )
         # Create Embedded Security Profile
-        es_response = es_api.create_sdwan_embedded_security_feature_profile(es)
+        es_response = es_api.post(es)
         return es_response.id
 
 
     def delete_embedded_security_profile(client: ApiClient, es_profile_id: str):
-        # Detaching or removing a Policy Group may be needed first.
         es_api = client.v1.feature_profile.sdwan.embedded_security
-        es_api.delete_sdwan_embedded_security_feature_profile(es_profile_id)
+        es_api.delete(es_profile_id)
 
 
     def copy_embedded_security_profile(client: ApiClient, es_profile_id: str) -> str:
         es_api = client.v1.feature_profile.sdwan.embedded_security
         es = es_api.m.CreateSdwanEmbeddedSecurityFeatureProfilePostRequest(
             name="TEST_EMBEDDED_SECURITY2",
             description="TEST_EMBEDDED_SECURITY2",
-            # Id of a source Feature Profile
             from_feature_profile=es_api.m.FromFeatureProfileDef(copy=es_profile_id),
         )
-        return es_api.create_sdwan_embedded_security_feature_profile(es).id
+        return es_api.post(es).id
+
 
 NGFW Parcel
 -----------
@@ -93,31 +94,45 @@ In this example we will create an NGFW Parcel for Embedded Security Profile
         m = ngfw_api.m
         # Define NGFW Parcel
         ngfw_parcel = m.CreateNgfirewallProfileParcelPostRequest(
-            name="TEST_NGFW_PARCEL",
-            description="TEST_NGFW_PARCEL",
-            data=m.Data(
-                default_action_type=m.OneOfDefaultActionTypeOptionsDef(value="pass", option_type="global"),
+            name="DEMO_NGFW_NGFW_PARCEL",
+            description="NGFW_TEST",
+            data=m.UnifiedNgfirewallData(
+                default_action_type=m.OneOfDefaultActionTypeOptionsDef(
+                    value="pass", option_type="global"
+                ),
                 sequences=[
                     m.Sequences(
                         actions=[],
-                        sequence_id=m.OneOfSequencesSequenceIdOptionsDef(value="1", option_type="global"),
-                        sequence_name=m.OneOfSequencesSequenceNameOptionsDef(value="Rule1", option_type="global"),
-                        sequence_type=m.OneOfSequencesSequenceTypeOptionsDef(option_type="global", value="ngfirewall"),
-                        base_action=m.OneOfSequencesBaseActionOptionsDef(value="pass", option_type="global"),
+                        sequence_id=m.OneOfSequencesSequenceIdOptionsDef(
+                            value="1", option_type="global"
+                        ),
+                        sequence_name=m.OneOfSequencesSequenceNameOptionsDef(
+                            value="Rule1", option_type="global"
+                        ),
+                        sequence_type=m.OneOfSequencesSequenceTypeOptionsDef(
+                            option_type="global", value="ngfirewall"
+                        ),
+                        base_action=m.OneOfSequencesBaseActionOptionsDef(
+                            value="pass", option_type="global"
+                        ),
                         disable_sequence=m.OneOfdisableSequenceDef(value=False, option_type="global"),
                         # Keep in mind: each Entries model may contain only a single rule. To add another rule, append
                         # another Entries object to the list.
                         match_=m.Match(
                             entries=[
                                 m.Entries(
                                     source_ip=m.Ipv4MatchDef(
-                                        ipv4_value=m.Ipv4InputDef1(option_type="global", value=["12.0.0.0/8"])
+                                        ipv4_value=m.Ipv4InputDef1(
+                                            option_type="global", value=["12.0.0.0/8"]
+                                        )
                                     )
                                 ),
                                 m.Entries(
                                     # You can also use a device variable, to set the value later.
                                     destination_ip=m.Ipv4MatchDef(
-                                        ipv4_value=m.Ipv4InputDef2(option_type="variable", value="{{test}}")
+                                        ipv4_value=m.Ipv4InputDef2(
+                                            option_type="variable", value="{{destination_ip_var}}"
+                                        )
                                     )
                                 ),
                             ]
@@ -127,17 +142,16 @@ In this example we will create an NGFW Parcel for Embedded Security Profile
             ),
         )
         # Create NGFW Parcel
-        ngfw_response = (
-            client.v1.feature_profile.sdwan.embedded_security.unified.ngfirewall.create_ngfirewall_profile_parcel(
-                es_profile_id, payload=ngfw_parcel
-            )
+        ngfw_response = client.v1.feature_profile.sdwan.embedded_security.unified.ngfirewall.post(
+            es_profile_id, payload=ngfw_parcel
         )
         return ngfw_response.parcel_id
 
 
     def delete_ngfw_parcel(client: ApiClient, es_profile_id: str, ngfw_id: str):
         ngfw_api = client.v1.feature_profile.sdwan.embedded_security.unified.ngfirewall
-        ngfw_api.delete_ngfirewall_profile_parcel(es_profile_id, ngfw_id)
+        ngfw_api.delete(es_profile_id, ngfw_id)
+
 
 Security Policy
 ---------------
@@ -151,11 +165,13 @@ In this example, we will create a Security Policy for Embedded Security Profile,
         m = po_api.m
         # Define Security Policy
         policy = m.CreateEmbeddedSecurityProfileParcelPostRequest(
-            name="TEST_SECURITY_POLICY",
+            name="DEMO_NGFW_SECURITY_POLICY",
             description="desc",
-            data=m.Data(
+            data=m.EmbeddedSecurityPolicyData(
                 settings=m.Settings(
-                    security_logging=m.NetworkSettingsOptionTypeObjectDef(option_type="network-settings", value=True)
+                    security_logging=m.NetworkSettingsOptionTypeObjectDef(
+                        option_type="network-settings", value=True
+                    )
                 ),
                 assembly=[
                     m.Assembly2(
@@ -173,13 +189,14 @@ In this example, we will create a Security Policy for Embedded Security Profile,
             ),
         )
         # Create Security Policy Parcel
-        response = po_api.create_embedded_security_profile_parcel(es_profile_id, policy)
+        response = po_api.post(es_profile_id, policy)
         return response.parcel_id
 
 
     def delete_security_policy(client: ApiClient, es_profile_id: str, security_policy_id: str):
         po_api = client.v1.feature_profile.sdwan.embedded_security.policy
-        po_api.delete_security_profile_parcel_1(es_profile_id, security_policy_id)
+        po_api.delete(es_profile_id, security_policy_id)
+
 
 Policy Group
 ------------
@@ -194,18 +211,17 @@ In this example, we will create a Policy Group with Embedded Security Profile at
         profiles = [pg_api.m.ProfileIdObjDef(id=id) for id in [policy_object_id, embedded_security_id]]
         # Define Policy Group
         policy_group = pg_api.m.CreatePolicyGroupPostRequest(
-            name="TEST_POLICY_GROUP", description="descr", solution="sdwan", profiles=profiles
+            name="DEMO_NGFW_POLICY_GROUP", description="descr", solution="sdwan", profiles=profiles
         )
         # Create Policy Group
-        policy_group_id = pg_api.create_policy_group(payload=policy_group).id
+        policy_group_id = pg_api.post(payload=policy_group).id
 
         return policy_group_id
 
 
     def delete_policy_group(client: ApiClient, policy_group_id: str):
-        # You may need to delete device associations first (see Associate Device example)
         pg_api = client.v1.policy_group
-        pg_api.delete_policy_group(policy_group_id)
+        pg_api.delete(policy_group_id)
 
 
     def copy_policy_group(client: ApiClient, policy_group_id: str) -> str:
@@ -216,20 +232,22 @@ In this example, we will create a Policy Group with Embedded Security Profile at
             solution="sdwan",
             from_policy_group=pg_api.m.FromPolicyGroupDef(copy=policy_group_id),
         )
-        return pg_api.create_policy_group(payload=policy_group).id
+        return pg_api.post(payload=policy_group).id
+
 
 Get Device id
 -------------
 
 .. code-block:: python
 
     def get_device_id(client: ApiClient, hostname: str) -> str:
-        devices = client.device.list_all_devices()
+        devices = client.device.get()
+        print([d.host_name for d in devices])
         # You find desired device by filtering with different fields, as well.
         device = [device for device in devices if device.host_name == hostname][0]
-
         return device.uuid
 
+
 Associate Device with Policy Group
 ----------------------------------
 
@@ -239,27 +257,33 @@ Associate Device with Policy Group
         pg_api = client.v1.policy_group
         m = pg_api.device.associate.m
         payload = m.CreatePolicyGroupAssociationPostRequest(devices=[m.DeviceIdDef(id=device_id)])
-        pg_api.device.associate.create_policy_group_association(policy_group_id, payload)
+        pg_api.device.associate.post(policy_group_id, payload)
 
 
     def delete_association(client: ApiClient, policy_group_id: str, device_id: str):
         pg_api = client.v1.policy_group
         m = pg_api.device.associate.m
-        payload = m.CreatePolicyGroupAssociationPostRequest(devices=[m.DeviceIdDef(id=device_id)])
-        client.v1.policy_group.device.associate.delete_policy_group_association(policy_group_id, payload)
+        payload = m.DeletePolicyGroupAssociationDeleteRequest(devices=[m.DeviceAssociateDeviceIdDef(id=device_id)])
+        client.v1.policy_group.device.associate.delete(
+            policy_group_id, payload
+        )
+
 
 Policy Group Variables
 ----------------------
 
 .. code-block:: python
 
+
     def set_variable_values(client: ApiClient, policy_group_id: str, device_id: str):
         variables_api = client.v1.policy_group.device.variables
         m = variables_api.m
 
         # Fetch variables
-        fetch_variables_payload = m.FetchPolicyGroupDeviceVariablesPostRequest(device_ids=[device_id], suggestions=True)
-        device_variables = variables_api.fetch_policy_group_device_variables(
+        fetch_variables_payload = m.FetchPolicyGroupDeviceVariablesPostRequest(
+            device_ids=[device_id], suggestions=True
+        )
+        device_variables = variables_api.post(
             policy_group_id, fetch_variables_payload
         ).devices
 
@@ -274,8 +298,11 @@ Policy Group Variables
                 current_variables.append(m.Variables(variable.name, [value]))
             if current_variables:
                 set_variables_payload.append(m.Devices(device_id, current_variables))
-        payload = m.CreatePolicyGroupDeviceVariablesPutRequest(devices=set_variables_payload, solution="sdwan")
-        variables_api.create_policy_group_device_variables(policy_group_id, payload)
+        payload = m.CreatePolicyGroupDeviceVariablesPutRequest(
+            devices=set_variables_payload, solution="sdwan"
+        )
+        variables_api.put(policy_group_id, payload)
+
 
 Deploy Policy Group
 ---------------------------------
@@ -287,9 +314,10 @@ Deploy Policy Group
         m = pg_api.m
 
         payload = m.DeployPolicyGroupPostRequest(devices=[m.DeviceIdDef(id=device_id)])
-        response = pg_api.deploy_policy_group(policy_group_id, payload)
+        response = pg_api.post(policy_group_id, payload)
         return response.parent_task_id
 
+
 Check Policy Group Deploy Task Status
 -------------------------------------
 
@@ -300,7 +328,8 @@ Check Policy Group Deploy Task Status
     def check_status(client: ApiClient, task_id: str) -> bool:
         status_api = client.device.action.status
         while True:
-            response = status_api.find_status(task_id)
+            response = status_api.get(task_id)
+            print(response)
             statuses = [status["status"] for status in response]
             if "In progress" in statuses:
                 print("In progress...\n")
@@ -310,6 +339,7 @@ Check Policy Group Deploy Task Status
             else:
                 return True
 
+
 Policy Group with NGFW flow
 ---------------------------