incident_io_client.client
AuthenticatedClient
A Client which has been authenticated for use on secured endpoints
The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
``base_url``: The base URL for the API, all requests are made to a relative path to this URL
``cookies``: A dictionary of cookies to be sent with every request
``headers``: A dictionary of headers to be sent with every request
``timeout``: The maximum amount of a time a request can take. API functions will raise
httpx.TimeoutException if this is exceeded.
``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
but can be set to False for testing purposes.
``follow_redirects``: Whether or not to follow redirects. Default value is False.
``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
Attributes:
Name | Type | Description |
---|---|---|
raise_on_unexpected_status |
bool
|
Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor. |
token |
str
|
The token to use for authentication |
prefix |
str
|
The prefix to use for the Authorization header |
auth_header_name |
str
|
The name of the Authorization header |
Source code in incident_io_client/client.py
137 138 139 140 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 175 176 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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
|
__aenter__
async
Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)
__aexit__
async
Exit a context manager for underlying httpx.AsyncClient (see httpx docs)
__enter__
Enter a context manager for self.client—you cannot enter twice (see httpx docs)
__exit__
get_async_httpx_client
Get the underlying httpx.AsyncClient, constructing a new one if not previously set
Source code in incident_io_client/client.py
get_httpx_client
Get the underlying httpx.Client, constructing a new one if not previously set
Source code in incident_io_client/client.py
set_async_httpx_client
Manually the underlying httpx.AsyncClient
NOTE: This will override any other settings on the client, including cookies, headers, and timeout.
Source code in incident_io_client/client.py
set_httpx_client
Manually the underlying httpx.Client
NOTE: This will override any other settings on the client, including cookies, headers, and timeout.
Source code in incident_io_client/client.py
with_cookies
Get a new client matching this one with additional cookies
Source code in incident_io_client/client.py
with_headers
Get a new client matching this one with additional headers
Source code in incident_io_client/client.py
with_timeout
Get a new client matching this one with a new timeout (in seconds)
Source code in incident_io_client/client.py
Client
A class for keeping track of data related to the API
The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
``base_url``: The base URL for the API, all requests are made to a relative path to this URL
``cookies``: A dictionary of cookies to be sent with every request
``headers``: A dictionary of headers to be sent with every request
``timeout``: The maximum amount of a time a request can take. API functions will raise
httpx.TimeoutException if this is exceeded.
``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
but can be set to False for testing purposes.
``follow_redirects``: Whether or not to follow redirects. Default value is False.
``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
Attributes:
Name | Type | Description |
---|---|---|
raise_on_unexpected_status |
bool
|
Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor. |
Source code in incident_io_client/client.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 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 106 107 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 |
|
__aenter__
async
Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)
__aexit__
async
Exit a context manager for underlying httpx.AsyncClient (see httpx docs)
__enter__
Enter a context manager for self.client—you cannot enter twice (see httpx docs)
__exit__
get_async_httpx_client
Get the underlying httpx.AsyncClient, constructing a new one if not previously set
Source code in incident_io_client/client.py
get_httpx_client
Get the underlying httpx.Client, constructing a new one if not previously set
Source code in incident_io_client/client.py
set_async_httpx_client
Manually the underlying httpx.AsyncClient
NOTE: This will override any other settings on the client, including cookies, headers, and timeout.
Source code in incident_io_client/client.py
set_httpx_client
Manually the underlying httpx.Client
NOTE: This will override any other settings on the client, including cookies, headers, and timeout.
Source code in incident_io_client/client.py
with_cookies
Get a new client matching this one with additional cookies
Source code in incident_io_client/client.py
with_headers
Get a new client matching this one with additional headers
Source code in incident_io_client/client.py
with_timeout
Get a new client matching this one with a new timeout (in seconds)