Update to python SDK docs: 13995602131

2025-12-09 04:19:37 +00:00 · 2025-03-21 15:48:51 +00:00
parent 5109bc43f7
commit 7c85cb6669
213 changed files with 20334 additions and 23488 deletions
--- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md
+++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md
@@ -151,7 +151,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_complete_options import CampaignCompleteOptions
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -169,7 +168,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options)
        print("The response of CertificationCampaignsApi->complete_campaign:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e)
 ```
@@ -214,7 +213,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign import Campaign
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -338,7 +336,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).create_campaign(new_campaign)
        print("The response of CertificationCampaignsApi->create_campaign:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e)
 ```
@@ -383,7 +381,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_template import CampaignTemplate
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -522,7 +519,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
        print("The response of CertificationCampaignsApi->create_campaign_template:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e)
 ```
@@ -567,7 +564,6 @@ Code | Description  | Data Type | Response headers |
 ```python
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -625,7 +621,6 @@ Code | Description  | Data Type | Response headers |
 ```python
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -684,7 +679,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaigns_delete_request import CampaignsDeleteRequest
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -701,7 +695,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
        print("The response of CertificationCampaignsApi->delete_campaigns:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e)
 ```
@@ -751,7 +745,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -771,7 +764,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters)
        print("The response of CertificationCampaignsApi->get_active_campaigns:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e)
 ```
@@ -818,7 +811,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -834,7 +826,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_campaign(id, detail)
        print("The response of CertificationCampaignsApi->get_campaign:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e)
 ```
@@ -880,7 +872,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_report import CampaignReport
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -895,7 +886,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_campaign_reports(id)
        print("The response of CertificationCampaignsApi->get_campaign_reports:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e)
 ```
@@ -937,7 +928,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -951,7 +941,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
        print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e)
 ```
@@ -997,7 +987,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_template import CampaignTemplate
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1012,7 +1001,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_campaign_template(id)
        print("The response of CertificationCampaignsApi->get_campaign_template:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e)
 ```
@@ -1058,7 +1047,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.schedule import Schedule
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1073,7 +1061,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
        print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e)
 ```
@@ -1124,7 +1112,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_template import CampaignTemplate
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1143,7 +1130,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters)
        print("The response of CertificationCampaignsApi->get_campaign_templates:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e)
 ```
@@ -1191,7 +1178,6 @@ from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaig
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.admin_review_reassign import AdminReviewReassign
 from sailpoint.v2024.models.certification_task import CertificationTask
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1214,7 +1200,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
        print("The response of CertificationCampaignsApi->move:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->move: %s\n" % e)
 ```
@@ -1262,7 +1248,6 @@ from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaig
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_template import CampaignTemplate
 from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1278,7 +1263,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
        print("The response of CertificationCampaignsApi->patch_campaign_template:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e)
 ```
@@ -1323,7 +1308,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1340,7 +1324,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
        print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e)
 ```
@@ -1387,7 +1371,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.schedule import Schedule
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1467,7 +1450,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.activate_campaign_options import ActivateCampaignOptions
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1485,7 +1467,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options)
        print("The response of CertificationCampaignsApi->start_campaign:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e)
 ```
@@ -1530,7 +1512,6 @@ Code | Description  | Data Type | Response headers |
 ```python
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1545,7 +1526,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
        print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e)
 ```
@@ -1592,7 +1573,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.report_type import ReportType
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1608,7 +1588,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).start_campaign_report(id, type)
        print("The response of CertificationCampaignsApi->start_campaign_report:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e)
 ```
@@ -1663,7 +1643,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.campaign_reference import CampaignReference
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1678,7 +1657,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
        print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e)
 ```
@@ -1726,7 +1705,6 @@ from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaig
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
 from sailpoint.v2024.models.slim_campaign import SlimCampaign
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1742,7 +1720,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
        print("The response of CertificationCampaignsApi->update_campaign:\n")
-        pprint(results)
+        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e)
 ```