Skip to content

incident_io_client.api.schedules_v2.schedules_v2_list_schedule_entries

asyncio async 

asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[
        Unset, datetime.datetime
    ] = UNSET,
    entry_window_end: Union[
        Unset, datetime.datetime
    ] = UNSET
) -> Optional[SchedulesV2ListScheduleEntriesResponseBody]

ListScheduleEntries Schedules V2

Get a list of schedule entries. The endpoint will return all entries that overlap with the given window, if one is provided.

Parameters:

Name Type Description Default
schedule_id str
required
entry_window_start Union[Unset, datetime]
UNSET
entry_window_end Union[Unset, datetime]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[SchedulesV2ListScheduleEntriesResponseBody]

SchedulesV2ListScheduleEntriesResponseBody
Source code in incident_io_client/api/schedules_v2/schedules_v2_list_schedule_entries.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[Unset, datetime.datetime] = UNSET,
    entry_window_end: Union[Unset, datetime.datetime] = UNSET,
) -> Optional[SchedulesV2ListScheduleEntriesResponseBody]:
    """ListScheduleEntries Schedules V2

     Get a list of schedule entries. The endpoint will return all entries that overlap with the given
    window, if one is provided.

    Args:
        schedule_id (str):
        entry_window_start (Union[Unset, datetime.datetime]):
        entry_window_end (Union[Unset, datetime.datetime]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        SchedulesV2ListScheduleEntriesResponseBody
    """

    return (
        await asyncio_detailed(
            client=client,
            schedule_id=schedule_id,
            entry_window_start=entry_window_start,
            entry_window_end=entry_window_end,
        )
    ).parsed

asyncio_detailed async 

asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[
        Unset, datetime.datetime
    ] = UNSET,
    entry_window_end: Union[
        Unset, datetime.datetime
    ] = UNSET
) -> Response[SchedulesV2ListScheduleEntriesResponseBody]

ListScheduleEntries Schedules V2

Get a list of schedule entries. The endpoint will return all entries that overlap with the given window, if one is provided.

Parameters:

Name Type Description Default
schedule_id str
required
entry_window_start Union[Unset, datetime]
UNSET
entry_window_end Union[Unset, datetime]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[SchedulesV2ListScheduleEntriesResponseBody]

Response[SchedulesV2ListScheduleEntriesResponseBody]
Source code in incident_io_client/api/schedules_v2/schedules_v2_list_schedule_entries.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[Unset, datetime.datetime] = UNSET,
    entry_window_end: Union[Unset, datetime.datetime] = UNSET,
) -> Response[SchedulesV2ListScheduleEntriesResponseBody]:
    """ListScheduleEntries Schedules V2

     Get a list of schedule entries. The endpoint will return all entries that overlap with the given
    window, if one is provided.

    Args:
        schedule_id (str):
        entry_window_start (Union[Unset, datetime.datetime]):
        entry_window_end (Union[Unset, datetime.datetime]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[SchedulesV2ListScheduleEntriesResponseBody]
    """

    kwargs = _get_kwargs(
        schedule_id=schedule_id,
        entry_window_start=entry_window_start,
        entry_window_end=entry_window_end,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync 

sync(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[
        Unset, datetime.datetime
    ] = UNSET,
    entry_window_end: Union[
        Unset, datetime.datetime
    ] = UNSET
) -> Optional[SchedulesV2ListScheduleEntriesResponseBody]

ListScheduleEntries Schedules V2

Get a list of schedule entries. The endpoint will return all entries that overlap with the given window, if one is provided.

Parameters:

Name Type Description Default
schedule_id str
required
entry_window_start Union[Unset, datetime]
UNSET
entry_window_end Union[Unset, datetime]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[SchedulesV2ListScheduleEntriesResponseBody]

SchedulesV2ListScheduleEntriesResponseBody
Source code in incident_io_client/api/schedules_v2/schedules_v2_list_schedule_entries.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[Unset, datetime.datetime] = UNSET,
    entry_window_end: Union[Unset, datetime.datetime] = UNSET,
) -> Optional[SchedulesV2ListScheduleEntriesResponseBody]:
    """ListScheduleEntries Schedules V2

     Get a list of schedule entries. The endpoint will return all entries that overlap with the given
    window, if one is provided.

    Args:
        schedule_id (str):
        entry_window_start (Union[Unset, datetime.datetime]):
        entry_window_end (Union[Unset, datetime.datetime]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        SchedulesV2ListScheduleEntriesResponseBody
    """

    return sync_detailed(
        client=client,
        schedule_id=schedule_id,
        entry_window_start=entry_window_start,
        entry_window_end=entry_window_end,
    ).parsed

sync_detailed 

sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[
        Unset, datetime.datetime
    ] = UNSET,
    entry_window_end: Union[
        Unset, datetime.datetime
    ] = UNSET
) -> Response[SchedulesV2ListScheduleEntriesResponseBody]

ListScheduleEntries Schedules V2

Get a list of schedule entries. The endpoint will return all entries that overlap with the given window, if one is provided.

Parameters:

Name Type Description Default
schedule_id str
required
entry_window_start Union[Unset, datetime]
UNSET
entry_window_end Union[Unset, datetime]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[SchedulesV2ListScheduleEntriesResponseBody]

Response[SchedulesV2ListScheduleEntriesResponseBody]
Source code in incident_io_client/api/schedules_v2/schedules_v2_list_schedule_entries.py 
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    schedule_id: str,
    entry_window_start: Union[Unset, datetime.datetime] = UNSET,
    entry_window_end: Union[Unset, datetime.datetime] = UNSET,
) -> Response[SchedulesV2ListScheduleEntriesResponseBody]:
    """ListScheduleEntries Schedules V2

     Get a list of schedule entries. The endpoint will return all entries that overlap with the given
    window, if one is provided.

    Args:
        schedule_id (str):
        entry_window_start (Union[Unset, datetime.datetime]):
        entry_window_end (Union[Unset, datetime.datetime]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[SchedulesV2ListScheduleEntriesResponseBody]
    """

    kwargs = _get_kwargs(
        schedule_id=schedule_id,
        entry_window_start=entry_window_start,
        entry_window_end=entry_window_end,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)