Skip to content

README.md

Latest commit

 

History

History
920 lines (613 loc) · 45.6 KB

README.md

File metadata and controls

920 lines (613 loc) · 45.6 KB
Raw

Event

Overview

Available Operations

create_analytics_event

Create an event

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

    assert res.analytics_event is not None

    # Handle response
    print(res.analytics_event)

Parameters

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

Response

operations.CreateAnalyticsEventResponse

Errors

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

create_calendar_event

Create an event

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

    assert res.calendar_event is not None

    # Handle response
    print(res.calendar_event)

Parameters

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

Response

operations.CreateCalendarEventResponse

Errors

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

create_crm_event

Create an event

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

    assert res.crm_event is not None

    # Handle response
    print(res.crm_event)

Parameters

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

Response

operations.CreateCrmEventResponse

Errors

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

get_analytics_event

Retrieve an event

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

    assert res.analytics_event is not None

    # Handle response
    print(res.analytics_event)

Parameters

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

Response

operations.GetAnalyticsEventResponse

Errors

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

get_calendar_event

Retrieve an event

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

    assert res.calendar_event is not None

    # Handle response
    print(res.calendar_event)

Parameters

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

Response

operations.GetCalendarEventResponse

Errors

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

get_clubs_event

Retrieve an event

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

    assert res.clubs_event is not None

    # Handle response
    print(res.clubs_event)

Parameters

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

Response

operations.GetClubsEventResponse

Errors

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

get_crm_event

Retrieve an event

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

    assert res.crm_event is not None

    # Handle response
    print(res.crm_event)

Parameters

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

Response

operations.GetCrmEventResponse

Errors

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

list_analytics_events

List all events

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

    assert res.analytics_events is not None

    # Handle response
    print(res.analytics_events)

Parameters

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

Response

operations.ListAnalyticsEventsResponse

Errors

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

list_calendar_events

List all events

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

    assert res.calendar_events is not None

    # Handle response
    print(res.calendar_events)

Parameters

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

Response

operations.ListCalendarEventsResponse

Errors

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

list_clubs_events

List all events

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

    assert res.clubs_events is not None

    # Handle response
    print(res.clubs_events)

Parameters

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

Response

operations.ListClubsEventsResponse

Errors

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

list_crm_events

List all events

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

    assert res.crm_events is not None

    # Handle response
    print(res.crm_events)

Parameters

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

Response

operations.ListCrmEventsResponse

Errors

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

patch_calendar_event

Update an event

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

    assert res.calendar_event is not None

    # Handle response
    print(res.calendar_event)

Parameters

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

Response

operations.PatchCalendarEventResponse

Errors

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

patch_crm_event

Update an event

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

    assert res.crm_event is not None

    # Handle response
    print(res.crm_event)

Parameters

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

Response

operations.PatchCrmEventResponse

Errors

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

patch_messaging_event

Update an event

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

    assert res.messaging_event is not None

    # Handle response
    print(res.messaging_event)

Parameters

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

Response

operations.PatchMessagingEventResponse

Errors

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

remove_calendar_event

Remove an event

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

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveCalendarEventResponse

Errors

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

remove_crm_event

Remove an event

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

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveCrmEventResponse

Errors

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

update_calendar_event

Update an event

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

    assert res.calendar_event is not None

    # Handle response
    print(res.calendar_event)

Parameters

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

Response

operations.UpdateCalendarEventResponse

Errors

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

update_crm_event

Update an event

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

    assert res.crm_event is not None

    # Handle response
    print(res.crm_event)

Parameters

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

Response

operations.UpdateCrmEventResponse

Errors

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

update_messaging_event

Update an event

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

    assert res.messaging_event is not None

    # Handle response
    print(res.messaging_event)

Parameters

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

Response

operations.UpdateMessagingEventResponse

Errors

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