Update to python SDK docs: 13995602131

2025-12-10 04:19:42 +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/Beta/Methods/CertificationCampaignsApi.md
+++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md
@@ -156,7 +156,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.complete_campaign_options import CompleteCampaignOptions
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -174,7 +173,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_complete_campaign_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)
 ```
@@ -224,7 +223,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign import Campaign
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -347,7 +345,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)
 ```
@@ -397,7 +395,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_template import CampaignTemplate
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -535,7 +532,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)
 ```
@@ -585,7 +582,6 @@ Code | Description  | Data Type | Response headers |
 ```python
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

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

@@ -712,7 +707,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.delete_campaigns_request import DeleteCampaignsRequest
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -729,7 +723,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_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)
 ```
@@ -784,7 +778,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -804,7 +797,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)
 ```
@@ -855,7 +848,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.slimcampaign import Slimcampaign
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -870,7 +862,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).get_campaign(id)
        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)
 ```
@@ -921,7 +913,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_report import CampaignReport
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -936,7 +927,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)
 ```
@@ -983,7 +974,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -997,7 +987,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)
 ```
@@ -1048,7 +1038,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_template import CampaignTemplate
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1063,7 +1052,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)
 ```
@@ -1114,7 +1103,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.schedule import Schedule
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1129,7 +1117,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)
 ```
@@ -1185,7 +1173,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_template import CampaignTemplate
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1204,7 +1191,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)
 ```
@@ -1257,7 +1244,6 @@ from sailpoint.beta.api.certification_campaigns_api import CertificationCampaign
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.admin_review_reassign import AdminReviewReassign
 from sailpoint.beta.models.certification_task import CertificationTask
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1280,7 +1266,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)
 ```
@@ -1333,7 +1319,6 @@ from sailpoint.beta.api.certification_campaigns_api import CertificationCampaign
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_template import CampaignTemplate
 from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1349,7 +1334,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)
 ```
@@ -1399,7 +1384,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1416,7 +1400,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)
 ```
@@ -1469,7 +1453,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.schedule import Schedule
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

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

@@ -1572,7 +1554,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)
 ```
@@ -1622,7 +1604,6 @@ Code | Description  | Data Type | Response headers |
 ```python
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1637,7 +1618,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)
 ```
@@ -1689,7 +1670,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.report_type import ReportType
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1705,7 +1685,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)
 ```
@@ -1767,7 +1747,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.campaign_reference import CampaignReference
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1782,7 +1761,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)
 ```
@@ -1834,7 +1813,6 @@ Code | Description  | Data Type | Response headers |
 from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
 from sailpoint.beta.api_client import ApiClient
 from sailpoint.beta.models.slimcampaign import Slimcampaign
-from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

@@ -1850,7 +1828,7 @@ with ApiClient(configuration) as api_client:
        # Below is a request that includes all optional parameters
        # results = CertificationCampaignsApi(api_client).update_campaign(id, new_request_body)
        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)
 ```