EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest

Bases: OCIRequest

Request to get a list of completed enterprise level call center reporting scheduled reports. The response is either an EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

response_size_limit (Optional[int]):

search_criteria_call_center_scheduled_report_name (Optional[List[SearchCriteriaCallCenterScheduledReportName]]):

search_criteria_exact_call_center_scheduled_report_created_by_supervisor (Optional[SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor]):

search_criteria_exact_call_center_report_template_key (Optional[SearchCriteriaExactCallCenterReportTemplateKey]):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest(
    OCIRequest
):
    """Request to get a list of completed enterprise level call center reporting scheduled reports.
        The response is either an EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        response_size_limit (Optional[int]):

        search_criteria_call_center_scheduled_report_name (Optional[List[SearchCriteriaCallCenterScheduledReportName]]):

        search_criteria_exact_call_center_scheduled_report_created_by_supervisor (Optional[SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor]):

        search_criteria_exact_call_center_report_template_key (Optional[SearchCriteriaExactCallCenterReportTemplateKey]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_call_center_scheduled_report_name: Optional[
        List[SearchCriteriaCallCenterScheduledReportName]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaCallCenterScheduledReportName"}
    )

    search_criteria_exact_call_center_scheduled_report_created_by_supervisor: Optional[
        SearchCriteriaExactCallCenterScheduledReportCreatedBySupervisor
    ] = field(
        default=None,
        metadata={
            "alias": "searchCriteriaExactCallCenterScheduledReportCreatedBySupervisor"
        },
    )

    search_criteria_exact_call_center_report_template_key: Optional[
        SearchCriteriaExactCallCenterReportTemplateKey
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaExactCallCenterReportTemplateKey"},
    )

Responses

Bases: OCIDataResponse

Response to EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest Contains a table with column headings : "Schedule Name", "Description", "Created By", "Is Supervisor Report", "Report Template Name", "Report Template Level" and "Recurring". The "Created By" can be either "Administrator" or user id if created by supervisor. The possible values for "Recurring" are "None", "Daily", "Weekly", "Monthly" and "Yearly". The possible values for "Report Level" are "System" and "Enterprise".

Attributes:

scheduled_report_table (OCITable):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListResponse(
    OCIDataResponse
):
    """Response to EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest
        Contains a table with column headings : \"Schedule Name\", \"Description\", \"Created By\",
        \"Is Supervisor Report\", \"Report Template Name\", \"Report Template Level\" and \"Recurring\".
        The \"Created By\" can be either \"Administrator\" or user id if created by supervisor.
        The possible values for \"Recurring\" are \"None\", \"Daily\", \"Weekly\", \"Monthly\" and \"Yearly\".
        The possible values for \"Report Level\" are \"System\" and \"Enterprise\".

    Attributes:

        scheduled_report_table (OCITable):

    """

    scheduled_report_table: OCITable = field(metadata={"alias": "scheduledReportTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest

client = Client()

command = EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest(
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_call_center_scheduled_report_name=...,
    search_criteria_exact_call_center_scheduled_report_created_by_supervisor=...,
    search_criteria_exact_call_center_report_template_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("EnterpriseCallCenterEnhancedReportingScheduledReportGetCompletedListRequest",
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_call_center_scheduled_report_name=...,
    search_criteria_exact_call_center_scheduled_report_created_by_supervisor=...,
    search_criteria_exact_call_center_report_template_key=...,
)

print(response)