pyrestsdk package¶
Subpackages¶
Module contents¶
Py REST SDK
- class pyrestsdk.AbstractServiceClient(*args, **kwargs)[source]¶
Bases:
ABC
Abstract Service Client Type
- abstract delete(url: str, **kwargs) Response [source]¶
Sends a DELETE request. Returns
Response
object. :param url: URL for the newRequest
object. :param **kwargs: Optional arguments thatrequest
takes. :rtype: requests.Response
- abstract get(url: str, **kwargs) Response [source]¶
Sends a GET request. Returns
Response
object. :param url: URL for the newRequest
object. :param **kwargs: Optional arguments thatrequest
takes. :rtype: requests.Response
- abstract head(url: str, **kwargs) Response [source]¶
Sends a HEAD request. Returns
Response
object. :param url: URL for the newRequest
object. :param **kwargs: Optional arguments thatrequest
takes. :rtype: requests.Response
- abstract options(url: str, **kwargs) Response [source]¶
Sends a OPTIONS request. Returns
Response
object. :param url: URL for the newRequest
object. :param **kwargs: Optional arguments thatrequest
takes. :rtype: requests.Response
- abstract patch(url: str, data=None, **kwargs) Response [source]¶
Sends a PATCH request. Returns
Response
object. :param url: URL for the newRequest
object. :param data: (optional) Dictionary, list of tuples, bytes, or file-likeobject to send in the body of the
Request
.- Parameters:
**kwargs – Optional arguments that
request
takes.- Return type:
requests.Response
- abstract post(url: str, data=None, json=None, **kwargs) Response [source]¶
Sends a POST request. Returns
Response
object. :param url: URL for the newRequest
object. :param data: (optional) Dictionary, list of tuples, bytes, or file-likeobject to send in the body of the
Request
.- Parameters:
json – (optional) json to send in the body of the
Request
.**kwargs – Optional arguments that
request
takes.
- Return type:
requests.Response
- abstract put(url: str, data=None, **kwargs) Response [source]¶
Sends a PUT request. Returns
Response
object. :param url: URL for the newRequest
object. :param data: (optional) Dictionary, list of tuples, bytes, or file-likeobject to send in the body of the
Request
.- Parameters:
**kwargs – Optional arguments that
request
takes.- Return type:
requests.Response
- class pyrestsdk.FeatureUsageFlag(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
IntEnum
Enumerated list of values used to flag usage of specific middleware
- AUTH_HANDLER_ENABLED = 4¶
- DEFAULT_HTTP_PROVIDER_ENABLED = 8¶
- LOGGING_HANDLER_ENABLED = 16¶
- NONE = 0¶
- REDIRECT_HANDLER_ENABLED = 1¶
- RETRY_HANDLER_ENABLED = 2¶