# coding: utf-8 """ Vultr API # Introduction The Vultr API v2 is a set of HTTP endpoints that adhere to RESTful design principles and CRUD actions with predictable URIs. It uses standard HTTP response codes, authentication, and verbs. The API has consistent and well-formed JSON requests and responses with cursor-based pagination to simplify list handling. Error messages are descriptive and easy to understand. All functions of the Vultr customer portal are accessible via the API, enabling you to script complex unattended scenarios with any tool fluent in HTTP. ## Requests Communicate with the API by making an HTTP request at the correct endpoint. The chosen method determines the action taken. | Method | Usage | | ------ | ------------- | | DELETE | Use the DELETE method to destroy a resource in your account. If it is not found, the operation will return a 4xx error and an appropriate message. | | GET | To retrieve information about a resource, use the GET method. The data is returned as a JSON object. GET methods are read-only and do not affect any resources. | | PATCH | Some resources support partial modification with PATCH, which modifies specific attributes without updating the entire object representation. | | POST | Issue a POST method to create a new object. Include all needed attributes in the request body encoded as JSON. | | PUT | Use the PUT method to update information about a resource. PUT will set new values on the item without regard to their current values. | **Rate Limit:** Vultr safeguards the API against bursts of incoming traffic based on the request's IP address to ensure stability for all users. If your application sends more than 30 requests per second, the API may return HTTP status code 429. ## Response Codes We use standard HTTP response codes to show the success or failure of requests. Response codes in the 2xx range indicate success, while codes in the 4xx range indicate an error, such as an authorization failure or a malformed request. All 4xx errors will return a JSON response object with an `error` attribute explaining the error. Codes in the 5xx range indicate a server-side problem preventing Vultr from fulfilling your request. | Response | Description | | ------ | ------------- | | 200 OK | The response contains your requested information. | | 201 Created | Your request was accepted. The resource was created. | | 202 Accepted | Your request was accepted. The resource was created or updated. | | 204 No Content | Your request succeeded, there is no additional information returned. | | 400 Bad Request | Your request was malformed. | | 401 Unauthorized | You did not supply valid authentication credentials. | | 403 Forbidden | You are not allowed to perform that action. | | 404 Not Found | No results were found for your request. | | 429 Too Many Requests | Your request exceeded the API rate limit. | | 500 Internal Server Error | We were unable to perform the request due to server-side problems. | ## Meta and Pagination Many API calls will return a `meta` object with paging information. ### Definitions | Term | Description | | ------ | ------------- | | **List** | The items returned from the database for your request (not necessarily shown in a single response depending on the **cursor** size). | | **Page** | A subset of the full **list** of items. Choose the size of a **page** with the `per_page` parameter. | | **Total** | The `total` attribute indicates the number of items in the full **list**.| | **Cursor** | Use the `cursor` query parameter to select a next or previous **page**. | | **Next** & **Prev** | Use the `next` and `prev` attributes of the `links` meta object as `cursor` values. | ### How to use Paging If your result **list** total exceeds the default **cursor** size (the default depends on the route, but is usually 100 records) or the value defined by the `per_page` query param (when present) the response will be returned to you paginated. ### Paging Example > These examples have abbreviated attributes and sample values. Your actual `cursor` values will be encoded alphanumeric strings. To return a **page** with the first two plans in the List: curl \"https://api.vultr.com/v2/plans?per_page=2\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" The API returns an object similar to this: { \"plans\": [ { \"id\": \"vc2-1c-2gb\", \"vcpu_count\": 1, \"ram\": 2048, \"locations\": [] }, { \"id\": \"vc2-24c-97gb\", \"vcpu_count\": 24, \"ram\": 98304, \"locations\": [] } ], \"meta\": { \"total\": 19, \"links\": { \"next\": \"WxYzExampleNext\", \"prev\": \"WxYzExamplePrev\" } } } The object contains two plans. The `total` attribute indicates that 19 plans are available in the List. To navigate forward in the **list**, use the `next` value (`WxYzExampleNext` in this example) as your `cursor` query parameter. curl \"https://api.vultr.com/v2/plans?per_page=2&cursor=WxYzExampleNext\" \\ -X GET -H \"Authorization: Bearer ${VULTR_API_KEY}\" Likewise, you can use the example `prev` value `WxYzExamplePrev` to navigate backward. ## Parameters You can pass information to the API with three different types of parameters. ### Path parameters Some API calls require variable parameters as part of the endpoint path. For example, to retrieve information about a user, supply the `user-id` in the endpoint. curl \"https://api.vultr.com/v2/users/{user-id}\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" ### Query parameters Some API calls allow filtering with query parameters. For example, the `/v2/plans` endpoint supports a `type` query parameter. Setting `type=vhf` instructs the API only to return High Frequency Compute plans in the list. You'll find more specifics about valid filters in the endpoint documentation below. curl \"https://api.vultr.com/v2/plans?type=vhf\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" You can also combine filtering with paging. Use the `per_page` parameter to retreive a subset of vhf plans. curl \"https://api.vultr.com/v2/plans?type=vhf&per_page=2\" \\ -X GET \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" ### Request Body PUT, POST, and PATCH methods may include an object in the request body with a content type of **application/json**. The documentation for each endpoint below has more information about the expected object. ## API Example Conventions The examples in this documentation use `curl`, a command-line HTTP client, to demonstrate useage. Linux and macOS computers usually have curl installed by default, and it's [available for download](https://curl.se/download.html) on all popular platforms including Windows. Each example is split across multiple lines with the `\\` character, which is compatible with a `bash` terminal. A typical example looks like this: curl \"https://api.vultr.com/v2/domains\" \\ -X POST \\ -H \"Authorization: Bearer ${VULTR_API_KEY}\" \\ -H \"Content-Type: application/json\" \\ --data '{ \"domain\" : \"example.com\", \"ip\" : \"192.0.2.123\" }' * The `-X` parameter sets the request method. For consistency, we show the method on all examples, even though it's not explicitly required for GET methods. * The `-H` lines set required HTTP headers. These examples are formatted to expand the VULTR\\_API\\_KEY environment variable for your convenience. * Examples that require a JSON object in the request body pass the required data via the `--data` parameter. All values in this guide are examples. Do not rely on the OS or Plan IDs listed in this guide; use the appropriate endpoint to retreive values before creating resources. # Authentication # noqa: E501 The version of the OpenAPI document: 2.0 Contact: opensource@vultr.com Generated by: https://openapi-generator.tech """ from dataclasses import dataclass from decimal import Decimal import enum import email import json import os import io import atexit from multiprocessing.pool import ThreadPool import re import tempfile import typing import typing_extensions import urllib3 from urllib3._collections import HTTPHeaderDict from urllib.parse import urlparse, quote from urllib3.fields import RequestField as RequestFieldBase import frozendict from vultr_python_client import rest from vultr_python_client.configuration import Configuration from vultr_python_client.exceptions import ApiTypeError, ApiValueError from vultr_python_client.schemas import ( NoneClass, BoolClass, Schema, FileIO, BinarySchema, date, datetime, none_type, Unset, unset, ) class RequestField(RequestFieldBase): def __eq__(self, other): if not isinstance(other, RequestField): return False return self.__dict__ == other.__dict__ class JSONEncoder(json.JSONEncoder): compact_separators = (',', ':') def default(self, obj): if isinstance(obj, str): return str(obj) elif isinstance(obj, float): return float(obj) elif isinstance(obj, int): return int(obj) elif isinstance(obj, Decimal): if obj.as_tuple().exponent >= 0: return int(obj) return float(obj) elif isinstance(obj, NoneClass): return None elif isinstance(obj, BoolClass): return bool(obj) elif isinstance(obj, (dict, frozendict.frozendict)): return {key: self.default(val) for key, val in obj.items()} elif isinstance(obj, (list, tuple)): return [self.default(item) for item in obj] raise ApiValueError('Unable to prepare type {} for serialization'.format(obj.__class__.__name__)) class ParameterInType(enum.Enum): QUERY = 'query' HEADER = 'header' PATH = 'path' COOKIE = 'cookie' class ParameterStyle(enum.Enum): MATRIX = 'matrix' LABEL = 'label' FORM = 'form' SIMPLE = 'simple' SPACE_DELIMITED = 'spaceDelimited' PIPE_DELIMITED = 'pipeDelimited' DEEP_OBJECT = 'deepObject' class PrefixSeparatorIterator: # A class to store prefixes and separators for rfc6570 expansions def __init__(self, prefix: str, separator: str): self.prefix = prefix self.separator = separator self.first = True if separator in {'.', '|', '%20'}: item_separator = separator else: item_separator = ',' self.item_separator = item_separator def __iter__(self): return self def __next__(self): if self.first: self.first = False return self.prefix return self.separator class ParameterSerializerBase: @classmethod def _get_default_explode(cls, style: ParameterStyle) -> bool: return False @staticmethod def __ref6570_item_value(in_data: typing.Any, percent_encode: bool): """ Get representation if str/float/int/None/items in list/ values in dict None is returned if an item is undefined, use cases are value= - None - [] - {} - [None, None None] - {'a': None, 'b': None} """ if type(in_data) in {str, float, int}: if percent_encode: return quote(str(in_data)) return str(in_data) elif isinstance(in_data, none_type): # ignored by the expansion process https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.1 return None elif isinstance(in_data, list) and not in_data: # ignored by the expansion process https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.1 return None elif isinstance(in_data, dict) and not in_data: # ignored by the expansion process https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.1 return None raise ApiValueError('Unable to generate a ref6570 item representation of {}'.format(in_data)) @staticmethod def _to_dict(name: str, value: str): return {name: value} @classmethod def __ref6570_str_float_int_expansion( cls, variable_name: str, in_data: typing.Any, explode: bool, percent_encode: bool, prefix_separator_iterator: PrefixSeparatorIterator, var_name_piece: str, named_parameter_expansion: bool ) -> str: item_value = cls.__ref6570_item_value(in_data, percent_encode) if item_value is None or (item_value == '' and prefix_separator_iterator.separator == ';'): return next(prefix_separator_iterator) + var_name_piece value_pair_equals = '=' if named_parameter_expansion else '' return next(prefix_separator_iterator) + var_name_piece + value_pair_equals + item_value @classmethod def __ref6570_list_expansion( cls, variable_name: str, in_data: typing.Any, explode: bool, percent_encode: bool, prefix_separator_iterator: PrefixSeparatorIterator, var_name_piece: str, named_parameter_expansion: bool ) -> str: item_values = [cls.__ref6570_item_value(v, percent_encode) for v in in_data] item_values = [v for v in item_values if v is not None] if not item_values: # ignored by the expansion process https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.1 return "" value_pair_equals = '=' if named_parameter_expansion else '' if not explode: return ( next(prefix_separator_iterator) + var_name_piece + value_pair_equals + prefix_separator_iterator.item_separator.join(item_values) ) # exploded return next(prefix_separator_iterator) + next(prefix_separator_iterator).join( [var_name_piece + value_pair_equals + val for val in item_values] ) @classmethod def __ref6570_dict_expansion( cls, variable_name: str, in_data: typing.Any, explode: bool, percent_encode: bool, prefix_separator_iterator: PrefixSeparatorIterator, var_name_piece: str, named_parameter_expansion: bool ) -> str: in_data_transformed = {key: cls.__ref6570_item_value(val, percent_encode) for key, val in in_data.items()} in_data_transformed = {key: val for key, val in in_data_transformed.items() if val is not None} if not in_data_transformed: # ignored by the expansion process https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.1 return "" value_pair_equals = '=' if named_parameter_expansion else '' if not explode: return ( next(prefix_separator_iterator) + var_name_piece + value_pair_equals + prefix_separator_iterator.item_separator.join( prefix_separator_iterator.item_separator.join( item_pair ) for item_pair in in_data_transformed.items() ) ) # exploded return next(prefix_separator_iterator) + next(prefix_separator_iterator).join( [key + '=' + val for key, val in in_data_transformed.items()] ) @classmethod def _ref6570_expansion( cls, variable_name: str, in_data: typing.Any, explode: bool, percent_encode: bool, prefix_separator_iterator: PrefixSeparatorIterator ) -> str: """ Separator is for separate variables like dict with explode true, not for array item separation """ named_parameter_expansion = prefix_separator_iterator.separator in {'&', ';'} var_name_piece = variable_name if named_parameter_expansion else '' if type(in_data) in {str, float, int}: return cls.__ref6570_str_float_int_expansion( variable_name, in_data, explode, percent_encode, prefix_separator_iterator, var_name_piece, named_parameter_expansion ) elif isinstance(in_data, none_type): # ignored by the expansion process https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.1 return "" elif isinstance(in_data, list): return cls.__ref6570_list_expansion( variable_name, in_data, explode, percent_encode, prefix_separator_iterator, var_name_piece, named_parameter_expansion ) elif isinstance(in_data, dict): return cls.__ref6570_dict_expansion( variable_name, in_data, explode, percent_encode, prefix_separator_iterator, var_name_piece, named_parameter_expansion ) # bool, bytes, etc raise ApiValueError('Unable to generate a ref6570 representation of {}'.format(in_data)) class StyleFormSerializer(ParameterSerializerBase): @classmethod def _get_default_explode(cls, style: ParameterStyle) -> bool: if style is ParameterStyle.FORM: return True return super()._get_default_explode(style) def _serialize_form( self, in_data: typing.Union[None, int, float, str, bool, dict, list], name: str, explode: bool, percent_encode: bool, prefix_separator_iterator: typing.Optional[PrefixSeparatorIterator] = None ) -> str: if prefix_separator_iterator is None: prefix_separator_iterator = PrefixSeparatorIterator('', '&') return self._ref6570_expansion( variable_name=name, in_data=in_data, explode=explode, percent_encode=percent_encode, prefix_separator_iterator=prefix_separator_iterator ) class StyleSimpleSerializer(ParameterSerializerBase): def _serialize_simple( self, in_data: typing.Union[None, int, float, str, bool, dict, list], name: str, explode: bool, percent_encode: bool ) -> str: prefix_separator_iterator = PrefixSeparatorIterator('', ',') return self._ref6570_expansion( variable_name=name, in_data=in_data, explode=explode, percent_encode=percent_encode, prefix_separator_iterator=prefix_separator_iterator ) class JSONDetector: """ Works for: application/json application/json; charset=UTF-8 application/json-patch+json application/geo+json """ __json_content_type_pattern = re.compile("application/[^+]*[+]?(json);?.*") @classmethod def _content_type_is_json(cls, content_type: str) -> bool: if cls.__json_content_type_pattern.match(content_type): return True return False @dataclass class ParameterBase(JSONDetector): name: str in_type: ParameterInType required: bool style: typing.Optional[ParameterStyle] explode: typing.Optional[bool] allow_reserved: typing.Optional[bool] schema: typing.Optional[typing.Type[Schema]] content: typing.Optional[typing.Dict[str, typing.Type[Schema]]] __style_to_in_type = { ParameterStyle.MATRIX: {ParameterInType.PATH}, ParameterStyle.LABEL: {ParameterInType.PATH}, ParameterStyle.FORM: {ParameterInType.QUERY, ParameterInType.COOKIE}, ParameterStyle.SIMPLE: {ParameterInType.PATH, ParameterInType.HEADER}, ParameterStyle.SPACE_DELIMITED: {ParameterInType.QUERY}, ParameterStyle.PIPE_DELIMITED: {ParameterInType.QUERY}, ParameterStyle.DEEP_OBJECT: {ParameterInType.QUERY}, } __in_type_to_default_style = { ParameterInType.QUERY: ParameterStyle.FORM, ParameterInType.PATH: ParameterStyle.SIMPLE, ParameterInType.HEADER: ParameterStyle.SIMPLE, ParameterInType.COOKIE: ParameterStyle.FORM, } __disallowed_header_names = {'Accept', 'Content-Type', 'Authorization'} _json_encoder = JSONEncoder() @classmethod def __verify_style_to_in_type(cls, style: typing.Optional[ParameterStyle], in_type: ParameterInType): if style is None: return in_type_set = cls.__style_to_in_type[style] if in_type not in in_type_set: raise ValueError( 'Invalid style and in_type combination. For style={} only in_type={} are allowed'.format( style, in_type_set ) ) def __init__( self, name: str, in_type: ParameterInType, required: bool = False, style: typing.Optional[ParameterStyle] = None, explode: bool = False, allow_reserved: typing.Optional[bool] = None, schema: typing.Optional[typing.Type[Schema]] = None, content: typing.Optional[typing.Dict[str, typing.Type[Schema]]] = None ): if schema is None and content is None: raise ValueError('Value missing; Pass in either schema or content') if schema and content: raise ValueError('Too many values provided. Both schema and content were provided. Only one may be input') if name in self.__disallowed_header_names and in_type is ParameterInType.HEADER: raise ValueError('Invalid name, name may not be one of {}'.format(self.__disallowed_header_names)) self.__verify_style_to_in_type(style, in_type) if content is None and style is None: style = self.__in_type_to_default_style[in_type] if content is not None and in_type in self.__in_type_to_default_style and len(content) != 1: raise ValueError('Invalid content length, content length must equal 1') self.in_type = in_type self.name = name self.required = required self.style = style self.explode = explode self.allow_reserved = allow_reserved self.schema = schema self.content = content def _serialize_json( self, in_data: typing.Union[None, int, float, str, bool, dict, list], eliminate_whitespace: bool = False ) -> str: if eliminate_whitespace: return json.dumps(in_data, separators=self._json_encoder.compact_separators) return json.dumps(in_data) class PathParameter(ParameterBase, StyleSimpleSerializer): def __init__( self, name: str, required: bool = False, style: typing.Optional[ParameterStyle] = None, explode: bool = False, allow_reserved: typing.Optional[bool] = None, schema: typing.Optional[typing.Type[Schema]] = None, content: typing.Optional[typing.Dict[str, typing.Type[Schema]]] = None ): super().__init__( name, in_type=ParameterInType.PATH, required=required, style=style, explode=explode, allow_reserved=allow_reserved, schema=schema, content=content ) def __serialize_label( self, in_data: typing.Union[None, int, float, str, bool, dict, list] ) -> typing.Dict[str, str]: prefix_separator_iterator = PrefixSeparatorIterator('.', '.') value = self._ref6570_expansion( variable_name=self.name, in_data=in_data, explode=self.explode, percent_encode=True, prefix_separator_iterator=prefix_separator_iterator ) return self._to_dict(self.name, value) def __serialize_matrix( self, in_data: typing.Union[None, int, float, str, bool, dict, list] ) -> typing.Dict[str, str]: prefix_separator_iterator = PrefixSeparatorIterator(';', ';') value = self._ref6570_expansion( variable_name=self.name, in_data=in_data, explode=self.explode, percent_encode=True, prefix_separator_iterator=prefix_separator_iterator ) return self._to_dict(self.name, value) def __serialize_simple( self, in_data: typing.Union[None, int, float, str, bool, dict, list], ) -> typing.Dict[str, str]: value = self._serialize_simple( in_data=in_data, name=self.name, explode=self.explode, percent_encode=True ) return self._to_dict(self.name, value) def serialize( self, in_data: typing.Union[ Schema, Decimal, int, float, str, date, datetime, None, bool, list, tuple, dict, frozendict.frozendict] ) -> typing.Dict[str, str]: if self.schema: cast_in_data = self.schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) """ simple -> path path: returns path_params: dict label -> path returns path_params matrix -> path returns path_params """ if self.style: if self.style is ParameterStyle.SIMPLE: return self.__serialize_simple(cast_in_data) elif self.style is ParameterStyle.LABEL: return self.__serialize_label(cast_in_data) elif self.style is ParameterStyle.MATRIX: return self.__serialize_matrix(cast_in_data) # self.content will be length one for content_type, schema in self.content.items(): cast_in_data = schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) if self._content_type_is_json(content_type): value = self._serialize_json(cast_in_data) return self._to_dict(self.name, value) raise NotImplementedError('Serialization of {} has not yet been implemented'.format(content_type)) class QueryParameter(ParameterBase, StyleFormSerializer): def __init__( self, name: str, required: bool = False, style: typing.Optional[ParameterStyle] = None, explode: typing.Optional[bool] = None, allow_reserved: typing.Optional[bool] = None, schema: typing.Optional[typing.Type[Schema]] = None, content: typing.Optional[typing.Dict[str, typing.Type[Schema]]] = None ): used_style = ParameterStyle.FORM if style is None else style used_explode = self._get_default_explode(used_style) if explode is None else explode super().__init__( name, in_type=ParameterInType.QUERY, required=required, style=used_style, explode=used_explode, allow_reserved=allow_reserved, schema=schema, content=content ) def __serialize_space_delimited( self, in_data: typing.Union[None, int, float, str, bool, dict, list], prefix_separator_iterator: typing.Optional[PrefixSeparatorIterator] ) -> typing.Dict[str, str]: if prefix_separator_iterator is None: prefix_separator_iterator = self.get_prefix_separator_iterator() value = self._ref6570_expansion( variable_name=self.name, in_data=in_data, explode=self.explode, percent_encode=True, prefix_separator_iterator=prefix_separator_iterator ) return self._to_dict(self.name, value) def __serialize_pipe_delimited( self, in_data: typing.Union[None, int, float, str, bool, dict, list], prefix_separator_iterator: typing.Optional[PrefixSeparatorIterator] ) -> typing.Dict[str, str]: if prefix_separator_iterator is None: prefix_separator_iterator = self.get_prefix_separator_iterator() value = self._ref6570_expansion( variable_name=self.name, in_data=in_data, explode=self.explode, percent_encode=True, prefix_separator_iterator=prefix_separator_iterator ) return self._to_dict(self.name, value) def __serialize_form( self, in_data: typing.Union[None, int, float, str, bool, dict, list], prefix_separator_iterator: typing.Optional[PrefixSeparatorIterator] ) -> typing.Dict[str, str]: if prefix_separator_iterator is None: prefix_separator_iterator = self.get_prefix_separator_iterator() value = self._serialize_form( in_data, name=self.name, explode=self.explode, percent_encode=True, prefix_separator_iterator=prefix_separator_iterator ) return self._to_dict(self.name, value) def get_prefix_separator_iterator(self) -> typing.Optional[PrefixSeparatorIterator]: if self.style is ParameterStyle.FORM: return PrefixSeparatorIterator('?', '&') elif self.style is ParameterStyle.SPACE_DELIMITED: return PrefixSeparatorIterator('', '%20') elif self.style is ParameterStyle.PIPE_DELIMITED: return PrefixSeparatorIterator('', '|') def serialize( self, in_data: typing.Union[ Schema, Decimal, int, float, str, date, datetime, None, bool, list, tuple, dict, frozendict.frozendict], prefix_separator_iterator: typing.Optional[PrefixSeparatorIterator] = None ) -> typing.Dict[str, str]: if self.schema: cast_in_data = self.schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) """ form -> query query: - GET/HEAD/DELETE: could use fields - PUT/POST: must use urlencode to send parameters returns fields: tuple spaceDelimited -> query returns fields pipeDelimited -> query returns fields deepObject -> query, https://github.com/OAI/OpenAPI-Specification/issues/1706 returns fields """ if self.style: # TODO update query ones to omit setting values when [] {} or None is input if self.style is ParameterStyle.FORM: return self.__serialize_form(cast_in_data, prefix_separator_iterator) elif self.style is ParameterStyle.SPACE_DELIMITED: return self.__serialize_space_delimited(cast_in_data, prefix_separator_iterator) elif self.style is ParameterStyle.PIPE_DELIMITED: return self.__serialize_pipe_delimited(cast_in_data, prefix_separator_iterator) # self.content will be length one if prefix_separator_iterator is None: prefix_separator_iterator = self.get_prefix_separator_iterator() for content_type, schema in self.content.items(): cast_in_data = schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) if self._content_type_is_json(content_type): value = self._serialize_json(cast_in_data, eliminate_whitespace=True) return self._to_dict( self.name, next(prefix_separator_iterator) + self.name + '=' + quote(value) ) raise NotImplementedError('Serialization of {} has not yet been implemented'.format(content_type)) class CookieParameter(ParameterBase, StyleFormSerializer): def __init__( self, name: str, required: bool = False, style: typing.Optional[ParameterStyle] = None, explode: typing.Optional[bool] = None, allow_reserved: typing.Optional[bool] = None, schema: typing.Optional[typing.Type[Schema]] = None, content: typing.Optional[typing.Dict[str, typing.Type[Schema]]] = None ): used_style = ParameterStyle.FORM if style is None and content is None and schema else style used_explode = self._get_default_explode(used_style) if explode is None else explode super().__init__( name, in_type=ParameterInType.COOKIE, required=required, style=used_style, explode=used_explode, allow_reserved=allow_reserved, schema=schema, content=content ) def serialize( self, in_data: typing.Union[ Schema, Decimal, int, float, str, date, datetime, None, bool, list, tuple, dict, frozendict.frozendict] ) -> typing.Dict[str, str]: if self.schema: cast_in_data = self.schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) """ form -> cookie returns fields: tuple """ if self.style: """ TODO add escaping of comma, space, equals or turn encoding on """ value = self._serialize_form( cast_in_data, explode=self.explode, name=self.name, percent_encode=False, prefix_separator_iterator=PrefixSeparatorIterator('', '&') ) return self._to_dict(self.name, value) # self.content will be length one for content_type, schema in self.content.items(): cast_in_data = schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) if self._content_type_is_json(content_type): value = self._serialize_json(cast_in_data) return self._to_dict(self.name, value) raise NotImplementedError('Serialization of {} has not yet been implemented'.format(content_type)) class HeaderParameter(ParameterBase, StyleSimpleSerializer): def __init__( self, name: str, required: bool = False, style: typing.Optional[ParameterStyle] = None, explode: bool = False, allow_reserved: typing.Optional[bool] = None, schema: typing.Optional[typing.Type[Schema]] = None, content: typing.Optional[typing.Dict[str, typing.Type[Schema]]] = None ): super().__init__( name, in_type=ParameterInType.HEADER, required=required, style=style, explode=explode, allow_reserved=allow_reserved, schema=schema, content=content ) @staticmethod def __to_headers(in_data: typing.Tuple[typing.Tuple[str, str], ...]) -> HTTPHeaderDict: data = tuple(t for t in in_data if t) headers = HTTPHeaderDict() if not data: return headers headers.extend(data) return headers def serialize( self, in_data: typing.Union[ Schema, Decimal, int, float, str, date, datetime, None, bool, list, tuple, dict, frozendict.frozendict] ) -> HTTPHeaderDict: if self.schema: cast_in_data = self.schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) """ simple -> header headers: PoolManager needs a mapping, tuple is close returns headers: dict """ if self.style: value = self._serialize_simple(cast_in_data, self.name, self.explode, False) return self.__to_headers(((self.name, value),)) # self.content will be length one for content_type, schema in self.content.items(): cast_in_data = schema(in_data) cast_in_data = self._json_encoder.default(cast_in_data) if self._content_type_is_json(content_type): value = self._serialize_json(cast_in_data) return self.__to_headers(((self.name, value),)) raise NotImplementedError('Serialization of {} has not yet been implemented'.format(content_type)) class Encoding: def __init__( self, content_type: str, headers: typing.Optional[typing.Dict[str, HeaderParameter]] = None, style: typing.Optional[ParameterStyle] = None, explode: bool = False, allow_reserved: bool = False, ): self.content_type = content_type self.headers = headers self.style = style self.explode = explode self.allow_reserved = allow_reserved @dataclass class MediaType: """ Used to store request and response body schema information encoding: A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded. """ schema: typing.Optional[typing.Type[Schema]] = None encoding: typing.Optional[typing.Dict[str, Encoding]] = None @dataclass class ApiResponse: response: urllib3.HTTPResponse body: typing.Union[Unset, Schema] = unset headers: typing.Union[Unset, typing.Dict[str, Schema]] = unset def __init__( self, response: urllib3.HTTPResponse, body: typing.Union[Unset, Schema] = unset, headers: typing.Union[Unset, typing.Dict[str, Schema]] = unset ): """ pycharm needs this to prevent 'Unexpected argument' warnings """ self.response = response self.body = body self.headers = headers @dataclass class ApiResponseWithoutDeserialization(ApiResponse): response: urllib3.HTTPResponse body: typing.Union[Unset, typing.Type[Schema]] = unset headers: typing.Union[Unset, typing.List[HeaderParameter]] = unset class OpenApiResponse(JSONDetector): __filename_content_disposition_pattern = re.compile('filename="(.+?)"') def __init__( self, response_cls: typing.Type[ApiResponse] = ApiResponse, content: typing.Optional[typing.Dict[str, MediaType]] = None, headers: typing.Optional[typing.List[HeaderParameter]] = None, ): self.headers = headers if content is not None and len(content) == 0: raise ValueError('Invalid value for content, the content dict must have >= 1 entry') self.content = content self.response_cls = response_cls @staticmethod def __deserialize_json(response: urllib3.HTTPResponse) -> typing.Any: # python must be >= 3.9 so we can pass in bytes into json.loads return json.loads(response.data) @staticmethod def __file_name_from_response_url(response_url: typing.Optional[str]) -> typing.Optional[str]: if response_url is None: return None url_path = urlparse(response_url).path if url_path: path_basename = os.path.basename(url_path) if path_basename: _filename, ext = os.path.splitext(path_basename) if ext: return path_basename return None @classmethod def __file_name_from_content_disposition(cls, content_disposition: typing.Optional[str]) -> typing.Optional[str]: if content_disposition is None: return None match = cls.__filename_content_disposition_pattern.search(content_disposition) if not match: return None return match.group(1) def __deserialize_application_octet_stream( self, response: urllib3.HTTPResponse ) -> typing.Union[bytes, io.BufferedReader]: """ urllib3 use cases: 1. when preload_content=True (stream=False) then supports_chunked_reads is False and bytes are returned 2. when preload_content=False (stream=True) then supports_chunked_reads is True and a file will be written and returned """ if response.supports_chunked_reads(): file_name = ( self.__file_name_from_content_disposition(response.headers.get('content-disposition')) or self.__file_name_from_response_url(response.geturl()) ) if file_name is None: _fd, path = tempfile.mkstemp() else: path = os.path.join(tempfile.gettempdir(), file_name) with open(path, 'wb') as new_file: chunk_size = 1024 while True: data = response.read(chunk_size) if not data: break new_file.write(data) # release_conn is needed for streaming connections only response.release_conn() new_file = open(path, 'rb') return new_file else: return response.data @staticmethod def __deserialize_multipart_form_data( response: urllib3.HTTPResponse ) -> typing.Dict[str, typing.Any]: msg = email.message_from_bytes(response.data) return { part.get_param("name", header="Content-Disposition"): part.get_payload( decode=True ).decode(part.get_content_charset()) if part.get_content_charset() else part.get_payload() for part in msg.get_payload() } def deserialize(self, response: urllib3.HTTPResponse, configuration: Configuration) -> ApiResponse: content_type = response.getheader('content-type') deserialized_body = unset streamed = response.supports_chunked_reads() deserialized_headers = unset if self.headers is not None: # TODO add header deserialiation here pass if self.content is not None: if content_type not in self.content: raise ApiValueError( f"Invalid content_type returned. Content_type='{content_type}' was returned " f"when only {str(set(self.content))} are defined for status_code={str(response.status)}" ) body_schema = self.content[content_type].schema if body_schema is None: # some specs do not define response content media type schemas return self.response_cls( response=response, headers=deserialized_headers, body=unset ) if self._content_type_is_json(content_type): body_data = self.__deserialize_json(response) elif content_type == 'application/octet-stream': body_data = self.__deserialize_application_octet_stream(response) elif content_type.startswith('multipart/form-data'): body_data = self.__deserialize_multipart_form_data(response) content_type = 'multipart/form-data' else: raise NotImplementedError('Deserialization of {} has not yet been implemented'.format(content_type)) deserialized_body = body_schema.from_openapi_data_oapg( body_data, _configuration=configuration) elif streamed: response.release_conn() return self.response_cls( response=response, headers=deserialized_headers, body=deserialized_body ) class ApiClient: """Generic API client for OpenAPI client library builds. OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI templates. NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually. :param configuration: .Configuration object for this client :param header_name: a header to pass when making calls to the API. :param header_value: a header value to pass when making calls to the API. :param cookie: a cookie to include in the header when making calls to the API :param pool_threads: The number of threads to use for async requests to the API. More threads means more concurrent API requests. """ _pool = None def __init__( self, configuration: typing.Optional[Configuration] = None, header_name: typing.Optional[str] = None, header_value: typing.Optional[str] = None, cookie: typing.Optional[str] = None, pool_threads: int = 1 ): if configuration is None: configuration = Configuration() self.configuration = configuration self.pool_threads = pool_threads self.rest_client = rest.RESTClientObject(configuration) self.default_headers = HTTPHeaderDict() if header_name is not None: self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. self.user_agent = 'OpenAPI-Generator/1.0.0/python' def __enter__(self): return self def __exit__(self, exc_type, exc_value, traceback): self.close() def close(self): if self._pool: self._pool.close() self._pool.join() self._pool = None if hasattr(atexit, 'unregister'): atexit.unregister(self.close) @property def pool(self): """Create thread pool on first request avoids instantiating unused threadpool for blocking clients. """ if self._pool is None: atexit.register(self.close) self._pool = ThreadPool(self.pool_threads) return self._pool @property def user_agent(self): """User agent for this API client""" return self.default_headers['User-Agent'] @user_agent.setter def user_agent(self, value): self.default_headers['User-Agent'] = value def set_default_header(self, header_name, header_value): self.default_headers[header_name] = header_value def __call_api( self, resource_path: str, method: str, headers: typing.Optional[HTTPHeaderDict] = None, body: typing.Optional[typing.Union[str, bytes]] = None, fields: typing.Optional[typing.Tuple[typing.Tuple[str, str], ...]] = None, auth_settings: typing.Optional[typing.List[str]] = None, stream: bool = False, timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, host: typing.Optional[str] = None, ) -> urllib3.HTTPResponse: # header parameters used_headers = HTTPHeaderDict(self.default_headers) if self.cookie: headers['Cookie'] = self.cookie # auth setting self.update_params_for_auth(used_headers, auth_settings, resource_path, method, body) # must happen after cookie setting and auth setting in case user is overriding those if headers: used_headers.update(headers) # request url if host is None: url = self.configuration.host + resource_path else: # use server/host defined in path or operation instead url = host + resource_path # perform request and return response response = self.request( method, url, headers=used_headers, fields=fields, body=body, stream=stream, timeout=timeout, ) return response def call_api( self, resource_path: str, method: str, headers: typing.Optional[HTTPHeaderDict] = None, body: typing.Optional[typing.Union[str, bytes]] = None, fields: typing.Optional[typing.Tuple[typing.Tuple[str, str], ...]] = None, auth_settings: typing.Optional[typing.List[str]] = None, async_req: typing.Optional[bool] = None, stream: bool = False, timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, host: typing.Optional[str] = None, ) -> urllib3.HTTPResponse: """Makes the HTTP request (synchronous) and returns deserialized data. To make an async_req request, set the async_req parameter. :param resource_path: Path to method endpoint. :param method: Method to call. :param headers: Header parameters to be placed in the request header. :param body: Request body. :param fields: Request post form parameters, for `application/x-www-form-urlencoded`, `multipart/form-data`. :param auth_settings: Auth Settings names for the request. :param async_req: execute request asynchronously :type async_req: bool, optional TODO remove, unused :param stream: if True, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Also when True, if the openapi spec describes a file download, the data will be written to a local filesystme file and the BinarySchema instance will also inherit from FileSchema and FileIO Default is False. :type stream: bool, optional :param timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :param host: api endpoint host :return: If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly. """ if not async_req: return self.__call_api( resource_path, method, headers, body, fields, auth_settings, stream, timeout, host, ) return self.pool.apply_async( self.__call_api, ( resource_path, method, headers, body, json, fields, auth_settings, stream, timeout, host, ) ) def request( self, method: str, url: str, headers: typing.Optional[HTTPHeaderDict] = None, fields: typing.Optional[typing.Tuple[typing.Tuple[str, str], ...]] = None, body: typing.Optional[typing.Union[str, bytes]] = None, stream: bool = False, timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None, ) -> urllib3.HTTPResponse: """Makes the HTTP request using RESTClient.""" if method == "GET": return self.rest_client.GET(url, stream=stream, timeout=timeout, headers=headers) elif method == "HEAD": return self.rest_client.HEAD(url, stream=stream, timeout=timeout, headers=headers) elif method == "OPTIONS": return self.rest_client.OPTIONS(url, headers=headers, fields=fields, stream=stream, timeout=timeout, body=body) elif method == "POST": return self.rest_client.POST(url, headers=headers, fields=fields, stream=stream, timeout=timeout, body=body) elif method == "PUT": return self.rest_client.PUT(url, headers=headers, fields=fields, stream=stream, timeout=timeout, body=body) elif method == "PATCH": return self.rest_client.PATCH(url, headers=headers, fields=fields, stream=stream, timeout=timeout, body=body) elif method == "DELETE": return self.rest_client.DELETE(url, headers=headers, stream=stream, timeout=timeout, body=body) else: raise ApiValueError( "http method must be `GET`, `HEAD`, `OPTIONS`," " `POST`, `PATCH`, `PUT` or `DELETE`." ) def update_params_for_auth(self, headers, auth_settings, resource_path, method, body): """Updates header and query params based on authentication setting. :param headers: Header parameters dict to be updated. :param auth_settings: Authentication setting identifiers list. :param resource_path: A string representation of the HTTP request resource path. :param method: A string representation of the HTTP request method. :param body: A object representing the body of the HTTP request. The object type is the return value of _encoder.default(). """ if not auth_settings: return for auth in auth_settings: auth_setting = self.configuration.auth_settings().get(auth) if not auth_setting: continue if auth_setting['in'] == 'cookie': headers.add('Cookie', auth_setting['value']) elif auth_setting['in'] == 'header': if auth_setting['type'] != 'http-signature': headers.add(auth_setting['key'], auth_setting['value']) elif auth_setting['in'] == 'query': """ TODO implement auth in query need to pass in prefix_separator_iterator and need to output resource_path with query params added """ raise ApiValueError("Auth in query not yet implemented") else: raise ApiValueError( 'Authentication token must be in `query` or `header`' ) class Api: """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client: typing.Optional[ApiClient] = None): if api_client is None: api_client = ApiClient() self.api_client = api_client @staticmethod def _verify_typed_dict_inputs_oapg(cls: typing.Type[typing_extensions.TypedDict], data: typing.Dict[str, typing.Any]): """ Ensures that: - required keys are present - additional properties are not input - value stored under required keys do not have the value unset Note: detailed value checking is done in schema classes """ missing_required_keys = [] required_keys_with_unset_values = [] for required_key in cls.__required_keys__: if required_key not in data: missing_required_keys.append(required_key) continue value = data[required_key] if value is unset: required_keys_with_unset_values.append(required_key) if missing_required_keys: raise ApiTypeError( '{} missing {} required arguments: {}'.format( cls.__name__, len(missing_required_keys), missing_required_keys ) ) if required_keys_with_unset_values: raise ApiValueError( '{} contains invalid unset values for {} required keys: {}'.format( cls.__name__, len(required_keys_with_unset_values), required_keys_with_unset_values ) ) disallowed_additional_keys = [] for key in data: if key in cls.__required_keys__ or key in cls.__optional_keys__: continue disallowed_additional_keys.append(key) if disallowed_additional_keys: raise ApiTypeError( '{} got {} unexpected keyword arguments: {}'.format( cls.__name__, len(disallowed_additional_keys), disallowed_additional_keys ) ) def _get_host_oapg( self, operation_id: str, servers: typing.Tuple[typing.Dict[str, str], ...] = tuple(), host_index: typing.Optional[int] = None ) -> typing.Optional[str]: configuration = self.api_client.configuration try: if host_index is None: index = configuration.server_operation_index.get( operation_id, configuration.server_index ) else: index = host_index server_variables = configuration.server_operation_variables.get( operation_id, configuration.server_variables ) host = configuration.get_host_from_settings( index, variables=server_variables, servers=servers ) except IndexError: if servers: raise ApiValueError( "Invalid host index. Must be 0 <= index < %s" % len(servers) ) host = None return host class SerializedRequestBody(typing_extensions.TypedDict, total=False): body: typing.Union[str, bytes] fields: typing.Tuple[typing.Union[RequestField, typing.Tuple[str, str]], ...] class RequestBody(StyleFormSerializer, JSONDetector): """ A request body parameter content: content_type to MediaType Schema info """ __json_encoder = JSONEncoder() def __init__( self, content: typing.Dict[str, MediaType], required: bool = False, ): self.required = required if len(content) == 0: raise ValueError('Invalid value for content, the content dict must have >= 1 entry') self.content = content def __serialize_json( self, in_data: typing.Any ) -> typing.Dict[str, bytes]: in_data = self.__json_encoder.default(in_data) json_str = json.dumps(in_data, separators=(",", ":"), ensure_ascii=False).encode( "utf-8" ) return dict(body=json_str) @staticmethod def __serialize_text_plain(in_data: typing.Any) -> typing.Dict[str, str]: if isinstance(in_data, frozendict.frozendict): raise ValueError('Unable to serialize type frozendict.frozendict to text/plain') elif isinstance(in_data, tuple): raise ValueError('Unable to serialize type tuple to text/plain') elif isinstance(in_data, NoneClass): raise ValueError('Unable to serialize type NoneClass to text/plain') elif isinstance(in_data, BoolClass): raise ValueError('Unable to serialize type BoolClass to text/plain') return dict(body=str(in_data)) def __multipart_json_item(self, key: str, value: Schema) -> RequestField: json_value = self.__json_encoder.default(value) request_field = RequestField(name=key, data=json.dumps(json_value)) request_field.make_multipart(content_type='application/json') return request_field def __multipart_form_item(self, key: str, value: Schema) -> RequestField: if isinstance(value, str): request_field = RequestField(name=key, data=str(value)) request_field.make_multipart(content_type='text/plain') elif isinstance(value, bytes): request_field = RequestField(name=key, data=value) request_field.make_multipart(content_type='application/octet-stream') elif isinstance(value, FileIO): # TODO use content.encoding to limit allowed content types if they are present request_field = RequestField.from_tuples(key, (os.path.basename(value.name), value.read())) value.close() else: request_field = self.__multipart_json_item(key=key, value=value) return request_field def __serialize_multipart_form_data( self, in_data: Schema ) -> typing.Dict[str, typing.Tuple[RequestField, ...]]: if not isinstance(in_data, frozendict.frozendict): raise ValueError(f'Unable to serialize {in_data} to multipart/form-data because it is not a dict of data') """ In a multipart/form-data request body, each schema property, or each element of a schema array property, takes a section in the payload with an internal header as defined by RFC7578. The serialization strategy for each property of a multipart/form-data request body can be specified in an associated Encoding Object. When passing in multipart types, boundaries MAY be used to separate sections of the content being transferred – thus, the following default Content-Types are defined for multipart: If the (object) property is a primitive, or an array of primitive values, the default Content-Type is text/plain If the property is complex, or an array of complex values, the default Content-Type is application/json Question: how is the array of primitives encoded? If the property is a type: string with a contentEncoding, the default Content-Type is application/octet-stream """ fields = [] for key, value in in_data.items(): if isinstance(value, tuple): if value: # values use explode = True, so the code makes a RequestField for each item with name=key for item in value: request_field = self.__multipart_form_item(key=key, value=item) fields.append(request_field) else: # send an empty array as json because exploding will not send it request_field = self.__multipart_json_item(key=key, value=value) fields.append(request_field) else: request_field = self.__multipart_form_item(key=key, value=value) fields.append(request_field) return dict(fields=tuple(fields)) def __serialize_application_octet_stream(self, in_data: BinarySchema) -> typing.Dict[str, bytes]: if isinstance(in_data, bytes): return dict(body=in_data) # FileIO type result = dict(body=in_data.read()) in_data.close() return result def __serialize_application_x_www_form_data( self, in_data: typing.Any ) -> SerializedRequestBody: """ POST submission of form data in body """ if not isinstance(in_data, frozendict.frozendict): raise ValueError( f'Unable to serialize {in_data} to application/x-www-form-urlencoded because it is not a dict of data') cast_in_data = self.__json_encoder.default(in_data) value = self._serialize_form(cast_in_data, name='', explode=True, percent_encode=True) return dict(body=value) def serialize( self, in_data: typing.Any, content_type: str ) -> SerializedRequestBody: """ If a str is returned then the result will be assigned to data when making the request If a tuple is returned then the result will be used as fields input in encode_multipart_formdata Return a tuple of The key of the return dict is - body for application/json - encode_multipart and fields for multipart/form-data """ media_type = self.content[content_type] if isinstance(in_data, media_type.schema): cast_in_data = in_data elif isinstance(in_data, (dict, frozendict.frozendict)) and in_data: cast_in_data = media_type.schema(**in_data) else: cast_in_data = media_type.schema(in_data) # TODO check for and use encoding if it exists # and content_type is multipart or application/x-www-form-urlencoded if self._content_type_is_json(content_type): return self.__serialize_json(cast_in_data) elif content_type == 'text/plain': return self.__serialize_text_plain(cast_in_data) elif content_type == 'multipart/form-data': return self.__serialize_multipart_form_data(cast_in_data) elif content_type == 'application/x-www-form-urlencoded': return self.__serialize_application_x_www_form_data(cast_in_data) elif content_type == 'application/octet-stream': return self.__serialize_application_octet_stream(cast_in_data) raise NotImplementedError('Serialization has not yet been implemented for {}'.format(content_type))