Skip to content

ServiceProviderScheduleAddEventRequest

Bases: OCIRequest

Add an event to service provider schedule. The response is either a SuccessResponse or an ErrorResponse. The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate. The endDate element is set to the sum of the adjusted starDate element value and the event duration.

Attributes:

service_provider_id (str):

schedule_key (ScheduleKey):

event_name (str):

start_date (int):

all_day_event (Optional[bool]):

start_time (Optional[HourMinute]):

end_time (Optional[HourMinute]):

end_date (int):

recurrence (Optional[Recurrence]):
Source code in src/mercury_ocip/commands/commands.py 
69829
69830
69831
69832
69833
69834
69835
69836
69837
69838
69839
69840
69841
69842
69843
69844
69845
69846
69847
69848
69849
69850
69851
69852
69853
69854
69855
69856
69857
69858
69859
69860
69861
69862
69863
69864
69865
69866
69867
69868
69869
69870
69871
69872
69873
69874
69875
69876
69877
69878
69879
69880
@dataclass(kw_only=True)
class ServiceProviderScheduleAddEventRequest(OCIRequest):
    """Add an event to service provider schedule.
        The response is either a SuccessResponse or an ErrorResponse.
        The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate.
        The endDate element is set to the sum of the adjusted starDate element value and the event duration.

    Attributes:

        service_provider_id (str):

        schedule_key (ScheduleKey):

        event_name (str):

        start_date (int):

        all_day_event (Optional[bool]):

        start_time (Optional[HourMinute]):

        end_time (Optional[HourMinute]):

        end_date (int):

        recurrence (Optional[Recurrence]):

    """

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

    schedule_key: ScheduleKey = field(metadata={"alias": "scheduleKey"})

    event_name: str = field(metadata={"alias": "eventName"})

    start_date: int = field(metadata={"alias": "startDate"})

    all_day_event: Optional[bool] = field(
        default=None, metadata={"alias": "allDayEvent"}
    )

    start_time: Optional[HourMinute] = field(
        default=None, metadata={"alias": "startTime"}
    )

    end_time: Optional[HourMinute] = field(default=None, metadata={"alias": "endTime"})

    end_date: int = field(metadata={"alias": "endDate"})

    recurrence: Optional[Recurrence] = field(
        default=None, metadata={"alias": "recurrence"}
    )

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
84
85
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
115
116
117
118
119
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import ServiceProviderScheduleAddEventRequest

client = Client()

command = ServiceProviderScheduleAddEventRequest(
    service_provider_id=...,
    schedule_key=...,
    event_name=...,
    start_date=...,
    all_day_event=...,
    start_time=...,
    end_time=...,
    end_date=...,
    recurrence=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderScheduleAddEventRequest",
    service_provider_id=...,
    schedule_key=...,
    event_name=...,
    start_date=...,
    all_day_event=...,
    start_time=...,
    end_time=...,
    end_date=...,
    recurrence=...,
)

print(response)