Skip to content

README.md

Latest commit

 

History

History
295 lines (196 loc) · 15.4 KB

README.md

File metadata and controls

295 lines (196 loc) · 15.4 KB
Raw

Webinar

Overview

Available Operations

create_calendar_webinar

Create a webinar

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

    assert res.calendar_webinar is not None

    # Handle response
    print(res.calendar_webinar)

Parameters

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

Response

operations.CreateCalendarWebinarResponse

Errors

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

get_calendar_webinar

Retrieve a webinar

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

    assert res.calendar_webinar is not None

    # Handle response
    print(res.calendar_webinar)

Parameters

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

Response

operations.GetCalendarWebinarResponse

Errors

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

list_calendar_webinars

List all webinars

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

    assert res.calendar_webinars is not None

    # Handle response
    print(res.calendar_webinars)

Parameters

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

Response

operations.ListCalendarWebinarsResponse

Errors

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

patch_calendar_webinar

Update a webinar

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

    assert res.calendar_webinar is not None

    # Handle response
    print(res.calendar_webinar)

Parameters

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

Response

operations.PatchCalendarWebinarResponse

Errors

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

remove_calendar_webinar

Remove a webinar

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

    assert res is not None

    # Handle response
    print(res)

Parameters

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

Response

operations.RemoveCalendarWebinarResponse

Errors

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

update_calendar_webinar

Update a webinar

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

    assert res.calendar_webinar is not None

    # Handle response
    print(res.calendar_webinar)

Parameters

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

Response

operations.UpdateCalendarWebinarResponse

Errors

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