Skip to content

README.md

Latest commit

 

History

History
974 lines (651 loc) · 46.2 KB

README.md

File metadata and controls

974 lines (651 loc) · 46.2 KB
Raw

Group

Overview

Available Operations

create_ads_group

Create a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.create_ads_group(request={
        "ads_group": {},
        "connection_id": "<id>",
    })

    assert res.ads_group is not None

    # Handle response
    print(res.ads_group)

Parameters

Parameter Type Required Description
request operations.CreateAdsGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateAdsGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

create_hris_group

Create a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.create_hris_group(request={
        "hris_group": {},
        "connection_id": "<id>",
    })

    assert res.hris_group is not None

    # Handle response
    print(res.hris_group)

Parameters

Parameter Type Required Description
request operations.CreateHrisGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateHrisGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

create_scim_groups

Create group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.create_scim_groups(request={
        "scim_group": {
            "display_name": "Nina.Tremblay",
        },
        "connection_id": "<id>",
    })

    assert res.scim_group is not None

    # Handle response
    print(res.scim_group)

Parameters

Parameter Type Required Description
request operations.CreateScimGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateScimGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

get_ads_group

Retrieve a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.get_ads_group(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.ads_group is not None

    # Handle response
    print(res.ads_group)

Parameters

Parameter Type Required Description
request operations.GetAdsGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetAdsGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

get_clubs_group

Retrieve a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.get_clubs_group(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.clubs_group is not None

    # Handle response
    print(res.clubs_group)

Parameters

Parameter Type Required Description
request operations.GetClubsGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetClubsGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

get_hris_group

Retrieve a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.get_hris_group(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.hris_group is not None

    # Handle response
    print(res.hris_group)

Parameters

Parameter Type Required Description
request operations.GetHrisGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetHrisGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

get_scim_groups

Get group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.get_scim_groups(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.scim_group is not None

    # Handle response
    print(res.scim_group)

Parameters

Parameter Type Required Description
request operations.GetScimGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetScimGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_ads_groups

List all groups

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.list_ads_groups(request={
        "connection_id": "<id>",
    })

    assert res.ads_groups is not None

    # Handle response
    print(res.ads_groups)

Parameters

Parameter Type Required Description
request operations.ListAdsGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListAdsGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_clubs_groups

List all groups

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.list_clubs_groups(request={
        "connection_id": "<id>",
    })

    assert res.clubs_groups is not None

    # Handle response
    print(res.clubs_groups)

Parameters

Parameter Type Required Description
request operations.ListClubsGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListClubsGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_hris_groups

List all groups

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.list_hris_groups(request={
        "connection_id": "<id>",
    })

    assert res.hris_groups is not None

    # Handle response
    print(res.hris_groups)

Parameters

Parameter Type Required Description
request operations.ListHrisGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListHrisGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_scim_groups

List groups

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.list_scim_groups(request={
        "connection_id": "<id>",
    })

    assert res.scim_groups is not None

    # Handle response
    print(res.scim_groups)

Parameters

Parameter Type Required Description
request operations.ListScimGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListScimGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

patch_ads_group

Update a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.patch_ads_group(request={
        "ads_group": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.ads_group is not None

    # Handle response
    print(res.ads_group)

Parameters

Parameter Type Required Description
request operations.PatchAdsGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.PatchAdsGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

patch_hris_group

Update a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.patch_hris_group(request={
        "hris_group": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.hris_group is not None

    # Handle response
    print(res.hris_group)

Parameters

Parameter Type Required Description
request operations.PatchHrisGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.PatchHrisGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

patch_scim_groups

Update group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.patch_scim_groups(request={
        "scim_group": {
            "display_name": "Newell.Hoeger",
        },
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.scim_group is not None

    # Handle response
    print(res.scim_group)

Parameters

Parameter Type Required Description
request operations.PatchScimGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.PatchScimGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

remove_ads_group

Remove a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.remove_ads_group(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request operations.RemoveAdsGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.RemoveAdsGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

remove_hris_group

Remove a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.remove_hris_group(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request operations.RemoveHrisGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.RemoveHrisGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

remove_scim_groups

Delete group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.remove_scim_groups(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request operations.RemoveScimGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.RemoveScimGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

update_ads_group

Update a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.update_ads_group(request={
        "ads_group": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.ads_group is not None

    # Handle response
    print(res.ads_group)

Parameters

Parameter Type Required Description
request operations.UpdateAdsGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateAdsGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

update_hris_group

Update a group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.update_hris_group(request={
        "hris_group": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.hris_group is not None

    # Handle response
    print(res.hris_group)

Parameters

Parameter Type Required Description
request operations.UpdateHrisGroupRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateHrisGroupResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

update_scim_groups

Update group

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.group.update_scim_groups(request={
        "scim_group": {
            "display_name": "Reynold90",
        },
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.scim_group is not None

    # Handle response
    print(res.scim_group)

Parameters

Parameter Type Required Description
request operations.UpdateScimGroupsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateScimGroupsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*