Skip to content

README.md

Latest commit

 

History

History
295 lines (196 loc) · 15.5 KB

README.md

File metadata and controls

295 lines (196 loc) · 15.5 KB
Raw

Bankaccount

Overview

Available Operations

create_hris_bankaccount

Create a bankaccount

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.bankaccount.create_hris_bankaccount(request={
        "hris_bankaccount": {},
        "connection_id": "<id>",
    })

    assert res.hris_bankaccount is not None

    # Handle response
    print(res.hris_bankaccount)

Parameters

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

Response

operations.CreateHrisBankaccountResponse

Errors

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

get_hris_bankaccount

Retrieve a bankaccount

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.bankaccount.get_hris_bankaccount(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.hris_bankaccount is not None

    # Handle response
    print(res.hris_bankaccount)

Parameters

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

Response

operations.GetHrisBankaccountResponse

Errors

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

list_hris_bankaccounts

List all bankaccounts

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.bankaccount.list_hris_bankaccounts(request={
        "connection_id": "<id>",
    })

    assert res.hris_bankaccounts is not None

    # Handle response
    print(res.hris_bankaccounts)

Parameters

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

Response

operations.ListHrisBankaccountsResponse

Errors

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

patch_hris_bankaccount

Update a bankaccount

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.bankaccount.patch_hris_bankaccount(request={
        "hris_bankaccount": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.hris_bankaccount is not None

    # Handle response
    print(res.hris_bankaccount)

Parameters

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

Response

operations.PatchHrisBankaccountResponse

Errors

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

remove_hris_bankaccount

Remove a bankaccount

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.bankaccount.remove_hris_bankaccount(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveHrisBankaccountResponse

Errors

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

update_hris_bankaccount

Update a bankaccount

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.bankaccount.update_hris_bankaccount(request={
        "hris_bankaccount": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.hris_bankaccount is not None

    # Handle response
    print(res.hris_bankaccount)

Parameters

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

Response

operations.UpdateHrisBankaccountResponse

Errors

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