Skip to content

README.md

Latest commit

 

History

History
920 lines (613 loc) · 45.3 KB

README.md

File metadata and controls

920 lines (613 loc) · 45.3 KB
Raw

Company

Overview

Available Operations

create_ats_company

Create a company

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

    assert res.ats_company is not None

    # Handle response
    print(res.ats_company)

Parameters

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

Response

operations.CreateAtsCompanyResponse

Errors

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

create_crm_company

Create a company

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

    assert res.crm_company is not None

    # Handle response
    print(res.crm_company)

Parameters

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

Response

operations.CreateCrmCompanyResponse

Errors

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

create_hris_company

Create a company

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

    assert res.hris_company is not None

    # Handle response
    print(res.hris_company)

Parameters

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

Response

operations.CreateHrisCompanyResponse

Errors

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

get_ats_company

Retrieve a company

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

    assert res.ats_company is not None

    # Handle response
    print(res.ats_company)

Parameters

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

Response

operations.GetAtsCompanyResponse

Errors

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

get_crm_company

Retrieve a company

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

    assert res.crm_company is not None

    # Handle response
    print(res.crm_company)

Parameters

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

Response

operations.GetCrmCompanyResponse

Errors

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

get_hris_company

Retrieve a company

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

    assert res.hris_company is not None

    # Handle response
    print(res.hris_company)

Parameters

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

Response

operations.GetHrisCompanyResponse

Errors

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

list_ats_companies

List all companies

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

    assert res.ats_companies is not None

    # Handle response
    print(res.ats_companies)

Parameters

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

Response

operations.ListAtsCompaniesResponse

Errors

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

list_crm_companies

List all companies

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

    assert res.crm_companies is not None

    # Handle response
    print(res.crm_companies)

Parameters

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

Response

operations.ListCrmCompaniesResponse

Errors

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

list_enrich_companies

Retrieve enrichment information for a company

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

    assert res.enrich_company is not None

    # Handle response
    print(res.enrich_company)

Parameters

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

Response

operations.ListEnrichCompaniesResponse

Errors

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

list_hris_companies

List all companies

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

    assert res.hris_companies is not None

    # Handle response
    print(res.hris_companies)

Parameters

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

Response

operations.ListHrisCompaniesResponse

Errors

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

patch_ats_company

Update a company

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

    assert res.ats_company is not None

    # Handle response
    print(res.ats_company)

Parameters

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

Response

operations.PatchAtsCompanyResponse

Errors

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

patch_crm_company

Update a company

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

    assert res.crm_company is not None

    # Handle response
    print(res.crm_company)

Parameters

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

Response

operations.PatchCrmCompanyResponse

Errors

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

patch_hris_company

Update a company

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

    assert res.hris_company is not None

    # Handle response
    print(res.hris_company)

Parameters

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

Response

operations.PatchHrisCompanyResponse

Errors

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

remove_ats_company

Remove a company

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

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveAtsCompanyResponse

Errors

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

remove_crm_company

Remove a company

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

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveCrmCompanyResponse

Errors

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

remove_hris_company

Remove a company

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

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveHrisCompanyResponse

Errors

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

update_ats_company

Update a company

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

    assert res.ats_company is not None

    # Handle response
    print(res.ats_company)

Parameters

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

Response

operations.UpdateAtsCompanyResponse

Errors

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

update_crm_company

Update a company

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

    assert res.crm_company is not None

    # Handle response
    print(res.crm_company)

Parameters

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

Response

operations.UpdateCrmCompanyResponse

Errors

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

update_hris_company

Update a company

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

    assert res.hris_company is not None

    # Handle response
    print(res.hris_company)

Parameters

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

Response

operations.UpdateHrisCompanyResponse

Errors

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