Update to python SDK docs: 13820107626

2025-12-08 20:37:46 +00:00 · 2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
--- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md
+++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md
@@ -34,6 +34,14 @@ Method | HTTP request | Description
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Create Connector Rule
 Create a connector rule from the available types.

@@ -66,7 +74,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.connector_rule_create_request import ConnectorRuleCreateRequest
@@ -75,9 +82,11 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
-    connector_rule_create_request = {
+    connector_rule_create_request = '''{
          "sourceCode" : {
            "version" : "1.0",
            "script" : "return \"Mr. \" + firstName;"
@@ -102,18 +111,17 @@ with ApiClient(configuration) as api_client:
          "description" : "This rule does that",
          "attributes" : { },
          "type" : "BuildMap"
-        } # ConnectorRuleCreateRequest | Connector rule to create.
+        }''' # ConnectorRuleCreateRequest | Connector rule to create.

    try:
        # Create Connector Rule
-        new_connector_rule_create_request = ConnectorRuleCreateRequest()
-        new_connector_rule_create_request.from_json(connector_rule_create_request)
-        results =ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
+        new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request)
+        results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental=x_sail_point_experimental, connector_rule_create_request=new_connector_rule_create_request)
        # Below is a request that includes all optional parameters
        # results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
        print("The response of ConnectorRuleManagementApi->create_connector_rule:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling ConnectorRuleManagementApi->create_connector_rule: %s\n" % e)
 ```

@@ -125,6 +133,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Delete Connector Rule
 Delete the connector rule for the given ID.

@@ -158,13 +174,14 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
 from sailpoint.v2024.api_client import ApiClient
 from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule to delete.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -172,10 +189,10 @@ with ApiClient(configuration) as api_client:
    try:
        # Delete Connector Rule
        
-        ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
+        ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling ConnectorRuleManagementApi->delete_connector_rule: %s\n" % e)
 ```

@@ -187,6 +204,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Get Connector Rule
 Get a connector rule by ID.

@@ -220,7 +245,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
@@ -228,6 +252,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -235,12 +261,12 @@ with ApiClient(configuration) as api_client:
    try:
        # Get Connector Rule
        
-        results =ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
+        results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
        print("The response of ConnectorRuleManagementApi->get_connector_rule:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling ConnectorRuleManagementApi->get_connector_rule: %s\n" % e)
 ```

@@ -252,6 +278,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 List Connector Rules
 List existing connector rules.

@@ -286,7 +320,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
@@ -294,6 +327,8 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
@@ -303,12 +338,12 @@ with ApiClient(configuration) as api_client:
    try:
        # List Connector Rules
        
-        results =ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, )
+        results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, limit, offset, count)
        print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e)
 ```

@@ -320,6 +355,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Update Connector Rule
 Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type`

@@ -354,7 +397,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
@@ -363,10 +405,12 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
-    connector_rule_update_request = {
+    connector_rule_update_request = '''{
          "sourceCode" : {
            "version" : "1.0",
            "script" : "return \"Mr. \" + firstName;"
@@ -392,17 +436,17 @@ with ApiClient(configuration) as api_client:
          "attributes" : { },
          "id" : "8113d48c0b914f17b4c6072d4dcb9dfe",
          "type" : "BuildMap"
-        } # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional)
+        }''' # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional)

    try:
        # Update Connector Rule
        
-        results =ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, )
+        results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, new_connector_rule_update_request)
        print("The response of ConnectorRuleManagementApi->put_connector_rule:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling ConnectorRuleManagementApi->put_connector_rule: %s\n" % e)
 ```

@@ -414,6 +458,14 @@ with ApiClient(configuration) as api_client:
 :::warning experimental 
 This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
 :::
+:::tip setting x-sailpoint-experimental header
+ on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
+ Example:
+ ```python
+   configuration = Configuration()
+   configuration.experimental = True
+ ```
+:::
 Validate Connector Rule
 Detect issues within the connector rule's code to fix and list them.

@@ -446,7 +498,6 @@ Code | Description  | Data Type | Response headers |
 ### Example

 ```python
-import sailpoint.v2024
 from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
 from sailpoint.v2024.api_client import ApiClient
 from sailpoint.v2024.models.connector_rule_validation_response import ConnectorRuleValidationResponse
@@ -455,23 +506,24 @@ from pprint import pprint
 from sailpoint.configuration import Configuration
 configuration = Configuration()

+configuration.experimental = true
+
 with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
-    source_code = {
+    source_code = '''{
          "version" : "1.0",
          "script" : "return \"Mr. \" + firstName;"
-        } # SourceCode | Code to validate.
+        }''' # SourceCode | Code to validate.

    try:
        # Validate Connector Rule
-        new_source_code = SourceCode()
-        new_source_code.from_json(source_code)
-        results =ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
+        new_source_code = SourceCode.from_json(source_code)
+        results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental=x_sail_point_experimental, source_code=new_source_code)
        # Below is a request that includes all optional parameters
        # results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
        print("The response of ConnectorRuleManagementApi->test_connector_rule:\n")
        pprint(results)
-        except Exception as e:
+    except Exception as e:
        print("Exception when calling ConnectorRuleManagementApi->test_connector_rule: %s\n" % e)
 ```